# Functions

DoRequestWithClient submits an HTTP request using the specified client.
New returns a new Ops Manager API client instance.
NewArgError creates an InputError.
NewClient returns a new Ops Manager API client.
Options turns a list of ClientOpt instances into a ClientOpt.
SetBaseURL is a client option for setting the base URL.
SetUserAgent is a client option for setting the user agent.
SetWithRaw is a client option for getting raw Ops Manager server response within Response structure.

# Constants

ClientVersion of the current API client.
No description provided by the author

# Structs

AccessListAPIKey represents a AccessList API key.
AccessListAPIKeys represents all AccessList API keys.
AccessListAPIKeysReq represents the request to the method create.
AcknowledgeRequest contains the request Body Parameters.
AdminBackupConfig contains the common fields of backup administrator structs.
Agent represents an Ops Manager agent.
AgentAPIKey defines the structure for an Agent API key.
AgentAPIKeysRequest a creation request for Agent API keys.
No description provided by the author
Agents is a paginated collection of Agent.
No description provided by the author
AgentVersions is a set of available agents and agent versions for a project.
Alert represents MongoDB Alert.
AlertConfiguration represents MongoDB Alert Configuration.
AlertConfigurationsResponse is the response from the AlertConfigurationsService.List.
AlertsListOptions contains the list of options for Alerts.
AlertsResponse is the response from the AlertService.List.
AllClustersCluster represents MongoDB cluster.
No description provided by the author
No description provided by the author
APIKey represents MongoDB API Key.
APIKeyInput represents MongoDB API key input request for Create.
APIKeysResponse is the response from the APIKeysService.List.
ArgError is an error that represents an error with an input to godo.
Args26 part of the internal Process struct.
AssignAPIKey contains the roles to be assigned to an Organization API key into a Project.
AuditLog part of the internal Process struct.
Auth authentication config.
AuthenticationRestriction of a database user.
AutomationConfig represents an Ops Manager project automation config.
AutomationConfigAgent components versions.
No description provided by the author
BackupConfig represents a Backup configuration in the MongoDB Ops Manager API.
BackupConfigs represents a paginated collection of BackupConfig.
BackupStore represents a Blockstore, Oplog and Sync in the MongoDB Ops Manager API.
BackupStores represents a paginated collection of BackupStore.
No description provided by the author
Checkpoint represents MongoDB Checkpoint.
CheckpointPart represents the individual parts that comprise the complete checkpoint.
Checkpoints represents all the backup checkpoints related to a cluster.
ChildJob represents a ChildJob in the MongoDB Ops Manager API.
Client manages communication with Ops Manager API.
Cluster represents a cluster in Ops Manager.
Clusters is a list of clusters.
CollationOptions represents options for collation indexes.
No description provided by the author
ConnectionStatus represents the response of LiveDataMigrationService.ConnectOrganizations and LiveDataMigrationService.ConnectionStatus.
No description provided by the author
No description provided by the author
No description provided by the author
ContinuousSnapshot represents a cloud provider snapshot.
ContinuousSnapshots represents all cloud provider snapshots.
CreateOrganizationRequest struct for CreateOrganizationRequest.
CreateOrganizationResponse struct for CreateOrganizationResponse.
No description provided by the author
CreateUserResponse API response for the CreateFirstUser() call.
CurrentValue represents current value of the metric that triggered the alert.
Daemon represents a Backup Daemon Configuration in the MongoDB Ops Manager API.
Daemons represents a paginated collection of Daemon.
DataPoints represents a MongoDB DataPoints.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DiagnosticsListOpts query options for getting the archive.
DiagnosticsServiceOp provides an implementation of the DiagnosticsService interface.
ErrorResponse reports the error caused by an API request.
Event represents an event of the MongoDB Ops Manager API.
EventListOptions specifies the optional parameters to the Event List methods.
EventResponse is the response from the EventsService.List.
ExternalManagementSystem contains parameters for the external system that manages this Ops Manager Project.
FeaturePolicy represents an Ops Manager feature policy.
FileSystemStoreConfiguration represents a File System Store Configuration in the MongoDB Ops Manager API.
FileSystemStoreConfigurations represents a paginated collection of FileSystemStoreConfiguration.
No description provided by the author
GlobalAlert configuration struct.
GlobalAlerts collection of configurations.
GlobalWhitelistAPIKey represents a Whitelist API key.
GlobalWhitelistAPIKeys represents all Whitelist API keys.
No description provided by the author
Host represents a MongoDB host process in Ops Manager.
HostAssignment represents a HostAssignment in the MongoDB Ops Manager API.
HostAssignmentProcess represents a HostAssignmentProcess in the MongoDB Ops Manager API.
HostAssignments represents a paginated collection of HostAssignment.
HostCount number of processes per project.
No description provided by the author
No description provided by the author
IndexConfig represents a new index requests for a given database and collection.
IndexOptions represents mongodb index options.
Invitation represents the structure of an Invitation.
InvitationOptions filtering options for invitations.
LDAPGroupMapping for LDAP-backed Ops Manager, the mappings of LDAP groups to Ops Manager project roles.
Link is the link to sub-resources and/or related resources.
No description provided by the author
ListOptions specifies the optional parameters to List methods that support pagination.
LogCollectionJob represents a Log Collection Job in the MongoDB Ops Manager API.
LogCollectionJobs represents a array of LogCollectionJobs.
LogListOptions specifies the optional parameters to List methods that support pagination.
LogRotate part of the internal Process struct.
LogsServiceOp handles communication with the Log Collection Jobs download method of the MongoDB Ops Manager API.
No description provided by the author
MaintenanceWindow represents MongoDB Maintenance Windows.
MaintenanceWindows is the response from the MaintenanceWindowsService.List.
Matcher represents the Rules to apply when matching an object against this alert configuration.
Measurements represents a MongoDB Measurement.
Member configs.
MetricThreshold causes an alert to be triggered.
No description provided by the author
MongoDBDeletedUser user to delete from DBs list.
MongoDBUser database user.
Namespace represents a Namespace.
No description provided by the author
NamespaceOptions contains the request query parameters for the API request.
Namespaces represents a list of Namespace.
Net part of the internal Process struct.
Notification sends when an alert condition is detected.
OMRole represents a role name of API key.
OMUserAssigned represents the user assigned to the project.
Operation represents a document with specific information and log lines for individual queries.
Organization represents the structure of an organization.
Organizations represents an array of organization.
OrganizationsListOptions filtering options for organizations.
No description provided by the author
Policy contains policies that the external system applies to this Ops Manager Project.
Process represents a single process in a deployment.
ProcessDatabase is the database information of a process.
ProcessDatabaseMeasurements represents a MongoDB process database measurements.
ProcessDatabasesResponse is the response from the ProcessDatabasesService.List.
ProcessDisk is the partition information of a process.
ProcessDiskMeasurements represents a MongoDB Process Disk Measurements.
ProcessDisksResponse is the response from the ProcessDisksService.List.
ProcessMeasurementListOptions contains the list of options for Process Measurements.
ProcessMeasurements represents a MongoDB Process Measurements.
No description provided by the author
Project represents the structure of a project.
ProjectJob represents a Backup Project Configuration Job in the MongoDB Ops Manager API.
ProjectJobs represents a paginated collection of ProjectJob.
Projects represents a array of project.
ProjectsListOptions filtering options for projects.
ProjectTeam represents the kind of role that has the team.
No description provided by the author
ReplicaSet configuration.
Replication is part of the internal Process struct.
Response is a MongoDB Ops Manager response.
Result is part og TeamsAssigned structure.
Role of a database user.
S3Blockstore represents a S3Blockstore in the MongoDB Ops Manager API.
S3Blockstores represents a paginated collection of S3Blockstore.
ScramShaCreds configuration.
ServerType represents a ServerType in the MongoDB Ops Manager API.
ServerTypeOptions specifies the optional parameters to List methods that support pagination.
ServerTypeRequest contains request body parameters for Server Usage Service.
ServerUsageReportServiceOp handles communication with the Log Collection Jobs download method of the MongoDB Ops Manager API.
ServiceVersion represents version information.
No description provided by the author
Shape represents a document with information about the query shapes that are served by the suggested indexes.
Shard details.
Sharding is part of the internal Process struct.
ShardingConfig sharded clusters configuration.
SlowQueries represents a list of SlowQuery.
SlowQuery represents a slow query.
SlowQueryOptions contains the request query parameters for the API request.
No description provided by the author
No description provided by the author
No description provided by the author
SoftwareVersions is a set of software components and their expected current and minimum versions.
SSL config properties.
Stats represents query statistics.
Storage part of the internal Process struct.
StoreFilter represents a StoreFilter in the MongoDB Ops Manager API.
SuggestedIndex represents a suggested index.
SuggestedIndexes represents an array of suggested indexes.
SuggestedIndexOptions contains the request query parameters for the API request.
SystemLog part of the internal Process struct.
Team defines an Ops Manager team structure.
TeamRoles List of roles for a team.
TeamsAssigned represents the one team assigned to the project.
TeamsResponse represents a array of project.
TeamUpdateRoles update request body.
TeamUpdateRolesResponse update roles response.
Threshold that triggers an alert.
TLS defines TLS parameters for Net.
User wrapper for a user response, augmented with a few extra fields.
UserRole denotes a single user role.
UsersResponse represents a array of users.
No description provided by the author
No description provided by the author
WhitelistAPIKeysReq represents a source allowed to use global API keys.
WhitelistOpts allows access from given IPs.

