Class NatsAPI

constructor

• new NatsAPI(client): NatsAPI

• Parameters

  • client: Client

  Returns NatsAPI

Static ReadonlyLOCALITIES

createNatsAccount

• createNatsAccount(request?): Promise<MNQ.v1beta1.NatsAccount>

• Create a NATS account. Create a NATS account associated with a Project.

  Parameters

  • request: Readonly<MNQ.v1beta1.NatsApiCreateNatsAccountRequest> = {}

    The request NatsApiCreateNatsAccountRequest

  Returns Promise<MNQ.v1beta1.NatsAccount>

  A Promise of NatsAccount

createNatsCredentials

• createNatsCredentials(request): Promise<MNQ.v1beta1.NatsCredentials>

• Create NATS credentials. Create a set of credentials for a NATS account, specified by its NATS account ID.

  Parameters

  • request: Readonly<MNQ.v1beta1.NatsApiCreateNatsCredentialsRequest>

    The request NatsApiCreateNatsCredentialsRequest

  Returns Promise<MNQ.v1beta1.NatsCredentials>

  A Promise of NatsCredentials

deleteNatsAccount

• deleteNatsAccount(request): Promise<void>

• Delete a NATS account. Delete a NATS account, specified by its NATS account ID. Note that deleting a NATS account is irreversible, and any credentials, streams, consumer and stored messages belonging to this NATS account will also be deleted.

  Parameters

  • request: Readonly<NatsApiDeleteNatsAccountRequest>

    The request NatsApiDeleteNatsAccountRequest

  Returns Promise<void>

deleteNatsCredentials

• deleteNatsCredentials(request): Promise<void>

• Delete NATS credentials. Delete a set of credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can no longer be used to access the NATS account, and active connections using this credentials will be closed.

  Parameters

  • request: Readonly<NatsApiDeleteNatsCredentialsRequest>

    The request NatsApiDeleteNatsCredentialsRequest

  Returns Promise<void>

getNatsAccount

• getNatsAccount(request): Promise<MNQ.v1beta1.NatsAccount>

• Get a NATS account. Retrieve information about an existing NATS account identified by its NATS account ID. Its full details, including name and endpoint, are returned in the response.

  Parameters

  • request: Readonly<NatsApiGetNatsAccountRequest>

    The request NatsApiGetNatsAccountRequest

  Returns Promise<MNQ.v1beta1.NatsAccount>

  A Promise of NatsAccount

getNatsCredentials

• getNatsCredentials(request): Promise<MNQ.v1beta1.NatsCredentials>

• Get NATS credentials. Retrieve an existing set of credentials, identified by the nats_credentials_id. The credentials themselves are NOT returned, only their metadata (NATS account ID, credentials name, etc), are returned in the response.

  Parameters

  • request: Readonly<NatsApiGetNatsCredentialsRequest>

    The request NatsApiGetNatsCredentialsRequest

  Returns Promise<MNQ.v1beta1.NatsCredentials>

  A Promise of NatsCredentials

listNatsAccounts

• listNatsAccounts(request?): Promise<ListNatsAccountsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<MNQ.v1beta1.NatsAccount[], void, void>);
      all: (() => Promise<MNQ.v1beta1.NatsAccount[]>);
  }

• List NATS accounts. List all NATS accounts in the specified region, for a Scaleway Organization or Project. By default, the NATS accounts 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<NatsApiListNatsAccountsRequest> = {}

    The request NatsApiListNatsAccountsRequest

  Returns Promise<ListNatsAccountsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<MNQ.v1beta1.NatsAccount[], void, void>);
      all: (() => Promise<MNQ.v1beta1.NatsAccount[]>);
  }

  A Promise of ListNatsAccountsResponse

listNatsCredentials

• listNatsCredentials(request?): Promise<ListNatsCredentialsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<MNQ.v1beta1.NatsCredentials[], void, void>);
      all: (() => Promise<MNQ.v1beta1.NatsCredentials[]>);
  }

• List NATS credentials. List existing credentials in the specified NATS account. The response contains only the metadata for the credentials, not the credentials themselves, which are only returned after a Create Credentials call.

  Parameters

  • request: Readonly<NatsApiListNatsCredentialsRequest> = {}

    The request NatsApiListNatsCredentialsRequest

  Returns Promise<ListNatsCredentialsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<MNQ.v1beta1.NatsCredentials[], void, void>);
      all: (() => Promise<MNQ.v1beta1.NatsCredentials[]>);
  }

  A Promise of ListNatsCredentialsResponse

updateNatsAccount

• updateNatsAccount(request): Promise<MNQ.v1beta1.NatsAccount>

• Update the name of a NATS account. Update the name of a NATS account, specified by its NATS account ID.

  Parameters

  • request: Readonly<MNQ.v1beta1.NatsApiUpdateNatsAccountRequest>

    The request NatsApiUpdateNatsAccountRequest

  Returns Promise<MNQ.v1beta1.NatsAccount>

  A Promise of NatsAccount