package
0.7.1
Repository: https://github.com/clever/atlas-api-client.git
Documentation: pkg.go.dev

# Functions

GetClustersInputPath returns the URI path for the input.
GetContainersInputPath returns the URI path for the input.
GetDatabaseUsersInputPath returns the URI path for the input.
GetPeersInputPath returns the URI path for the input.
GetProcessesInputPath returns the URI path for the input.
ValidateGetClustersInput returns an error if the input parameter doesn't satisfy the requirements in the swagger yml file.
ValidateGetContainersInput returns an error if the input parameter doesn't satisfy the requirements in the swagger yml file.
ValidateGetDatabaseUsersInput returns an error if the input parameter doesn't satisfy the requirements in the swagger yml file.
ValidateGetPeersInput returns an error if the input parameter doesn't satisfy the requirements in the swagger yml file.
ValidateGetProcessesInput returns an error if the input parameter doesn't satisfy the requirements in the swagger yml file.

# Constants

BIConnectorReadPreferenceAnalytics captures enum value "analytics".
BIConnectorReadPreferencePrimary captures enum value "primary".
BIConnectorReadPreferenceSecondary captures enum value "secondary".
ClusterStateCREATING captures enum value "CREATING".
ClusterStateDELETED captures enum value "DELETED".
ClusterStateDELETING captures enum value "DELETING".
ClusterStateIDLE captures enum value "IDLE".
ClusterStateREPAIRING captures enum value "REPAIRING".
ClusterStateUPDATING captures enum value "UPDATING".
ClusterTypeGEOSHARDED captures enum value "GEOSHARDED".
ClusterTypeREPLICASET captures enum value "REPLICASET".
ClusterTypeSHARDED captures enum value "SHARDED".
CreateOrUpdateClusterRequestMongoDBMajorVersionNr32 captures enum value "3.2".
CreateOrUpdateClusterRequestMongoDBMajorVersionNr34 captures enum value "3.4".
CreateOrUpdateClusterRequestMongoDBMajorVersionNr36 captures enum value "3.6".
CreateOrUpdateClusterRequestMongoDBMajorVersionNr40 captures enum value "4.0".
CreateOrUpdateContainerRequestProviderNameAWS captures enum value "AWS".
EventTypeAWSENCRYPTIONKEYNEEDSROTATION captures enum value "AWS_ENCRYPTION_KEY_NEEDS_ROTATION".
EventTypeAZUREENCRYPTIONKEYNEEDSROTATION captures enum value "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION".
EventTypeCLUSTERMONGOSISMISSING captures enum value "CLUSTER_MONGOS_IS_MISSING".
EventTypeCREDITCARDABOUTTOEXPIRE captures enum value "CREDIT_CARD_ABOUT_TO_EXPIRE".
EventTypeDAILYBILLOVERTHRESHOLD captures enum value "DAILY_BILL_OVER_THRESHOLD".
EventTypeGCPENCRYPTIONKEYNEEDSROTATION captures enum value "GCP_ENCRYPTION_KEY_NEEDS_ROTATION".
EventTypeHOSTDOWN captures enum value "HOST_DOWN".
EventTypeJOINEDGROUP captures enum value "JOINED_GROUP".
EventTypeNDSX509USERAUTHENTICATIONCUSTOMERCAEXPIRATIONCHECK captures enum value "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK".
EventTypeNDSX509USERAUTHENTICATIONMANAGEDUSERCERTSEXPIRATIONCHECK captures enum value "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK".
EventTypeNOPRIMARY captures enum value "NO_PRIMARY".
EventTypeOUTSIDEMETRICTHRESHOLD captures enum value "OUTSIDE_METRIC_THRESHOLD".
EventTypePENDINGINVOICEOVERTHRESHOLD captures enum value "PENDING_INVOICE_OVER_THRESHOLD".
EventTypePRIMARYELECTED captures enum value "PRIMARY_ELECTED".
EventTypeREMOVEDFROMGROUP captures enum value "REMOVED_FROM_GROUP".
EventTypeREPLICATIONOPLOGWINDOWRUNNINGOUT captures enum value "REPLICATION_OPLOG_WINDOW_RUNNING_OUT".
EventTypeTOOMANYELECTIONS captures enum value "TOO_MANY_ELECTIONS".
EventTypeUSERROLESCHANGEDAUDIT captures enum value "USER_ROLES_CHANGED_AUDIT".
EventTypeUSERSWITHOUTMULTIFACTORAUTH captures enum value "USERS_WITHOUT_MULTIFACTOR_AUTH".
GranularityP1D captures enum value "P1D".
GranularityPT1H captures enum value "PT1H".
GranularityPT1M captures enum value "PT1M".
GranularityPT5M captures enum value "PT5M".
MetricValueUnitsBITS captures enum value "BITS".
MetricValueUnitsBYTES captures enum value "BYTES".
MetricValueUnitsDAYS captures enum value "DAYS".
MetricValueUnitsGIGABITS captures enum value "GIGABITS".
MetricValueUnitsGIGABYTES captures enum value "GIGABYTES".
MetricValueUnitsHOURS captures enum value "HOURS".
MetricValueUnitsKILOBITS captures enum value "KILOBITS".
MetricValueUnitsKILOBYTES captures enum value "KILOBYTES".
MetricValueUnitsMEGABITS captures enum value "MEGABITS".
MetricValueUnitsMEGABYTES captures enum value "MEGABYTES".
MetricValueUnitsMILLISECONDS captures enum value "MILLISECONDS".
MetricValueUnitsMINUTES captures enum value "MINUTES".
MetricValueUnitsPETABYTES captures enum value "PETABYTES".
MetricValueUnitsRAW captures enum value "RAW".
MetricValueUnitsSECONDS captures enum value "SECONDS".
MetricValueUnitsTERABYTES captures enum value "TERABYTES".
PeerErrorStateEXPIRED captures enum value "EXPIRED".
PeerErrorStateINVALIDARGUMENT captures enum value "INVALID_ARGUMENT".
PeerErrorStateREJECTED captures enum value "REJECTED".
PeerStatusAVAILABLE captures enum value "AVAILABLE".
PeerStatusFAILED captures enum value "FAILED".
PeerStatusFINALIZING captures enum value "FINALIZING".
PeerStatusINITIATING captures enum value "INITIATING".
PeerStatusPENDINGACCEPTANCE captures enum value "PENDING_ACCEPTANCE".
PeerStatusTERMINATING captures enum value "TERMINATING".
ProcessTypeNODATA captures enum value "NO_DATA".
ProcessTypeRECOVERING captures enum value "RECOVERING".
ProcessTypeREPLICAPRIMARY captures enum value "REPLICA_PRIMARY".
ProcessTypeREPLICASECONDARY captures enum value "REPLICA_SECONDARY".
ProcessTypeSHARDCONFIG captures enum value "SHARD_CONFIG".
ProcessTypeSHARDMONGOS captures enum value "SHARD_MONGOS".
ProcessTypeSHARDPRIMARY captures enum value "SHARD_PRIMARY".
ProcessTypeSHARDSECONDARY captures enum value "SHARD_SECONDARY".
ProcessTypeSHARDSTANDALONE captures enum value "SHARD_STANDALONE".
ProviderSettingsBackingProviderNameAWS captures enum value "AWS".
ProviderSettingsInstanceSizeNameM10 captures enum value "M10".
ProviderSettingsInstanceSizeNameM100 captures enum value "M100".
ProviderSettingsInstanceSizeNameM140 captures enum value "M140".
ProviderSettingsInstanceSizeNameM2 captures enum value "M2".
ProviderSettingsInstanceSizeNameM20 captures enum value "M20".
ProviderSettingsInstanceSizeNameM200 captures enum value "M200".
ProviderSettingsInstanceSizeNameM30 captures enum value "M30".
ProviderSettingsInstanceSizeNameM300 captures enum value "M300".
ProviderSettingsInstanceSizeNameM40 captures enum value "M40".
ProviderSettingsInstanceSizeNameM5 captures enum value "M5".
ProviderSettingsInstanceSizeNameM50 captures enum value "M50".
ProviderSettingsInstanceSizeNameM60 captures enum value "M60".
ProviderSettingsInstanceSizeNameM80 captures enum value "M80".
ProviderSettingsInstanceSizeNameR200 captures enum value "R200".
ProviderSettingsInstanceSizeNameR300 captures enum value "R300".
ProviderSettingsInstanceSizeNameR40 captures enum value "R40".
ProviderSettingsInstanceSizeNameR400 captures enum value "R400".
ProviderSettingsInstanceSizeNameR50 captures enum value "R50".
ProviderSettingsInstanceSizeNameR60 captures enum value "R60".
ProviderSettingsInstanceSizeNameR700 captures enum value "R700".
ProviderSettingsInstanceSizeNameR80 captures enum value "R80".
ProviderSettingsProviderNameAWS captures enum value "AWS".
ProviderSettingsProviderNameTENANT captures enum value "TENANT".
ProviderSettingsRegionNameUSEAST1 captures enum value "US_EAST_1".
ProviderSettingsRegionNameUSEAST2 captures enum value "US_EAST_2".
ProviderSettingsRegionNameUSWEST1 captures enum value "US_WEST_1".
ProviderSettingsRegionNameUSWEST2 captures enum value "US_WEST_2".
ProviderSettingsVolumeTypePROVISIONED captures enum value "PROVISIONED".
ProviderSettingsVolumeTypeSTANDARD captures enum value "STANDARD".
RestoreJobDeliveryMethodNameAUTOMATEDRESTORE captures enum value "AUTOMATED_RESTORE".
RestoreJobResponseDeliveryMethodNameAUTOMATEDRESTORE captures enum value "AUTOMATED_RESTORE".
RestoreJobResponseDeliveryMethodNameHTTP captures enum value "HTTP".
RestoreJobResponseDeliveryStatusNameEXPIRED captures enum value "EXPIRED".
RestoreJobResponseDeliveryStatusNameFAILED captures enum value "FAILED".
RestoreJobResponseDeliveryStatusNameINPROGRESS captures enum value "IN_PROGRESS".
RestoreJobResponseDeliveryStatusNameINTERRUPTED captures enum value "INTERRUPTED".
RestoreJobResponseDeliveryStatusNameMAXDOWNLOADSEXCEEDED captures enum value "MAX_DOWNLOADS_EXCEEDED".
RestoreJobResponseDeliveryStatusNameNOTSTARTED captures enum value "NOT_STARTED".
RestoreJobResponseDeliveryStatusNameREADY captures enum value "READY".
RestoreJobStatusNameBROKEN captures enum value "BROKEN".
RestoreJobStatusNameFINISHED captures enum value "FINISHED".
RestoreJobStatusNameINPROGRESS captures enum value "IN_PROGRESS".
RestoreJobStatusNameKILLED captures enum value "KILLED".
RoleNameAtlasAdmin captures enum value "atlasAdmin".
RoleNameBackup captures enum value "backup".
RoleNameClusterMonitor captures enum value "clusterMonitor".
RoleNameDbAdmin captures enum value "dbAdmin".
RoleNameDbAdminAnyDatabase captures enum value "dbAdminAnyDatabase".
RoleNameEnableSharding captures enum value "enableSharding".
RoleNameRead captures enum value "read".
RoleNameReadAnyDatabase captures enum value "readAnyDatabase".
RoleNameReadWrite captures enum value "readWrite".
RoleNameReadWriteAnyDatabase captures enum value "readWriteAnyDatabase".
SnapshotPartTypeNameCONFIGSERVERREPLICASET captures enum value "CONFIG_SERVER_REPLICA_SET".
SnapshotPartTypeNameREPLICASET captures enum value "REPLICA_SET".
UnitsBYTES captures enum value "BYTES".
UnitsBYTESPERSECOND captures enum value "BYTES_PER_SECOND".
UnitsGIGABYTES captures enum value "GIGABYTES".
UnitsGIGABYTESPERHOUR captures enum value "GIGABYTES_PER_HOUR".
UnitsMEGABYTESPERSECOND captures enum value "MEGABYTES_PER_SECOND".
UnitsMILLISECONDS captures enum value "MILLISECONDS".
UnitsPERCENT captures enum value "PERCENT".
UnitsSCALAR captures enum value "SCALAR".
UnitsSCALARPERSECOND captures enum value "SCALAR_PER_SECOND".