# Interfaces

AccessListAPIKeysService is an interface for interfacing with the AccessList API Keys endpoints of the MongoDB Ops Manager API.
AgentsService provides access to the agent related functions in the Ops Manager API.
AlertConfigurationsService provides access to the alert configuration related functions in the Ops Manager API.
AlertsService is an interface for interfacing with the Alerts.
APIKeysService is an interface for interfacing with the APIKeys.
AutomationService provides access to the automation related functions in the Ops Manager API.
BackupConfigsService is an interface for using the Backup Configurations endpoints of the MongoDB Ops Manager API.
BlockstoreConfigService is an interface for using the Blockstore Configuration endpoints of the MongoDB Ops Manager API.
CheckpointsService provides access to the backup related functions in the Ops Manager API.
ClustersService provides access to the cluster related functions in the Ops Manager API.
Completer interface for clients with callback.
ContinuousRestoreJobsService provides access to the restore jobs related functions in the Ops Manager API.
ContinuousSnapshotsService is an interface for interfacing with the Continuous Snapshots.
DaemonConfigService is an interface for using the Backup Daemon endpoints of the MongoDB Ops Manager API.
DeploymentsService provides access to the deployment related functions in the Ops Manager API.
DiagnosticsService is an interface for interfacing with Diagnostic Archives in MongoDB Ops Manager APIs https://docs.opsmanager.mongodb.com/current/reference/api/diagnostic-archives/.
Doer basic interface of a client to be able to do a request.
EventsService is an interface for interfacing with the Events.
FeatureControlPoliciesService provides access to the Feature Control Policies related functions in the Ops Manager API.
FileSystemStoreConfigService is an interface for using the File System Store Configuration endpoints of the MongoDB Ops Manager API.
GlobalAlertsService provides access to the global alerts related functions in the Ops Manager API.
GlobalAPIKeysService provides access to the global alerts related functions in the Ops Manager API.
GlobalAPIKeyWhitelistsService provides access to the global alerts related functions in the Ops Manager API.
GZipRequestDoer minimum interface for any service of the client that should handle gzip downloads.
No description provided by the author
LiveDataMigrationService is an interface for interfacing with the Live Migration endpoints of the MongoDB Ops Manager API.
LogCollectionService is an interface for interfacing with the Log Collection Jobs endpoints of the MongoDB Ops Manager API.
LogsService is an interface for interfacing with the Log Collection Jobs endpoints of the MongoDB Ops Manager API.
MaintenanceWindowsService is an interface for interfacing with the Maintenance Windows endpoints of the MongoDB Ops Manager API.
MeasurementsService provides access to the measurement related functions in the Ops Manager API.
OplogStoreConfigService is an interface for using the Oplog endpoints of the MongoDB Ops Manager API.
OrganizationsService provides access to the organization related functions in the Ops Manager API.
PerformanceAdvisorService is an interface of the Performance Advisor endpoints of the MongoDB Ops Manager API.
PlainRequestDoer minimum interface for any service of the client that should handle plain text.
ProjectAPIKeysService is an interface for interfacing with the APIKeys.
ProjectJobConfigService is an interface for using the Project Job endpoints of the MongoDB Ops Manager API.
ProjectsService provides access to the project related functions in the Ops Manager API.
RequestDoer minimum interface for any service of the client.
S3BlockstoreConfigService is an interface for using the S3 Blockstore Service endpoints of the MongoDB Ops Manager API.
ServerUsageReportService interface is an interface for downloading the service usage report.
ServerUsageService is an interface for using the Server Usage Service endpoints of the MongoDB Ops Manager API.
ServiceVersionService is an interface for the version private endpoint of the MongoDB Ops Manager API.
SnapshotScheduleService is an interface for using the Snapshot schedule endpoints of the MongoDB Ops Manager API.
SyncStoreConfigService is an interface for using the Sync endpoints of the MongoDB Ops Manager API.
TeamsService provides access to the team related functions in the Ops Manager API.
UnauthUsersService is an interface for interfacing with unauthenticated APIs.
UsersService provides access to the user related functions in the Ops Manager API.
VersionManifestService is an interface for using the Version Manifest endpoints of the MongoDB Ops Manager API.

