Skip to main content

Class: CloudService

WARNING: This service is currently experimental and may change in incompatible ways.

Extends​

  • Service

Properties​

addNamespaceRegion​

addNamespaceRegion: AddNamespaceRegion

Add a new region to a namespace Deprecated: Use the UpdateNamespace() to add new replica in the namespace spec instead.

addUserGroupMember​

addUserGroupMember: AddUserGroupMember

Add a member to the group, can only be used with Cloud group types.

createAccountAuditLogSink​

createAccountAuditLogSink: CreateAccountAuditLogSink

Create an audit log sink

createApiKey​

createApiKey: CreateApiKey

Create an API key

createBillingReport​

createBillingReport: CreateBillingReport

Create a billing report

createConnectivityRule​

createConnectivityRule: CreateConnectivityRule

Creates a connectivity rule

createCustomRole​

createCustomRole: CreateCustomRole

Create a custom role

createNamespace​

createNamespace: CreateNamespace

Create a new namespace

createNamespaceExportSink​

createNamespaceExportSink: CreateNamespaceExportSink

Create an export sink

createNexusEndpoint​

createNexusEndpoint: CreateNexusEndpoint

Create a nexus endpoint

createServiceAccount​

createServiceAccount: CreateServiceAccount

Create a service account.

createUser​

createUser: CreateUser

Create a user

createUserGroup​

createUserGroup: CreateUserGroup

Create new a user group

deleteAccountAuditLogSink​

deleteAccountAuditLogSink: DeleteAccountAuditLogSink

Delete an audit log sink

deleteApiKey​

deleteApiKey: DeleteApiKey

Delete an API key

deleteConnectivityRule​

deleteConnectivityRule: DeleteConnectivityRule

Deletes a connectivity rule by id

deleteCustomRole​

deleteCustomRole: DeleteCustomRole

Delete a custom role

deleteNamespace​

deleteNamespace: DeleteNamespace

Delete a namespace

deleteNamespaceExportSink​

deleteNamespaceExportSink: DeleteNamespaceExportSink

Delete an export sink

deleteNamespaceRegion​

deleteNamespaceRegion: DeleteNamespaceRegion

Delete a region from a namespace Deprecated: Use the UpdateNamespace() to delete a replica in the namespace spec instead.

deleteNexusEndpoint​

deleteNexusEndpoint: DeleteNexusEndpoint

Delete a nexus endpoint

deleteServiceAccount​

deleteServiceAccount: DeleteServiceAccount

Delete a service account.

deleteUser​

deleteUser: DeleteUser

Delete a user

deleteUserGroup​

deleteUserGroup: DeleteUserGroup

Delete a user group

failoverNamespaceRegion​

failoverNamespaceRegion: FailoverNamespaceRegion

Failover a multi-region namespace

getAccount​

getAccount: GetAccount

Get account information.

getAccountAuditLogSink​

getAccountAuditLogSink: GetAccountAuditLogSink

Get an audit log sink

getAccountAuditLogSinks​

getAccountAuditLogSinks: GetAccountAuditLogSinks

Get audit log sinks

getApiKey​

getApiKey: GetApiKey

Get an API key

getApiKeys​

getApiKeys: GetApiKeys

Get all known API keys

getAsyncOperation​

getAsyncOperation: GetAsyncOperation

Get the latest information on an async operation

getAuditLogs​

getAuditLogs: GetAuditLogs

Get audit logs

getBillingReport​

getBillingReport: GetBillingReport

Get a billing report

getConnectivityRule​

getConnectivityRule: GetConnectivityRule

Gets a connectivity rule by id

getConnectivityRules​

getConnectivityRules: GetConnectivityRules

Lists connectivity rules by account

getCurrentIdentity​

getCurrentIdentity: GetCurrentIdentity

Get information about the current authenticated user or service account principal

getCustomRole​

getCustomRole: GetCustomRole

Get a custom role

getCustomRoles​

getCustomRoles: GetCustomRoles

Get custom roles

getNamespace​

getNamespace: GetNamespace

Get a namespace

getNamespaceCapacityInfo​

getNamespaceCapacityInfo: GetNamespaceCapacityInfo

Get namespace capacity information

getNamespaceExportSink​

getNamespaceExportSink: GetNamespaceExportSink

Get an export sink

getNamespaceExportSinks​

getNamespaceExportSinks: GetNamespaceExportSinks

Get export sinks

getNamespaces​

getNamespaces: GetNamespaces

Get all namespaces

getNexusEndpoint​

getNexusEndpoint: GetNexusEndpoint

Get a nexus endpoint

getNexusEndpoints​

getNexusEndpoints: GetNexusEndpoints

Gets nexus endpoints

getRegion​

getRegion: GetRegion

Get a region

getRegions​

getRegions: GetRegions

Get all regions

getServiceAccount​

getServiceAccount: GetServiceAccount

Get a service account.

getServiceAccountNamespaceAssignments​

getServiceAccountNamespaceAssignments: GetServiceAccountNamespaceAssignments

Get service accounts with access to a namespace

getServiceAccounts​

getServiceAccounts: GetServiceAccounts

Get service accounts.

getUsage​

getUsage: GetUsage

WARNING: Pre-Release Feature Get usage data across namespaces

getUser​

getUser: GetUser

Get a user

getUserGroup​

getUserGroup: GetUserGroup

Get a user group

getUserGroupMembers​