# Structs

AutoScaling auto scaling swagger:model AutoScaling.
BadRequest bad request swagger:model BadRequest.
BIConnector b i connector swagger:model BIConnector.
Cluster cluster swagger:model Cluster.
Conflict conflict swagger:model Conflict.
Container container swagger:model Container.
CreateClusterInput holds the input parameters for a createCluster operation.
CreateContainerInput holds the input parameters for a createContainer operation.
CreateDatabaseUserInput holds the input parameters for a createDatabaseUser operation.
CreateDatabaseUserRequest create database user request swagger:model CreateDatabaseUserRequest.
CreateOrUpdateClusterRequest create or update cluster request swagger:model CreateOrUpdateClusterRequest.
CreateOrUpdateContainerRequest create or update container request swagger:model CreateOrUpdateContainerRequest.
CreatePeerInput holds the input parameters for a createPeer operation.
CreatePeerRequest create peer request swagger:model CreatePeerRequest.
CreateRestoreJobInput holds the input parameters for a createRestoreJob operation.
CreateRestoreJobRequest create restore job request swagger:model CreateRestoreJobRequest.
CreateRestoreJobResponse create restore job response swagger:model CreateRestoreJobResponse.
Database database swagger:model Database.
DatabaseUser database user swagger:model DatabaseUser.
DataPoint data point swagger:model DataPoint.
DeleteClusterInput holds the input parameters for a deleteCluster operation.
DeleteDatabaseUserInput holds the input parameters for a deleteDatabaseUser operation.
DeletePeerInput holds the input parameters for a deletePeer operation.
Disk disk swagger:model Disk.
Event event swagger:model Event.
Forbidden forbidden swagger:model Forbidden.
GetClusterInput holds the input parameters for a getCluster operation.
GetClustersInput holds the input parameters for a getClusters operation.
GetClustersResponse get clusters response swagger:model GetClustersResponse.
GetContainerInput holds the input parameters for a getContainer operation.
GetContainersInput holds the input parameters for a getContainers operation.
GetContainersResponse get containers response swagger:model GetContainersResponse.
GetDatabaseUserInput holds the input parameters for a getDatabaseUser operation.
GetDatabaseUsersInput holds the input parameters for a getDatabaseUsers operation.
GetDatabaseUsersResponse get database users response swagger:model GetDatabaseUsersResponse.
GetEventsInput holds the input parameters for a getEvents operation.
GetEventsResponse get events response swagger:model GetEventsResponse.
GetPeerInput holds the input parameters for a getPeer operation.
GetPeersInput holds the input parameters for a getPeers operation.
GetPeersResponse get peers response swagger:model GetPeersResponse.
GetProcessDatabaseMeasurementsInput holds the input parameters for a getProcessDatabaseMeasurements operation.
GetProcessDatabaseMeasurementsResponse get process database measurements response swagger:model GetProcessDatabaseMeasurementsResponse.
GetProcessDatabasesInput holds the input parameters for a getProcessDatabases operation.
GetProcessDatabasesResponse get process databases response swagger:model GetProcessDatabasesResponse.
GetProcessDiskMeasurementsInput holds the input parameters for a getProcessDiskMeasurements operation.
GetProcessDiskMeasurementsResponse get process disk measurements response swagger:model GetProcessDiskMeasurementsResponse.
GetProcessDisksInput holds the input parameters for a getProcessDisks operation.
GetProcessDisksResponse get process disks response swagger:model GetProcessDisksResponse.
GetProcessesInput holds the input parameters for a getProcesses operation.
GetProcessesResponse get processes response swagger:model GetProcessesResponse.
GetProcessMeasurementsInput holds the input parameters for a getProcessMeasurements operation.
GetProcessMeasurementsResponse get process measurements response swagger:model GetProcessMeasurementsResponse.
GetRestoreJobInput holds the input parameters for a getRestoreJob operation.
GetRestoreJobsInput holds the input parameters for a getRestoreJobs operation.
GetRestoreJobsResponse get restore jobs response swagger:model GetRestoreJobsResponse.
GetSnapshotScheduleInput holds the input parameters for a getSnapshotSchedule operation.
GetSnapshotsInput holds the input parameters for a getSnapshots operation.
GetSnapshotsResponse get snapshots response swagger:model GetSnapshotsResponse.
InternalError internal error swagger:model InternalError.
Link link swagger:model Link.
Measurement measurement swagger:model Measurement.
MetricValue metric value swagger:model MetricValue.
NotFound not found swagger:model NotFound.
Peer peer swagger:model Peer.
Process process swagger:model Process.
ProviderSettings provider settings swagger:model ProviderSettings.
RegionsConfig regions config swagger:model RegionsConfig.
RegionsConfigEntry regions config entry swagger:model RegionsConfigEntry.
ReplicationSpec replication spec swagger:model ReplicationSpec.
ReplicationSpecEntry replication spec entry swagger:model ReplicationSpecEntry.
ReplicationSpecItem replication spec item swagger:model ReplicationSpecItem.
RestartPrimariesInput holds the input parameters for a restartPrimaries operation.
RestoreJob restore job swagger:model RestoreJob.
RestoreJobDelivery restore job delivery swagger:model RestoreJobDelivery.
RestoreJobResponseDelivery restore job response delivery swagger:model RestoreJobResponseDelivery.
RestoreJobResponseHash restore job response hash swagger:model RestoreJobResponseHash.
Role role swagger:model Role.
Snapshot snapshot swagger:model Snapshot.
SnapshotPart snapshot part swagger:model SnapshotPart.
SnapshotSchedule snapshot schedule swagger:model SnapshotSchedule.
SnapshotTimestamp snapshot timestamp swagger:model SnapshotTimestamp.
TooManyRequests too many requests swagger:model TooManyRequests.
Unauthorized unauthorized swagger:model Unauthorized.
UpdateClusterInput holds the input parameters for a updateCluster operation.
UpdateContainerInput holds the input parameters for a updateContainer operation.
UpdateDatabaseUserInput holds the input parameters for a updateDatabaseUser operation.
UpdateDatabaseUserRequest update database user request swagger:model UpdateDatabaseUserRequest.
UpdatePeerInput holds the input parameters for a updatePeer operation.
UpdatePeerRequest update peer request swagger:model UpdatePeerRequest.
UpdateSnapshotScheduleInput holds the input parameters for a updateSnapshotSchedule operation.
UpdateSnapshotScheduleRequest update snapshot schedule request swagger:model UpdateSnapshotScheduleRequest.

# Type aliases

BIConnectorReadPreference b i connector read preference swagger:model BIConnectorReadPreference.
ClusterState cluster state swagger:model ClusterState.
ClusterType cluster type swagger:model ClusterType.
EventType event type swagger:model EventType.
Granularity granularity swagger:model Granularity.
PeerErrorState peer error state swagger:model PeerErrorState.
PeerStatus peer status swagger:model PeerStatus.
ProcessType process type swagger:model ProcessType.
RoleName role name swagger:model RoleName.
Units units swagger:model Units.