# Type aliases

AccessListAPIKeysServiceOp handles communication with the AccessList API keys related methods of the MongoDB Ops Manager API.
AgentsServiceOp provides an implementation of the AgentsService interface.
AlertConfigurationsServiceOp handles communication with the AlertConfiguration related methods.
AlertsServiceOp provides an implementation of AlertsService.
APIKeysServiceOp handles communication with the APIKey related methods of the MongoDB Ops Manager API.
AutomationServiceOp provides an implementation of the AutomationService interface.
BackupConfigsServiceOp provides an implementation of the BackupConfigsService interface.
BlockstoreConfigServiceOp provides an implementation of the BlockstoreConfigService interface.
CheckpointsServiceOp provides an implementation of the CheckpointsService interface.
ClientOpt are options for New.
ClustersServiceOp provides an implementation of the ClustersService interface.
ContinuousRestoreJobsServiceOp handles communication with the Continuous Backup Restore Jobs related methods of the MongoDB Ops Manager API.
ContinuousSnapshotsServiceOp handles communication with the Continuous Snapshots related methods of the MongoDB Ops Manager API.
DaemonConfigServiceOp provides an implementation of the DaemonConfigService interface.
DeploymentsServiceOp provides an implementation of the DeploymentsService interface.
EventsServiceOp handles communication with the Event related methods of the MongoDB Ops Manager API.
FeatureControlPoliciesServiceOp provides an implementation of the FeatureControlPoliciesService interface.
FileSystemStoreConfigServiceOp provides an implementation of the FileSystemStoreConfigService interface.
GlobalAlertsServiceOp provides an implementation of the GlobalAlertsService interface.
GlobalAPIKeysServiceOp provides an implementation of the GlobalAPIKeysService interface.
GlobalAPIKeyWhitelistsServiceOp provides an implementation of the GlobalAPIKeyWhitelistsService interface.
LiveDataMigrationServiceOp provides an implementation of the LiveDataMigrationService interface.
LogCollectionServiceOp provides an implementation of the DiagnosticsService interface.
MaintenanceWindowsServiceOp handles communication with the MaintenanceWindows related methods of the Ops Manager API.
MeasurementsServiceOp provides an implementation of the MeasurementsService interface.
OplogStoreConfigServiceOp provides an implementation of the OplogStoreConfigService interface.
OrganizationsServiceOp provides an implementation of the OrganizationsService interface.
PerformanceAdvisorServiceOp handles communication with the Performance Advisor related methods of the MongoDB OpsManager API.
ProjectAPIKeysOp handles communication with the APIKey related methods of the MongoDB Ops Manager API.
ProjectJobConfigServiceOp provides an implementation of the ProjectJobConfigService interface.
ProjectsServiceOp provides an implementation of the ProjectsService interface.
RequestCompletionCallback defines the type of the request callback function.
ResponseProcessedCallback defines the type of the after request completion callback function.
S3BlockstoreConfigServiceOp provides an implementation of the S3BlockstoreConfigServiceinterface.
ServerUsageServiceOp provides an implementation of the ServerUsageService.
SnapshotScheduleServiceOp provides an implementation of the SnapshotScheduleService interface.
SyncStoreConfigServiceOp provides an implementation of the SyncStoreConfigService interface.
TeamsServiceOp provides an implementation of the TeamsService interface.
UnauthUsersServiceOp handles communication with the unauthenticated API.
UsersServiceOp provides an implementation of the UsersService interface.
VersionManifestServiceOp provides an implementation of the VersionManifestService interface.