Class API

constructor

• new API(client): Mongodb.v1alpha1.API

• Parameters

  • client: Client

  Returns Mongodb.v1alpha1.API

Static ReadonlyLOCALITIES

createInstance

• createInstance(request): Promise<Mongodb.v1alpha1.Instance>

• Create a MongoDB® Database Instance. Create a new MongoDB® Database Instance.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.CreateInstanceRequest>

    The request CreateInstanceRequest

  Returns Promise<Mongodb.v1alpha1.Instance>

  A Promise of Instance

createSnapshot

• createSnapshot(request): Promise<Mongodb.v1alpha1.Snapshot>

• Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the name and instance_id parameters in the request.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.CreateSnapshotRequest>

    The request CreateSnapshotRequest

  Returns Promise<Mongodb.v1alpha1.Snapshot>

  A Promise of Snapshot

createUser

• createUser(request): Promise<Mongodb.v1alpha1.User>

• Create an user on a Database Instance. Create an user on a Database Instance. You must define the name, password of the user and instance_id parameters in the request.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.CreateUserRequest>

    The request CreateUserRequest

  Returns Promise<Mongodb.v1alpha1.User>

  A Promise of User

deleteEndpoint

• deleteEndpoint(request): Promise<void>

• Delete a Database Instance endpoint. Delete the endpoint of a Database Instance. You must specify the endpoint_id parameter of the endpoint you want to delete. Note that you might need to update any environment configurations that point to the deleted endpoint.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.DeleteEndpointRequest>

    The request DeleteEndpointRequest

  Returns Promise<void>

deleteInstance

• deleteInstance(request): Promise<Mongodb.v1alpha1.Instance>

• Delete a MongoDB® Database Instance. Delete a given MongoDB® Database Instance, specified by the region and instance_id parameters. Deleting a MongoDB® Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.DeleteInstanceRequest>

    The request DeleteInstanceRequest

  Returns Promise<Mongodb.v1alpha1.Instance>

  A Promise of Instance

deleteSnapshot

• deleteSnapshot(request): Promise<Mongodb.v1alpha1.Snapshot>

• Delete a Database Instance snapshot. Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the snapshot_id parameter of the snapshot you want to delete.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.DeleteSnapshotRequest>

    The request DeleteSnapshotRequest

  Returns Promise<Mongodb.v1alpha1.Snapshot>

  A Promise of Snapshot

getInstance

• getInstance(request): Promise<Mongodb.v1alpha1.Instance>

• Get a MongoDB® Database Instance. Retrieve information about a given MongoDB® Database Instance, specified by the region and instance_id parameters. Its full details, including name, status, IP address and port, are returned in the response object.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.GetInstanceRequest>

    The request GetInstanceRequest

  Returns Promise<Mongodb.v1alpha1.Instance>

  A Promise of Instance

getInstanceCertificate

• getInstanceCertificate(request): Promise<Blob>

• Get the certificate of a Database Instance. Retrieve the certificate of a given Database Instance, specified by the instance_id parameter.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.GetInstanceCertificateRequest>

    The request GetInstanceCertificateRequest

  Returns Promise<Blob>

  A Promise of Blob

getSnapshot

• getSnapshot(request): Promise<Mongodb.v1alpha1.Snapshot>

• Get a Database Instance snapshot. Retrieve information about a given snapshot of a Database Instance. You must specify, in the endpoint, the snapshot_id parameter of the snapshot you want to retrieve.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.GetSnapshotRequest>

    The request GetSnapshotRequest

  Returns Promise<Mongodb.v1alpha1.Snapshot>

  A Promise of Snapshot

listInstances

• listInstances(request?): Promise<Mongodb.v1alpha1.ListInstancesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Mongodb.v1alpha1.Instance[], void, void>);
      all: (() => Promise<Mongodb.v1alpha1.Instance[]>);
  }

• List MongoDB® Database Instances. List all MongoDB® Database Instances in the specified region. By default, the MongoDB® Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as tags and name. For the name parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.ListInstancesRequest> = {}

    The request ListInstancesRequest

  Returns Promise<Mongodb.v1alpha1.ListInstancesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Mongodb.v1alpha1.Instance[], void, void>);
      all: (() => Promise<Mongodb.v1alpha1.Instance[]>);
  }

  A Promise of ListInstancesResponse

listNodeTypes

• listNodeTypes(request?): Promise<Mongodb.v1alpha1.ListNodeTypesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Mongodb.v1alpha1.NodeType[], void, void>);
      all: (() => Promise<Mongodb.v1alpha1.NodeType[]>);
  }

• List available node types.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.ListNodeTypesRequest> = {}

    The request ListNodeTypesRequest

  Returns Promise<Mongodb.v1alpha1.ListNodeTypesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Mongodb.v1alpha1.NodeType[], void, void>);
      all: (() => Promise<Mongodb.v1alpha1.NodeType[]>);
  }

  A Promise of ListNodeTypesResponse