getUserGroupMembers: GetUserGroupMembers

Calls GetUserGroupMembers.

getUserGroupNamespaceAssignments​

getUserGroupNamespaceAssignments: GetUserGroupNamespaceAssignments

Get user groups with access to a namespace

getUserGroups​

getUserGroups: GetUserGroups

Get all user groups

getUserNamespaceAssignments​

getUserNamespaceAssignments: GetUserNamespaceAssignments

Get users with access to a namespace

getUsers​

getUsers: GetUsers

Gets all known users

removeUserGroupMember​

removeUserGroupMember: RemoveUserGroupMember

Remove a member from the group, can only be used with Cloud group types.

renameCustomSearchAttribute​

renameCustomSearchAttribute: RenameCustomSearchAttribute

Rename an existing customer search attribute

requestDelimited​

requestDelimited: boolean

Whether requests are length-delimited.

Inherited from​

$protobuf.rpc.Service.requestDelimited

responseDelimited​

responseDelimited: boolean

Whether responses are length-delimited.

Inherited from​

$protobuf.rpc.Service.responseDelimited

rpcImpl​

rpcImpl: RPCImpl | null

RPC implementation. Becomes null once the service is ended.

Inherited from​

$protobuf.rpc.Service.rpcImpl

setServiceAccountNamespaceAccess​

setServiceAccountNamespaceAccess: SetServiceAccountNamespaceAccess

Set a service account's access to a namespace.

setUserGroupNamespaceAccess​

setUserGroupNamespaceAccess: SetUserGroupNamespaceAccess

Set a user group's access to a namespace

setUserNamespaceAccess​

setUserNamespaceAccess: SetUserNamespaceAccess

Set a user's access to a namespace

updateAccount​

updateAccount: UpdateAccount

Update account information.

updateAccountAuditLogSink​

updateAccountAuditLogSink: UpdateAccountAuditLogSink

Update an audit log sink

updateApiKey​

updateApiKey: UpdateApiKey

Update an API key

updateCustomRole​

updateCustomRole: UpdateCustomRole

Update a custom role

updateNamespace​

updateNamespace: UpdateNamespace

Update a namespace

updateNamespaceExportSink​

updateNamespaceExportSink: UpdateNamespaceExportSink

Update an export sink

updateNamespaceTags​

updateNamespaceTags: UpdateNamespaceTags

Update the tags for a namespace

updateNexusEndpoint​

updateNexusEndpoint: UpdateNexusEndpoint

Update a nexus endpoint

updateServiceAccount​

updateServiceAccount: UpdateServiceAccount

Update a service account.

updateUser​

updateUser: UpdateUser

Update a user

updateUserGroup​

updateUserGroup: UpdateUserGroup

Update a user group

validateAccountAuditLogSink​

validateAccountAuditLogSink: ValidateAccountAuditLogSink

Validate customer audit log sink is accessible from Temporal's workflow by delivering an empty file to the specified sink. The operation verifies that the sink is correctly configured, accessible and ready to receive audit logs.

validateNamespaceExportSink​

validateNamespaceExportSink: ValidateNamespaceExportSink

Validates an export sink configuration by delivering an empty test file to the specified sink. This operation verifies that the sink is correctly configured, accessible, and ready for data export.

Methods​

emit()​

emit(evt, ...args): this

Emits an event by calling its listeners with the specified arguments.

Parameters​

evt​

string

Event name

args​

...any[]

Arguments

Returns​

this

this

Inherited from​

$protobuf.rpc.Service.emit

end()​

end(endedByRPC?): Service

Ends this service and emits the end event.

Parameters​

endedByRPC?​

boolean

Whether the service has been ended by the RPC implementation.

Returns​

Service

this

Inherited from​

$protobuf.rpc.Service.end

off()​

off(evt?, fn?): this

Removes an event listener or any matching listeners if arguments are omitted.

Parameters​

evt?​

string

Event name. Removes all listeners if omitted.

fn?​

EventEmitterListener

Listener to remove. Removes all listeners of evt if omitted.

Returns​

this

this

Inherited from​

$protobuf.rpc.Service.off

on()​

on(evt, fn, ctx?): this

Registers an event listener.

Parameters​

evt​

string

Event name

fn​

EventEmitterListener

Listener

ctx?​

any

Listener context

Returns​

this

this

Inherited from​

$protobuf.rpc.Service.on

rpcCall()​

rpcCall<TReq, TRes>(method, requestCtor, responseCtor, request, callback): void

Calls a service method through rpcImpl.

Type Parameters​

TReq​

TReq extends Message<TReq>

TRes​

TRes extends Message<TRes>

Parameters​

method​

Method | ServiceMethod<TReq, TRes>

Reflected or static method

requestCtor​

Constructor<TReq>

Request constructor

responseCtor​

Constructor<TRes>

Response constructor

request​

TReq | Properties<TReq>

Request message or plain object

callback​

ServiceMethodCallback<TRes>

Service callback

Returns​

void

Inherited from​

$protobuf.rpc.Service.rpcCall

create()​

static create(rpcImpl, requestDelimited?, responseDelimited?): CloudService

Creates new CloudService service using the specified rpc implementation.

Parameters​

rpcImpl​

RPCImpl

RPC implementation

requestDelimited?​

boolean

Whether requests are length-delimited

responseDelimited?​

boolean

Whether responses are length-delimited

Returns​

CloudService

RPC service. Useful where requests and/or responses are streamed.