Documentation
¶
Index ¶
- Constants
- type AtlasDeploymentsService
- type Cluster
- func (c *Cluster) GetConnection() *status.ConnectionStrings
- func (c *Cluster) GetCustomResource() *akov2.AtlasDeployment
- func (c *Cluster) GetMongoDBVersion() string
- func (c *Cluster) GetName() string
- func (c *Cluster) GetProjectID() string
- func (c *Cluster) GetReplicaSet() []status.ReplicaSet
- func (c *Cluster) GetState() string
- func (c *Cluster) IsDedicated() bool
- func (c *Cluster) IsFlex() bool
- func (c *Cluster) IsServerless() bool
- func (c *Cluster) IsTenant() bool
- func (c *Cluster) Notifications() (bool, string, string)
- type Connection
- type Deployment
- type DeploymentService
- type Endpoint
- type Flex
- func (f *Flex) GetConnection() *status.ConnectionStrings
- func (f *Flex) GetCustomResource() *akov2.AtlasDeployment
- func (f *Flex) GetMongoDBVersion() string
- func (f *Flex) GetName() string
- func (f *Flex) GetProjectID() string
- func (f *Flex) GetReplicaSet() []status.ReplicaSet
- func (f *Flex) GetState() string
- func (f *Flex) IsDedicated() bool
- func (f *Flex) IsFlex() bool
- func (f *Flex) IsServerless() bool
- func (f *Flex) IsTenant() bool
- func (f *Flex) Notifications() (bool, string, string)
- type GlobalClusterService
- type PrivateEndpoint
- type ProductionAtlasDeployments
- func (ds *ProductionAtlasDeployments) ClusterExists(ctx context.Context, projectID, name string) (bool, error)
- func (ds *ProductionAtlasDeployments) ClusterWithProcessArgs(ctx context.Context, cluster *Cluster) error
- func (ds *ProductionAtlasDeployments) CreateCustomZones(ctx context.Context, projectID, clusterName string, ...) (map[string]string, error)
- func (ds *ProductionAtlasDeployments) CreateDeployment(ctx context.Context, deployment Deployment) (Deployment, error)
- func (ds *ProductionAtlasDeployments) CreateManagedNamespace(ctx context.Context, projectID, clusterName string, ns *akov2.ManagedNamespace) error
- func (ds *ProductionAtlasDeployments) DeleteCustomZones(ctx context.Context, projectID, clusterName string) error
- func (ds *ProductionAtlasDeployments) DeleteDeployment(ctx context.Context, deployment Deployment) error
- func (ds *ProductionAtlasDeployments) DeleteManagedNamespace(ctx context.Context, projectID, clusterName string, ...) error
- func (ds *ProductionAtlasDeployments) DeploymentIsReady(ctx context.Context, projectID, deploymentName string) (bool, error)
- func (ds *ProductionAtlasDeployments) GetCluster(ctx context.Context, projectID, name string) (*Cluster, error)
- func (ds *ProductionAtlasDeployments) GetCustomZones(ctx context.Context, projectID, clusterName string) (map[string]string, error)
- func (ds *ProductionAtlasDeployments) GetDeployment(ctx context.Context, projectID string, deployment *akov2.AtlasDeployment) (Deployment, error)
- func (ds *ProductionAtlasDeployments) GetFlexCluster(ctx context.Context, projectID, name string) (*Flex, error)
- func (ds *ProductionAtlasDeployments) GetManagedNamespaces(ctx context.Context, projectID, clusterName string) ([]akov2.ManagedNamespace, error)
- func (ds *ProductionAtlasDeployments) GetServerless(ctx context.Context, projectID, name string) (*Serverless, error)
- func (ds *ProductionAtlasDeployments) GetZoneMapping(ctx context.Context, projectID, deploymentName string) (map[string]string, error)
- func (ds *ProductionAtlasDeployments) ListDeploymentConnections(ctx context.Context, projectID string) ([]Connection, error)
- func (ds *ProductionAtlasDeployments) ListDeploymentNames(ctx context.Context, projectID string) ([]string, error)
- func (ds *ProductionAtlasDeployments) UpdateDeployment(ctx context.Context, deployment Deployment) (Deployment, error)
- func (ds *ProductionAtlasDeployments) UpdateProcessArgs(ctx context.Context, cluster *Cluster) error
- func (ds *ProductionAtlasDeployments) UpgradeToDedicated(ctx context.Context, currentDeployment, targetDeployment Deployment) (Deployment, error)
- type Serverless
- func (s *Serverless) GetConnection() *status.ConnectionStrings
- func (s *Serverless) GetCustomResource() *akov2.AtlasDeployment
- func (s *Serverless) GetMongoDBVersion() string
- func (s *Serverless) GetName() string
- func (s *Serverless) GetProjectID() string
- func (s *Serverless) GetReplicaSet() []status.ReplicaSet
- func (s *Serverless) GetState() string
- func (s *Serverless) IsDedicated() bool
- func (s *Serverless) IsFlex() bool
- func (s *Serverless) IsServerless() bool
- func (s *Serverless) IsTenant() bool
- func (s *Serverless) Notifications() (bool, string, string)
Constants ¶
View Source
const NOTIFICATION_REASON_DEPRECATION = "DeprecationWarning"
View Source
const NOTIFICATION_REASON_RECOMMENDATION = "RecommendationWarning"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AtlasDeploymentsService ¶
type AtlasDeploymentsService interface {
DeploymentService
GlobalClusterService
}
type Cluster ¶ added in v2.5.0
type Cluster struct {
*akov2.AdvancedDeploymentSpec
ProjectID string
State string
MongoDBVersion string
Connection *status.ConnectionStrings
ProcessArgs *akov2.ProcessArgs
ReplicaSet []status.ReplicaSet
ZoneID string
// contains filtered or unexported fields
}
func ComputeChanges ¶ added in v2.5.0
func (*Cluster) GetConnection ¶ added in v2.5.0
func (c *Cluster) GetConnection() *status.ConnectionStrings
func (*Cluster) GetCustomResource ¶ added in v2.5.0
func (c *Cluster) GetCustomResource() *akov2.AtlasDeployment
func (*Cluster) GetMongoDBVersion ¶ added in v2.5.0
func (*Cluster) GetProjectID ¶ added in v2.5.0
func (*Cluster) GetReplicaSet ¶ added in v2.5.0
func (c *Cluster) GetReplicaSet() []status.ReplicaSet
func (*Cluster) IsDedicated ¶ added in v2.11.0
func (*Cluster) IsServerless ¶ added in v2.5.0
type Connection ¶
type Deployment ¶ added in v2.5.0
type Deployment interface {
GetName() string
GetProjectID() string
GetCustomResource() *akov2.AtlasDeployment
GetState() string
GetMongoDBVersion() string
GetConnection() *status.ConnectionStrings
GetReplicaSet() []status.ReplicaSet
IsServerless() bool
IsFlex() bool
IsTenant() bool
IsDedicated() bool
Notifications() (bool, string, string)
}
func NewDeployment ¶ added in v2.5.0
func NewDeployment(projectID string, atlasDeployment *akov2.AtlasDeployment) Deployment
type DeploymentService ¶ added in v2.6.0
type DeploymentService interface {
ListDeploymentNames(ctx context.Context, projectID string) ([]string, error)
ListDeploymentConnections(ctx context.Context, projectID string) ([]Connection, error)
ClusterExists(ctx context.Context, projectID, clusterName string) (bool, error)
DeploymentIsReady(ctx context.Context, projectID, deploymentName string) (bool, error)
GetDeployment(ctx context.Context, projectID string, deployment *akov2.AtlasDeployment) (Deployment, error)
CreateDeployment(ctx context.Context, deployment Deployment) (Deployment, error)
UpdateDeployment(ctx context.Context, deployment Deployment) (Deployment, error)
DeleteDeployment(ctx context.Context, deployment Deployment) error
UpgradeToDedicated(ctx context.Context, currentDeployment, targetDeployment Deployment) (Deployment, error)
ClusterWithProcessArgs(ctx context.Context, cluster *Cluster) error
UpdateProcessArgs(ctx context.Context, cluster *Cluster) error
}
type Flex ¶ added in v2.7.0
type Flex struct {
*akov2.FlexSpec
ProjectID string
State string
MongoDBVersion string
Connection *status.ConnectionStrings
// contains filtered or unexported fields
}
func (*Flex) GetConnection ¶ added in v2.7.0
func (f *Flex) GetConnection() *status.ConnectionStrings
func (*Flex) GetCustomResource ¶ added in v2.7.0
func (f *Flex) GetCustomResource() *akov2.AtlasDeployment
func (*Flex) GetMongoDBVersion ¶ added in v2.7.0
func (*Flex) GetProjectID ¶ added in v2.7.0
func (*Flex) GetReplicaSet ¶ added in v2.7.0
func (f *Flex) GetReplicaSet() []status.ReplicaSet
func (*Flex) IsDedicated ¶ added in v2.11.0
func (*Flex) IsServerless ¶ added in v2.7.0
type GlobalClusterService ¶ added in v2.6.0
type GlobalClusterService interface {
GetCustomZones(ctx context.Context, projectID, clusterName string) (map[string]string, error)
CreateCustomZones(ctx context.Context, projectID, clusterName string, mappings []akov2.CustomZoneMapping) (map[string]string, error)
DeleteCustomZones(ctx context.Context, projectID, clusterName string) error
GetZoneMapping(ctx context.Context, projectID, deploymentName string) (map[string]string, error)
GetManagedNamespaces(ctx context.Context, projectID, clusterName string) ([]akov2.ManagedNamespace, error)
CreateManagedNamespace(ctx context.Context, projectID, clusterName string, ns *akov2.ManagedNamespace) error
DeleteManagedNamespace(ctx context.Context, projectID, clusterName string, ns *akov2.ManagedNamespace) error
}
type PrivateEndpoint ¶
type ProductionAtlasDeployments ¶
type ProductionAtlasDeployments struct {
// contains filtered or unexported fields
}
func NewAtlasDeployments ¶ added in v2.5.0
func NewAtlasDeployments(clusterService admin.ClustersApi, serverlessAPI admin.ServerlessInstancesApi, globalClusterAPI admin.GlobalClustersApi, flexAPI admin.FlexClustersApi, isGov bool) *ProductionAtlasDeployments
func (*ProductionAtlasDeployments) ClusterExists ¶
func (*ProductionAtlasDeployments) ClusterWithProcessArgs ¶ added in v2.5.0
func (ds *ProductionAtlasDeployments) ClusterWithProcessArgs(ctx context.Context, cluster *Cluster) error
func (*ProductionAtlasDeployments) CreateCustomZones ¶ added in v2.6.0
func (ds *ProductionAtlasDeployments) CreateCustomZones(ctx context.Context, projectID, clusterName string, mappings []akov2.CustomZoneMapping) (map[string]string, error)
func (*ProductionAtlasDeployments) CreateDeployment ¶ added in v2.5.0
func (ds *ProductionAtlasDeployments) CreateDeployment(ctx context.Context, deployment Deployment) (Deployment, error)
func (*ProductionAtlasDeployments) CreateManagedNamespace ¶ added in v2.6.0
func (ds *ProductionAtlasDeployments) CreateManagedNamespace(ctx context.Context, projectID, clusterName string, ns *akov2.ManagedNamespace) error
func (*ProductionAtlasDeployments) DeleteCustomZones ¶ added in v2.6.0
func (ds *ProductionAtlasDeployments) DeleteCustomZones(ctx context.Context, projectID, clusterName string) error
func (*ProductionAtlasDeployments) DeleteDeployment ¶ added in v2.5.0
func (ds *ProductionAtlasDeployments) DeleteDeployment(ctx context.Context, deployment Deployment) error
func (*ProductionAtlasDeployments) DeleteManagedNamespace ¶ added in v2.6.0
func (ds *ProductionAtlasDeployments) DeleteManagedNamespace(ctx context.Context, projectID, clusterName string, namespace *akov2.ManagedNamespace) error
func (*ProductionAtlasDeployments) DeploymentIsReady ¶
func (*ProductionAtlasDeployments) GetCluster ¶ added in v2.7.0
func (*ProductionAtlasDeployments) GetCustomZones ¶ added in v2.6.0
func (*ProductionAtlasDeployments) GetDeployment ¶ added in v2.5.0
func (ds *ProductionAtlasDeployments) GetDeployment(ctx context.Context, projectID string, deployment *akov2.AtlasDeployment) (Deployment, error)
func (*ProductionAtlasDeployments) GetFlexCluster ¶ added in v2.7.0
func (*ProductionAtlasDeployments) GetManagedNamespaces ¶ added in v2.6.0
func (ds *ProductionAtlasDeployments) GetManagedNamespaces(ctx context.Context, projectID, clusterName string) ([]akov2.ManagedNamespace, error)
func (*ProductionAtlasDeployments) GetServerless ¶ added in v2.7.0
func (ds *ProductionAtlasDeployments) GetServerless(ctx context.Context, projectID, name string) (*Serverless, error)
func (*ProductionAtlasDeployments) GetZoneMapping ¶ added in v2.6.0
func (*ProductionAtlasDeployments) ListDeploymentConnections ¶
func (ds *ProductionAtlasDeployments) ListDeploymentConnections(ctx context.Context, projectID string) ([]Connection, error)
func (*ProductionAtlasDeployments) ListDeploymentNames ¶ added in v2.6.0
func (*ProductionAtlasDeployments) UpdateDeployment ¶ added in v2.5.0
func (ds *ProductionAtlasDeployments) UpdateDeployment(ctx context.Context, deployment Deployment) (Deployment, error)
func (*ProductionAtlasDeployments) UpdateProcessArgs ¶ added in v2.5.0
func (ds *ProductionAtlasDeployments) UpdateProcessArgs(ctx context.Context, cluster *Cluster) error
func (*ProductionAtlasDeployments) UpgradeToDedicated ¶ added in v2.11.0
func (ds *ProductionAtlasDeployments) UpgradeToDedicated(ctx context.Context, currentDeployment, targetDeployment Deployment) (Deployment, error)
type Serverless ¶ added in v2.5.0
type Serverless struct {
*akov2.ServerlessSpec
ProjectID string
State string
MongoDBVersion string
Connection *status.ConnectionStrings
// contains filtered or unexported fields
}
func (*Serverless) GetConnection ¶ added in v2.5.0
func (s *Serverless) GetConnection() *status.ConnectionStrings
func (*Serverless) GetCustomResource ¶ added in v2.5.0
func (s *Serverless) GetCustomResource() *akov2.AtlasDeployment
func (*Serverless) GetMongoDBVersion ¶ added in v2.5.0
func (s *Serverless) GetMongoDBVersion() string
func (*Serverless) GetName ¶ added in v2.5.0
func (s *Serverless) GetName() string
func (*Serverless) GetProjectID ¶ added in v2.5.0
func (s *Serverless) GetProjectID() string
func (*Serverless) GetReplicaSet ¶ added in v2.5.0
func (s *Serverless) GetReplicaSet() []status.ReplicaSet
func (*Serverless) GetState ¶ added in v2.5.0
func (s *Serverless) GetState() string
func (*Serverless) IsDedicated ¶ added in v2.11.0
func (s *Serverless) IsDedicated() bool
func (*Serverless) IsFlex ¶ added in v2.7.0
func (s *Serverless) IsFlex() bool
func (*Serverless) IsServerless ¶ added in v2.5.0
func (s *Serverless) IsServerless() bool
func (*Serverless) IsTenant ¶ added in v2.11.0
func (s *Serverless) IsTenant() bool
func (*Serverless) Notifications ¶ added in v2.11.0
func (s *Serverless) Notifications() (bool, string, string)
Click to show internal directories.
Click to hide internal directories.