listSnapshots

• listSnapshots(request?): Promise<Mongodb.v1alpha1.ListSnapshotsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Mongodb.v1alpha1.Snapshot[], void, void>);
      all: (() => Promise<Mongodb.v1alpha1.Snapshot[]>);
  }

• List snapshots. List snapshots. You can include the instance_id or project_id in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.ListSnapshotsRequest> = {}

    The request ListSnapshotsRequest

  Returns Promise<Mongodb.v1alpha1.ListSnapshotsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Mongodb.v1alpha1.Snapshot[], void, void>);
      all: (() => Promise<Mongodb.v1alpha1.Snapshot[]>);
  }

  A Promise of ListSnapshotsResponse

listUsers

• listUsers(request): Promise<Mongodb.v1alpha1.ListUsersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Mongodb.v1alpha1.User[], void, void>);
      all: (() => Promise<Mongodb.v1alpha1.User[]>);
  }

• List users of a Database Instance. List all users of a given Database Instance.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.ListUsersRequest>

    The request ListUsersRequest

  Returns Promise<Mongodb.v1alpha1.ListUsersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Mongodb.v1alpha1.User[], void, void>);
      all: (() => Promise<Mongodb.v1alpha1.User[]>);
  }

  A Promise of ListUsersResponse

listVersions

• listVersions(request?): Promise<Mongodb.v1alpha1.ListVersionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Mongodb.v1alpha1.Version[], void, void>);
      all: (() => Promise<Mongodb.v1alpha1.Version[]>);
  }

• List available MongoDB® versions.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.ListVersionsRequest> = {}

    The request ListVersionsRequest

  Returns Promise<Mongodb.v1alpha1.ListVersionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Mongodb.v1alpha1.Version[], void, void>);
      all: (() => Promise<Mongodb.v1alpha1.Version[]>);
  }

  A Promise of ListVersionsResponse

restoreSnapshot

• restoreSnapshot(request): Promise<Mongodb.v1alpha1.Instance>

• Restore a Database Instance snapshot. Restore a given snapshot of a Database Instance. You must specify, in the endpoint, the snapshot_id parameter of the snapshot you want to restore, the instance_name of the new Database Instance, node_type of the new Database Instance and node_number of the new Database Instance.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.RestoreSnapshotRequest>

    The request RestoreSnapshotRequest

  Returns Promise<Mongodb.v1alpha1.Instance>

  A Promise of Instance

updateInstance

• updateInstance(request): Promise<Mongodb.v1alpha1.Instance>

• Update a MongoDB® Database Instance. Update the parameters of a MongoDB® Database Instance.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.UpdateInstanceRequest>

    The request UpdateInstanceRequest

  Returns Promise<Mongodb.v1alpha1.Instance>

  A Promise of Instance

updateSnapshot

• updateSnapshot(request): Promise<Mongodb.v1alpha1.Snapshot>

• Update a Database Instance snapshot. Update the parameters of a snapshot of a Database Instance. You can update the name and expires_at parameters.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.UpdateSnapshotRequest>

    The request UpdateSnapshotRequest

  Returns Promise<Mongodb.v1alpha1.Snapshot>

  A Promise of Snapshot

updateUser

• updateUser(request): Promise<Mongodb.v1alpha1.User>

• Update a user on a Database Instance. Update the parameters of a user on a Database Instance. You can update the password parameter, but you cannot change the name of the user.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.UpdateUserRequest>

    The request UpdateUserRequest

  Returns Promise<Mongodb.v1alpha1.User>

  A Promise of User

upgradeInstance

• upgradeInstance(request): Promise<Mongodb.v1alpha1.Instance>

• Upgrade a Database Instance. Upgrade your current Database Instance specifications like volume size.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.UpgradeInstanceRequest>

    The request UpgradeInstanceRequest

  Returns Promise<Mongodb.v1alpha1.Instance>

  A Promise of Instance

waitForInstance

• waitForInstance(request, options?): Promise<Mongodb.v1alpha1.Instance>

• Waits for Instance to be in a final state.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.GetInstanceRequest>

    The request GetInstanceRequest
  • Optionaloptions: Readonly<WaitForOptions<Mongodb.v1alpha1.Instance>>

    The waiting options

  Returns Promise<Mongodb.v1alpha1.Instance>

  A Promise of Instance

waitForSnapshot

• waitForSnapshot(request, options?): Promise<Mongodb.v1alpha1.Snapshot>

• Waits for Snapshot to be in a final state.

  Parameters

  • request: Readonly<Mongodb.v1alpha1.GetSnapshotRequest>

    The request GetSnapshotRequest
  • Optionaloptions: Readonly<WaitForOptions<Mongodb.v1alpha1.Snapshot>>

    The waiting options

  Returns Promise<Mongodb.v1alpha1.Snapshot>

  A Promise of Snapshot