@@ -258,13 +258,34 @@ create new ones.
258258 WorkspaceManager.workspace_groups
259259 WorkspaceManager.starter_workspaces
260260 WorkspaceManager.regions
261+ WorkspaceManager.regions_v2
261262 WorkspaceManager.shared_tier_regions
263+ WorkspaceManager.billing
262264 WorkspaceManager.create_workspace_group
263265 WorkspaceManager.create_workspace
264266 WorkspaceManager.create_starter_workspace
265267 WorkspaceManager.get_workspace_group
266268 WorkspaceManager.get_workspace
267269 WorkspaceManager.get_starter_workspace
270+ WorkspaceManager.invitations
271+ WorkspaceManager.get_invitation
272+ WorkspaceManager.create_invitation
273+ WorkspaceManager.users
274+ WorkspaceManager.current_user
275+ WorkspaceManager.get_user
276+ WorkspaceManager.add_user
277+ WorkspaceManager.teams
278+ WorkspaceManager.get_team
279+ WorkspaceManager.create_team
280+ WorkspaceManager.get_roles
281+ WorkspaceManager.get_role
282+ WorkspaceManager.create_role
283+ WorkspaceManager.secrets
284+ WorkspaceManager.get_secret_by_id
285+ WorkspaceManager.create_secret
286+ WorkspaceManager.get_audit_logs
287+ WorkspaceManager.create_private_connection
288+ WorkspaceManager.get_private_connection
268289
269290
270291WorkspaceGroup
@@ -279,10 +300,17 @@ or by retrieving an element from :attr:`WorkspaceManager.workspace_groups`.
279300 WorkspaceGroup
280301 WorkspaceGroup.workspaces
281302 WorkspaceGroup.stage
303+ WorkspaceGroup.storage
282304 WorkspaceGroup.create_workspace
283305 WorkspaceGroup.refresh
284306 WorkspaceGroup.update
285307 WorkspaceGroup.terminate
308+ WorkspaceGroup.private_connections
309+ WorkspaceGroup.create_private_connection
310+ WorkspaceGroup.get_private_connection
311+ WorkspaceGroup.get_access_controls
312+ WorkspaceGroup.update_access_controls
313+ WorkspaceGroup.get_metrics
286314
287315
288316Workspace
@@ -300,12 +328,20 @@ Workspaces are created within WorkspaceGroups. They can be created using either
300328 Workspace.refresh
301329 Workspace.update
302330 Workspace.terminate
331+ Workspace.suspend
332+ Workspace.resume
333+ Workspace.private_connections
334+ Workspace.create_private_connection
335+ Workspace.get_private_connection
336+ Workspace.get_kai_private_connection_info
337+ Workspace.get_outbound_allow_list
303338
304339
305340Region
306341......
307342
308- Region objects are accessed from the :attr: `WorkspaceManager.regions ` attribute.
343+ Region objects are accessed from the :attr: `WorkspaceManager.regions ` attribute
344+ or through the :class: `RegionManager `.
309345
310346.. currentmodule :: singlestoredb.management.region
311347
@@ -315,6 +351,19 @@ Region objects are accessed from the :attr:`WorkspaceManager.regions` attribute.
315351 Region
316352
317353
354+ RegionManager
355+ ^^^^^^^^^^^^^
356+
357+ RegionManager provides methods for listing available regions.
358+
359+ .. autosummary ::
360+ :toctree: generated/
361+
362+ RegionManager
363+ RegionManager.list_regions
364+ RegionManager.list_shared_tier_regions
365+
366+
318367Organization
319368............
320369
@@ -330,6 +379,12 @@ They provide access to organization-level resources and operations.
330379 Organization.get_secret
331380 Organization.jobs
332381 Organization.inference_apis
382+ Organization.secrets
383+ Organization.get_secret_by_id
384+ Organization.create_secret
385+ Organization.get_access_controls
386+ Organization.update_access_controls
387+ Organization.get_audit_logs
333388
334389
335390Secret
@@ -342,6 +397,290 @@ They represent organization-wide secrets that can be used in various operations.
342397 :toctree: generated/
343398
344399 Secret
400+ Secret.update
401+ Secret.delete
402+ Secret.get_access_controls
403+ Secret.update_access_controls
404+
405+
406+ Cluster Management
407+ ..................
408+
409+ The :func: `manage_cluster ` function provides access to cluster management functionality.
410+
411+ .. currentmodule :: singlestoredb
412+
413+ .. autosummary ::
414+ :toctree: generated/
415+
416+ manage_cluster
417+
418+
419+ ClusterManager
420+ ^^^^^^^^^^^^^^
421+
422+ ClusterManager objects are returned by the :func: `manage_cluster ` function.
423+ They allow you to create and manage clusters.
424+
425+ .. currentmodule :: singlestoredb.management.cluster
426+
427+ .. autosummary ::
428+ :toctree: generated/
429+
430+ ClusterManager
431+ ClusterManager.clusters
432+ ClusterManager.regions
433+ ClusterManager.create_cluster
434+ ClusterManager.get_cluster
435+
436+
437+ Cluster
438+ ^^^^^^^
439+
440+ Cluster objects represent SingleStore clusters. They can be created using
441+ :meth: `ClusterManager.create_cluster ` or retrieved from :attr: `ClusterManager.clusters `.
442+
443+ .. autosummary ::
444+ :toctree: generated/
445+
446+ Cluster
447+ Cluster.connect
448+ Cluster.refresh
449+ Cluster.update
450+ Cluster.suspend
451+ Cluster.resume
452+ Cluster.terminate
453+
454+
455+ User Management
456+ ...............
457+
458+ User objects represent users in your organization.
459+
460+ .. currentmodule :: singlestoredb.management.users
461+
462+ .. autosummary ::
463+ :toctree: generated/
464+
465+ User
466+ User.get_identity_roles
467+ User.remove
468+
469+
470+ Team Management
471+ ...............
472+
473+ Team objects allow you to organize users into groups.
474+
475+ .. currentmodule :: singlestoredb.management.teams
476+
477+ .. autosummary ::
478+ :toctree: generated/
479+
480+ Team
481+ Team.refresh
482+ Team.update
483+ Team.delete
484+ Team.get_access_controls
485+ Team.update_access_controls
486+ Team.get_identity_roles
487+
488+
489+ Role Management
490+ ...............
491+
492+ Role objects define permissions within your organization.
493+
494+ .. currentmodule :: singlestoredb.management.roles
495+
496+ .. autosummary ::
497+ :toctree: generated/
498+
499+ Role
500+ Role.update
501+ Role.delete
502+
503+
504+ Invitation Management
505+ .....................
506+
507+ Invitation objects represent invitations to join your organization.
508+
509+ .. currentmodule :: singlestoredb.management.invitations
510+
511+ .. autosummary ::
512+ :toctree: generated/
513+
514+ Invitation
515+ Invitation.revoke
516+
517+
518+ Audit Logging
519+ .............
520+
521+ Audit logs track changes and actions within your organization.
522+
523+ .. currentmodule :: singlestoredb.management.audit_logs
524+
525+ .. autosummary ::
526+ :toctree: generated/
527+
528+ AuditLog
529+ AuditLogResult
530+
531+
532+ Private Connections
533+ ...................
534+
535+ Private connections allow you to establish private network connectivity
536+ to your workspaces.
537+
538+ .. currentmodule :: singlestoredb.management.private_connections
539+
540+ .. autosummary ::
541+ :toctree: generated/
542+
543+ PrivateConnection
544+ PrivateConnection.refresh
545+ PrivateConnection.update
546+ PrivateConnection.delete
547+ OutboundAllowListEntry
548+ KaiPrivateConnectionInfo
549+
550+
551+ Billing
552+ .......
553+
554+ Billing objects provide access to usage and billing information.
555+
556+ .. currentmodule :: singlestoredb.management.workspace
557+
558+ .. autosummary ::
559+ :toctree: generated/
560+
561+ Billing
562+ Billing.usage
563+
564+ .. currentmodule :: singlestoredb.management.billing_usage
565+
566+ .. autosummary ::
567+ :toctree: generated/
568+
569+ UsageItem
570+ BillingUsageItem
571+
572+
573+ Starter Workspaces
574+ ..................
575+
576+ Starter workspaces provide a free tier option for development and testing.
577+
578+ .. currentmodule :: singlestoredb.management.workspace
579+
580+ .. autosummary ::
581+ :toctree: generated/
582+
583+ StarterWorkspace
584+ StarterWorkspace.connect
585+ StarterWorkspace.terminate
586+ StarterWorkspace.refresh
587+ StarterWorkspace.create_user
588+ StarterWorkspace.get_user
589+ StarterWorkspaceUser
590+ StarterWorkspaceUser.update
591+ StarterWorkspaceUser.delete
592+
593+
594+ Storage and Disaster Recovery
595+ .............................
596+
597+ Storage objects provide access to workspace group storage settings
598+ and disaster recovery functionality.
599+
600+ .. currentmodule :: singlestoredb.management.storage
601+
602+ .. autosummary ::
603+ :toctree: generated/
604+
605+ Storage
606+ Storage.dr
607+ Storage.update_retention_period
608+
609+
610+ DisasterRecovery
611+ ^^^^^^^^^^^^^^^^
612+
613+ DisasterRecovery objects manage disaster recovery configuration and operations.
614+
615+ .. autosummary ::
616+ :toctree: generated/
617+
618+ DisasterRecovery
619+ DisasterRecovery.get_status
620+ DisasterRecovery.get_regions
621+ DisasterRecovery.setup
622+ DisasterRecovery.failover
623+ DisasterRecovery.failback
624+ DisasterRecovery.start_pre_provision
625+ DisasterRecovery.stop_pre_provision
626+ DRStatus
627+ DRRegion
628+
629+
630+ Export Service
631+ ..............
632+
633+ Export services allow you to replicate data from SingleStore to external systems.
634+
635+ .. currentmodule :: singlestoredb.management.export
636+
637+ .. autosummary ::
638+ :toctree: generated/
639+
640+ ExportService
641+ ExportService.create_cluster_identity
642+ ExportService.start
643+ ExportService.suspend
644+ ExportService.resume
645+ ExportService.drop
646+ ExportService.status
647+ ExportStatus
648+
649+
650+ Inference API
651+ .............
652+
653+ Inference API management allows you to deploy and manage ML models.
654+
655+ .. currentmodule :: singlestoredb.management.inference_api
656+
657+ .. autosummary ::
658+ :toctree: generated/
659+
660+ InferenceAPIManager
661+ InferenceAPIManager.get
662+ InferenceAPIManager.start
663+ InferenceAPIManager.stop
664+ InferenceAPIManager.show
665+ InferenceAPIManager.drop
666+ InferenceAPIInfo
667+ InferenceAPIInfo.start
668+ InferenceAPIInfo.stop
669+ InferenceAPIInfo.drop
670+ ModelOperationResult
671+
672+
673+ Projects
674+ ........
675+
676+ Project objects represent projects within your organization.
677+
678+ .. currentmodule :: singlestoredb.management.projects
679+
680+ .. autosummary ::
681+ :toctree: generated/
682+
683+ Project
345684
346685
347686Jobs Management
0 commit comments