Skip to main content

Namespace: CloudService

cloudservice.v1.CloudService

Type Aliases​

AddNamespaceRegion​

Ƭ AddNamespaceRegion: Object

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

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIAddNamespaceRegionRequest
callbackAddNamespaceRegionCallback
Returns​

void

▸ (request): Promise<AddNamespaceRegionResponse>

Parameters​
NameType
requestIAddNamespaceRegionRequest
Returns​

Promise<AddNamespaceRegionResponse>

Type declaration​

NameType
name"AddNamespaceRegion"
path"/temporal.api.cloud.cloudservice.v1.CloudService/AddNamespaceRegion"
requestStreamundefined
requestType"AddNamespaceRegionRequest"
responseStreamundefined
responseType"AddNamespaceRegionResponse"

AddNamespaceRegionCallback​

Ƭ AddNamespaceRegionCallback: (error: Error | null, response?: AddNamespaceRegionResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#addNamespaceRegion.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?AddNamespaceRegionResponseAddNamespaceRegionResponse
Returns​

void


AddUserGroupMember​

Ƭ AddUserGroupMember: Object

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

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIAddUserGroupMemberRequest
callbackAddUserGroupMemberCallback
Returns​

void

▸ (request): Promise<AddUserGroupMemberResponse>

Parameters​
NameType
requestIAddUserGroupMemberRequest
Returns​

Promise<AddUserGroupMemberResponse>

Type declaration​

NameType
name"AddUserGroupMember"
path"/temporal.api.cloud.cloudservice.v1.CloudService/AddUserGroupMember"
requestStreamundefined
requestType"AddUserGroupMemberRequest"
responseStreamundefined
responseType"AddUserGroupMemberResponse"

AddUserGroupMemberCallback​

Ƭ AddUserGroupMemberCallback: (error: Error | null, response?: AddUserGroupMemberResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#addUserGroupMember.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?AddUserGroupMemberResponseAddUserGroupMemberResponse
Returns​

void


CreateAccountAuditLogSink​

Ƭ CreateAccountAuditLogSink: Object

Create an audit log sink

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestICreateAccountAuditLogSinkRequest
callbackCreateAccountAuditLogSinkCallback
Returns​

void

▸ (request): Promise<CreateAccountAuditLogSinkResponse>

Parameters​
NameType
requestICreateAccountAuditLogSinkRequest
Returns​

Promise<CreateAccountAuditLogSinkResponse>

Type declaration​

NameType
name"CreateAccountAuditLogSink"
path"/temporal.api.cloud.cloudservice.v1.CloudService/CreateAccountAuditLogSink"
requestStreamundefined
requestType"CreateAccountAuditLogSinkRequest"
responseStreamundefined
responseType"CreateAccountAuditLogSinkResponse"

CreateAccountAuditLogSinkCallback​

Ƭ CreateAccountAuditLogSinkCallback: (error: Error | null, response?: CreateAccountAuditLogSinkResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#createAccountAuditLogSink.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?CreateAccountAuditLogSinkResponseCreateAccountAuditLogSinkResponse
Returns​

void


CreateApiKey​

Ƭ CreateApiKey: Object

Create an API key

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestICreateApiKeyRequest
callbackCreateApiKeyCallback
Returns​

void

▸ (request): Promise<CreateApiKeyResponse>

Parameters​
NameType
requestICreateApiKeyRequest
Returns​

Promise<CreateApiKeyResponse>

Type declaration​

NameType
name"CreateApiKey"
path"/temporal.api.cloud.cloudservice.v1.CloudService/CreateApiKey"
requestStreamundefined
requestType"CreateApiKeyRequest"
responseStreamundefined
responseType"CreateApiKeyResponse"

CreateApiKeyCallback​

Ƭ CreateApiKeyCallback: (error: Error | null, response?: CreateApiKeyResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#createApiKey.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?CreateApiKeyResponseCreateApiKeyResponse
Returns​

void


CreateBillingReport​

Ƭ CreateBillingReport: Object

Create a billing report

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestICreateBillingReportRequest
callbackCreateBillingReportCallback
Returns​

void

▸ (request): Promise<CreateBillingReportResponse>

Parameters​
NameType
requestICreateBillingReportRequest
Returns​

Promise<CreateBillingReportResponse>

Type declaration​

NameType
name"CreateBillingReport"
path"/temporal.api.cloud.cloudservice.v1.CloudService/CreateBillingReport"
requestStreamundefined
requestType"CreateBillingReportRequest"
responseStreamundefined
responseType"CreateBillingReportResponse"

CreateBillingReportCallback​

Ƭ CreateBillingReportCallback: (error: Error | null, response?: CreateBillingReportResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#createBillingReport.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?CreateBillingReportResponseCreateBillingReportResponse
Returns​

void


CreateConnectivityRule​

Ƭ CreateConnectivityRule: Object

Creates a connectivity rule

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestICreateConnectivityRuleRequest
callbackCreateConnectivityRuleCallback
Returns​

void

▸ (request): Promise<CreateConnectivityRuleResponse>

Parameters​
NameType
requestICreateConnectivityRuleRequest
Returns​

Promise<CreateConnectivityRuleResponse>

Type declaration​

NameType
name"CreateConnectivityRule"
path"/temporal.api.cloud.cloudservice.v1.CloudService/CreateConnectivityRule"
requestStreamundefined
requestType"CreateConnectivityRuleRequest"
responseStreamundefined
responseType"CreateConnectivityRuleResponse"

CreateConnectivityRuleCallback​

Ƭ CreateConnectivityRuleCallback: (error: Error | null, response?: CreateConnectivityRuleResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#createConnectivityRule.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?CreateConnectivityRuleResponseCreateConnectivityRuleResponse
Returns​

void


CreateCustomRole​

Ƭ CreateCustomRole: Object

Create a custom role

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestICreateCustomRoleRequest
callbackCreateCustomRoleCallback
Returns​

void

▸ (request): Promise<CreateCustomRoleResponse>

Parameters​
NameType
requestICreateCustomRoleRequest
Returns​

Promise<CreateCustomRoleResponse>

Type declaration​

NameType
name"CreateCustomRole"
path"/temporal.api.cloud.cloudservice.v1.CloudService/CreateCustomRole"
requestStreamundefined
requestType"CreateCustomRoleRequest"
responseStreamundefined
responseType"CreateCustomRoleResponse"

CreateCustomRoleCallback​

Ƭ CreateCustomRoleCallback: (error: Error | null, response?: CreateCustomRoleResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#createCustomRole.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?CreateCustomRoleResponseCreateCustomRoleResponse
Returns​

void


CreateNamespace​

Ƭ CreateNamespace: Object

Create a new namespace

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestICreateNamespaceRequest
callbackCreateNamespaceCallback
Returns​

void

▸ (request): Promise<CreateNamespaceResponse>

Parameters​
NameType
requestICreateNamespaceRequest
Returns​

Promise<CreateNamespaceResponse>

Type declaration​

NameType
name"CreateNamespace"
path"/temporal.api.cloud.cloudservice.v1.CloudService/CreateNamespace"
requestStreamundefined
requestType"CreateNamespaceRequest"
responseStreamundefined
responseType"CreateNamespaceResponse"

CreateNamespaceCallback​

Ƭ CreateNamespaceCallback: (error: Error | null, response?: CreateNamespaceResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#createNamespace.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?CreateNamespaceResponseCreateNamespaceResponse
Returns​

void


CreateNamespaceExportSink​

Ƭ CreateNamespaceExportSink: Object

Create an export sink

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestICreateNamespaceExportSinkRequest
callbackCreateNamespaceExportSinkCallback
Returns​

void

▸ (request): Promise<CreateNamespaceExportSinkResponse>

Parameters​
NameType
requestICreateNamespaceExportSinkRequest
Returns​

Promise<CreateNamespaceExportSinkResponse>

Type declaration​

NameType
name"CreateNamespaceExportSink"
path"/temporal.api.cloud.cloudservice.v1.CloudService/CreateNamespaceExportSink"
requestStreamundefined
requestType"CreateNamespaceExportSinkRequest"
responseStreamundefined
responseType"CreateNamespaceExportSinkResponse"

CreateNamespaceExportSinkCallback​

Ƭ CreateNamespaceExportSinkCallback: (error: Error | null, response?: CreateNamespaceExportSinkResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#createNamespaceExportSink.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?CreateNamespaceExportSinkResponseCreateNamespaceExportSinkResponse
Returns​

void


CreateNexusEndpoint​

Ƭ CreateNexusEndpoint: Object

Create a nexus endpoint

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestICreateNexusEndpointRequest
callbackCreateNexusEndpointCallback
Returns​

void

▸ (request): Promise<CreateNexusEndpointResponse>

Parameters​
NameType
requestICreateNexusEndpointRequest
Returns​

Promise<CreateNexusEndpointResponse>

Type declaration​

NameType
name"CreateNexusEndpoint"
path"/temporal.api.cloud.cloudservice.v1.CloudService/CreateNexusEndpoint"
requestStreamundefined
requestType"CreateNexusEndpointRequest"
responseStreamundefined
responseType"CreateNexusEndpointResponse"

CreateNexusEndpointCallback​

Ƭ CreateNexusEndpointCallback: (error: Error | null, response?: CreateNexusEndpointResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#createNexusEndpoint.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?CreateNexusEndpointResponseCreateNexusEndpointResponse
Returns​

void


CreateServiceAccount​

Ƭ CreateServiceAccount: Object

Create a service account.

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestICreateServiceAccountRequest
callbackCreateServiceAccountCallback
Returns​

void

▸ (request): Promise<CreateServiceAccountResponse>

Parameters​
NameType
requestICreateServiceAccountRequest
Returns​

Promise<CreateServiceAccountResponse>

Type declaration​

NameType
name"CreateServiceAccount"
path"/temporal.api.cloud.cloudservice.v1.CloudService/CreateServiceAccount"
requestStreamundefined
requestType"CreateServiceAccountRequest"
responseStreamundefined
responseType"CreateServiceAccountResponse"

CreateServiceAccountCallback​

Ƭ CreateServiceAccountCallback: (error: Error | null, response?: CreateServiceAccountResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#createServiceAccount.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?CreateServiceAccountResponseCreateServiceAccountResponse
Returns​

void


CreateUser​

Ƭ CreateUser: Object

Create a user

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestICreateUserRequest
callbackCreateUserCallback
Returns​

void

▸ (request): Promise<CreateUserResponse>

Parameters​
NameType
requestICreateUserRequest
Returns​

Promise<CreateUserResponse>

Type declaration​

NameType
name"CreateUser"
path"/temporal.api.cloud.cloudservice.v1.CloudService/CreateUser"
requestStreamundefined
requestType"CreateUserRequest"
responseStreamundefined
responseType"CreateUserResponse"

CreateUserCallback​

Ƭ CreateUserCallback: (error: Error | null, response?: CreateUserResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#createUser.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?CreateUserResponseCreateUserResponse
Returns​

void


CreateUserGroup​

Ƭ CreateUserGroup: Object

Create new a user group

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestICreateUserGroupRequest
callbackCreateUserGroupCallback
Returns​

void

▸ (request): Promise<CreateUserGroupResponse>

Parameters​
NameType
requestICreateUserGroupRequest
Returns​

Promise<CreateUserGroupResponse>

Type declaration​

NameType
name"CreateUserGroup"
path"/temporal.api.cloud.cloudservice.v1.CloudService/CreateUserGroup"
requestStreamundefined
requestType"CreateUserGroupRequest"
responseStreamundefined
responseType"CreateUserGroupResponse"

CreateUserGroupCallback​

Ƭ CreateUserGroupCallback: (error: Error | null, response?: CreateUserGroupResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#createUserGroup.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?CreateUserGroupResponseCreateUserGroupResponse
Returns​

void


DeleteAccountAuditLogSink​

Ƭ DeleteAccountAuditLogSink: Object

Delete an audit log sink

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIDeleteAccountAuditLogSinkRequest
callbackDeleteAccountAuditLogSinkCallback
Returns​

void

▸ (request): Promise<DeleteAccountAuditLogSinkResponse>

Parameters​
NameType
requestIDeleteAccountAuditLogSinkRequest
Returns​

Promise<DeleteAccountAuditLogSinkResponse>

Type declaration​

NameType
name"DeleteAccountAuditLogSink"
path"/temporal.api.cloud.cloudservice.v1.CloudService/DeleteAccountAuditLogSink"
requestStreamundefined
requestType"DeleteAccountAuditLogSinkRequest"
responseStreamundefined
responseType"DeleteAccountAuditLogSinkResponse"

DeleteAccountAuditLogSinkCallback​

Ƭ DeleteAccountAuditLogSinkCallback: (error: Error | null, response?: DeleteAccountAuditLogSinkResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#deleteAccountAuditLogSink.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?DeleteAccountAuditLogSinkResponseDeleteAccountAuditLogSinkResponse
Returns​

void


DeleteApiKey​

Ƭ DeleteApiKey: Object

Delete an API key

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIDeleteApiKeyRequest
callbackDeleteApiKeyCallback
Returns​

void

▸ (request): Promise<DeleteApiKeyResponse>

Parameters​
NameType
requestIDeleteApiKeyRequest
Returns​

Promise<DeleteApiKeyResponse>

Type declaration​

NameType
name"DeleteApiKey"
path"/temporal.api.cloud.cloudservice.v1.CloudService/DeleteApiKey"
requestStreamundefined
requestType"DeleteApiKeyRequest"
responseStreamundefined
responseType"DeleteApiKeyResponse"

DeleteApiKeyCallback​

Ƭ DeleteApiKeyCallback: (error: Error | null, response?: DeleteApiKeyResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#deleteApiKey.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?DeleteApiKeyResponseDeleteApiKeyResponse
Returns​

void


DeleteConnectivityRule​

Ƭ DeleteConnectivityRule: Object

Deletes a connectivity rule by id

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIDeleteConnectivityRuleRequest
callbackDeleteConnectivityRuleCallback
Returns​

void

▸ (request): Promise<DeleteConnectivityRuleResponse>

Parameters​
NameType
requestIDeleteConnectivityRuleRequest
Returns​

Promise<DeleteConnectivityRuleResponse>

Type declaration​

NameType
name"DeleteConnectivityRule"
path"/temporal.api.cloud.cloudservice.v1.CloudService/DeleteConnectivityRule"
requestStreamundefined
requestType"DeleteConnectivityRuleRequest"
responseStreamundefined
responseType"DeleteConnectivityRuleResponse"

DeleteConnectivityRuleCallback​

Ƭ DeleteConnectivityRuleCallback: (error: Error | null, response?: DeleteConnectivityRuleResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#deleteConnectivityRule.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?DeleteConnectivityRuleResponseDeleteConnectivityRuleResponse
Returns​

void


DeleteCustomRole​

Ƭ DeleteCustomRole: Object

Delete a custom role

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIDeleteCustomRoleRequest
callbackDeleteCustomRoleCallback
Returns​

void

▸ (request): Promise<DeleteCustomRoleResponse>

Parameters​
NameType
requestIDeleteCustomRoleRequest
Returns​

Promise<DeleteCustomRoleResponse>

Type declaration​

NameType
name"DeleteCustomRole"
path"/temporal.api.cloud.cloudservice.v1.CloudService/DeleteCustomRole"
requestStreamundefined
requestType"DeleteCustomRoleRequest"
responseStreamundefined
responseType"DeleteCustomRoleResponse"

DeleteCustomRoleCallback​

Ƭ DeleteCustomRoleCallback: (error: Error | null, response?: DeleteCustomRoleResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#deleteCustomRole.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?DeleteCustomRoleResponseDeleteCustomRoleResponse
Returns​

void


DeleteNamespace​

Ƭ DeleteNamespace: Object

Delete a namespace

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIDeleteNamespaceRequest
callbackDeleteNamespaceCallback
Returns​

void

▸ (request): Promise<DeleteNamespaceResponse>

Parameters​
NameType
requestIDeleteNamespaceRequest
Returns​

Promise<DeleteNamespaceResponse>

Type declaration​

NameType
name"DeleteNamespace"
path"/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNamespace"
requestStreamundefined
requestType"DeleteNamespaceRequest"
responseStreamundefined
responseType"DeleteNamespaceResponse"

DeleteNamespaceCallback​

Ƭ DeleteNamespaceCallback: (error: Error | null, response?: DeleteNamespaceResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#deleteNamespace.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?DeleteNamespaceResponseDeleteNamespaceResponse
Returns​

void


DeleteNamespaceExportSink​

Ƭ DeleteNamespaceExportSink: Object

Delete an export sink

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIDeleteNamespaceExportSinkRequest
callbackDeleteNamespaceExportSinkCallback
Returns​

void

▸ (request): Promise<DeleteNamespaceExportSinkResponse>

Parameters​
NameType
requestIDeleteNamespaceExportSinkRequest
Returns​

Promise<DeleteNamespaceExportSinkResponse>

Type declaration​

NameType
name"DeleteNamespaceExportSink"
path"/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNamespaceExportSink"
requestStreamundefined
requestType"DeleteNamespaceExportSinkRequest"
responseStreamundefined
responseType"DeleteNamespaceExportSinkResponse"

DeleteNamespaceExportSinkCallback​

Ƭ DeleteNamespaceExportSinkCallback: (error: Error | null, response?: DeleteNamespaceExportSinkResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#deleteNamespaceExportSink.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?DeleteNamespaceExportSinkResponseDeleteNamespaceExportSinkResponse
Returns​

void


DeleteNamespaceRegion​

Ƭ DeleteNamespaceRegion: Object

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

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIDeleteNamespaceRegionRequest
callbackDeleteNamespaceRegionCallback
Returns​

void

▸ (request): Promise<DeleteNamespaceRegionResponse>

Parameters​
NameType
requestIDeleteNamespaceRegionRequest
Returns​

Promise<DeleteNamespaceRegionResponse>

Type declaration​

NameType
name"DeleteNamespaceRegion"
path"/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNamespaceRegion"
requestStreamundefined
requestType"DeleteNamespaceRegionRequest"
responseStreamundefined
responseType"DeleteNamespaceRegionResponse"

DeleteNamespaceRegionCallback​

Ƭ DeleteNamespaceRegionCallback: (error: Error | null, response?: DeleteNamespaceRegionResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#deleteNamespaceRegion.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?DeleteNamespaceRegionResponseDeleteNamespaceRegionResponse
Returns​

void


DeleteNexusEndpoint​

Ƭ DeleteNexusEndpoint: Object

Delete a nexus endpoint

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIDeleteNexusEndpointRequest
callbackDeleteNexusEndpointCallback
Returns​

void

▸ (request): Promise<DeleteNexusEndpointResponse>

Parameters​
NameType
requestIDeleteNexusEndpointRequest
Returns​

Promise<DeleteNexusEndpointResponse>

Type declaration​

NameType
name"DeleteNexusEndpoint"
path"/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNexusEndpoint"
requestStreamundefined
requestType"DeleteNexusEndpointRequest"
responseStreamundefined
responseType"DeleteNexusEndpointResponse"

DeleteNexusEndpointCallback​

Ƭ DeleteNexusEndpointCallback: (error: Error | null, response?: DeleteNexusEndpointResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#deleteNexusEndpoint.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?DeleteNexusEndpointResponseDeleteNexusEndpointResponse
Returns​

void


DeleteServiceAccount​

Ƭ DeleteServiceAccount: Object

Delete a service account.

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIDeleteServiceAccountRequest
callbackDeleteServiceAccountCallback
Returns​

void

▸ (request): Promise<DeleteServiceAccountResponse>

Parameters​
NameType
requestIDeleteServiceAccountRequest
Returns​

Promise<DeleteServiceAccountResponse>

Type declaration​

NameType
name"DeleteServiceAccount"
path"/temporal.api.cloud.cloudservice.v1.CloudService/DeleteServiceAccount"
requestStreamundefined
requestType"DeleteServiceAccountRequest"
responseStreamundefined
responseType"DeleteServiceAccountResponse"

DeleteServiceAccountCallback​

Ƭ DeleteServiceAccountCallback: (error: Error | null, response?: DeleteServiceAccountResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#deleteServiceAccount.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?DeleteServiceAccountResponseDeleteServiceAccountResponse
Returns​

void


DeleteUser​

Ƭ DeleteUser: Object

Delete a user

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIDeleteUserRequest
callbackDeleteUserCallback
Returns​

void

▸ (request): Promise<DeleteUserResponse>

Parameters​
NameType
requestIDeleteUserRequest
Returns​

Promise<DeleteUserResponse>

Type declaration​

NameType
name"DeleteUser"
path"/temporal.api.cloud.cloudservice.v1.CloudService/DeleteUser"
requestStreamundefined
requestType"DeleteUserRequest"
responseStreamundefined
responseType"DeleteUserResponse"

DeleteUserCallback​

Ƭ DeleteUserCallback: (error: Error | null, response?: DeleteUserResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#deleteUser.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?DeleteUserResponseDeleteUserResponse
Returns​

void


DeleteUserGroup​

Ƭ DeleteUserGroup: Object

Delete a user group

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIDeleteUserGroupRequest
callbackDeleteUserGroupCallback
Returns​

void

▸ (request): Promise<DeleteUserGroupResponse>

Parameters​
NameType
requestIDeleteUserGroupRequest
Returns​

Promise<DeleteUserGroupResponse>

Type declaration​

NameType
name"DeleteUserGroup"
path"/temporal.api.cloud.cloudservice.v1.CloudService/DeleteUserGroup"
requestStreamundefined
requestType"DeleteUserGroupRequest"
responseStreamundefined
responseType"DeleteUserGroupResponse"

DeleteUserGroupCallback​

Ƭ DeleteUserGroupCallback: (error: Error | null, response?: DeleteUserGroupResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#deleteUserGroup.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?DeleteUserGroupResponseDeleteUserGroupResponse
Returns​

void


FailoverNamespaceRegion​

Ƭ FailoverNamespaceRegion: Object

Failover a multi-region namespace

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIFailoverNamespaceRegionRequest
callbackFailoverNamespaceRegionCallback
Returns​

void

▸ (request): Promise<FailoverNamespaceRegionResponse>

Parameters​
NameType
requestIFailoverNamespaceRegionRequest
Returns​

Promise<FailoverNamespaceRegionResponse>

Type declaration​

NameType
name"FailoverNamespaceRegion"
path"/temporal.api.cloud.cloudservice.v1.CloudService/FailoverNamespaceRegion"
requestStreamundefined
requestType"FailoverNamespaceRegionRequest"
responseStreamundefined
responseType"FailoverNamespaceRegionResponse"

FailoverNamespaceRegionCallback​

Ƭ FailoverNamespaceRegionCallback: (error: Error | null, response?: FailoverNamespaceRegionResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#failoverNamespaceRegion.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?FailoverNamespaceRegionResponseFailoverNamespaceRegionResponse
Returns​

void


GetAccount​

Ƭ GetAccount: Object

Get account information.

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetAccountRequest
callbackGetAccountCallback
Returns​

void

▸ (request): Promise<GetAccountResponse>

Parameters​
NameType
requestIGetAccountRequest
Returns​

Promise<GetAccountResponse>

Type declaration​

NameType
name"GetAccount"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetAccount"
requestStreamundefined
requestType"GetAccountRequest"
responseStreamundefined
responseType"GetAccountResponse"

GetAccountAuditLogSink​

Ƭ GetAccountAuditLogSink: Object

Get an audit log sink

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetAccountAuditLogSinkRequest
callbackGetAccountAuditLogSinkCallback
Returns​

void

▸ (request): Promise<GetAccountAuditLogSinkResponse>

Parameters​
NameType
requestIGetAccountAuditLogSinkRequest
Returns​

Promise<GetAccountAuditLogSinkResponse>

Type declaration​

NameType
name"GetAccountAuditLogSink"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetAccountAuditLogSink"
requestStreamundefined
requestType"GetAccountAuditLogSinkRequest"
responseStreamundefined
responseType"GetAccountAuditLogSinkResponse"

GetAccountAuditLogSinkCallback​

Ƭ GetAccountAuditLogSinkCallback: (error: Error | null, response?: GetAccountAuditLogSinkResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getAccountAuditLogSink.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetAccountAuditLogSinkResponseGetAccountAuditLogSinkResponse
Returns​

void


GetAccountAuditLogSinks​

Ƭ GetAccountAuditLogSinks: Object

Get audit log sinks

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetAccountAuditLogSinksRequest
callbackGetAccountAuditLogSinksCallback
Returns​

void

▸ (request): Promise<GetAccountAuditLogSinksResponse>

Parameters​
NameType
requestIGetAccountAuditLogSinksRequest
Returns​

Promise<GetAccountAuditLogSinksResponse>

Type declaration​

NameType
name"GetAccountAuditLogSinks"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetAccountAuditLogSinks"
requestStreamundefined
requestType"GetAccountAuditLogSinksRequest"
responseStreamundefined
responseType"GetAccountAuditLogSinksResponse"

GetAccountAuditLogSinksCallback​

Ƭ GetAccountAuditLogSinksCallback: (error: Error | null, response?: GetAccountAuditLogSinksResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getAccountAuditLogSinks.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetAccountAuditLogSinksResponseGetAccountAuditLogSinksResponse
Returns​

void


GetAccountCallback​

Ƭ GetAccountCallback: (error: Error | null, response?: GetAccountResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getAccount.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetAccountResponseGetAccountResponse
Returns​

void


GetApiKey​

Ƭ GetApiKey: Object

Get an API key

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetApiKeyRequest
callbackGetApiKeyCallback
Returns​

void

▸ (request): Promise<GetApiKeyResponse>

Parameters​
NameType
requestIGetApiKeyRequest
Returns​

Promise<GetApiKeyResponse>

Type declaration​

NameType
name"GetApiKey"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetApiKey"
requestStreamundefined
requestType"GetApiKeyRequest"
responseStreamundefined
responseType"GetApiKeyResponse"

GetApiKeyCallback​

Ƭ GetApiKeyCallback: (error: Error | null, response?: GetApiKeyResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getApiKey.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetApiKeyResponseGetApiKeyResponse
Returns​

void


GetApiKeys​

Ƭ GetApiKeys: Object

Get all known API keys

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetApiKeysRequest
callbackGetApiKeysCallback
Returns​

void

▸ (request): Promise<GetApiKeysResponse>

Parameters​
NameType
requestIGetApiKeysRequest
Returns​

Promise<GetApiKeysResponse>

Type declaration​

NameType
name"GetApiKeys"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetApiKeys"
requestStreamundefined
requestType"GetApiKeysRequest"
responseStreamundefined
responseType"GetApiKeysResponse"

GetApiKeysCallback​

Ƭ GetApiKeysCallback: (error: Error | null, response?: GetApiKeysResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getApiKeys.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetApiKeysResponseGetApiKeysResponse
Returns​

void


GetAsyncOperation​

Ƭ GetAsyncOperation: Object

Get the latest information on an async operation

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetAsyncOperationRequest
callbackGetAsyncOperationCallback
Returns​

void

▸ (request): Promise<GetAsyncOperationResponse>

Parameters​
NameType
requestIGetAsyncOperationRequest
Returns​

Promise<GetAsyncOperationResponse>

Type declaration​

NameType
name"GetAsyncOperation"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetAsyncOperation"
requestStreamundefined
requestType"GetAsyncOperationRequest"
responseStreamundefined
responseType"GetAsyncOperationResponse"

GetAsyncOperationCallback​

Ƭ GetAsyncOperationCallback: (error: Error | null, response?: GetAsyncOperationResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getAsyncOperation.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetAsyncOperationResponseGetAsyncOperationResponse
Returns​

void


GetAuditLogs​

Ƭ GetAuditLogs: Object

Get audit logs

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetAuditLogsRequest
callbackGetAuditLogsCallback
Returns​

void

▸ (request): Promise<GetAuditLogsResponse>

Parameters​
NameType
requestIGetAuditLogsRequest
Returns​

Promise<GetAuditLogsResponse>

Type declaration​

NameType
name"GetAuditLogs"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetAuditLogs"
requestStreamundefined
requestType"GetAuditLogsRequest"
responseStreamundefined
responseType"GetAuditLogsResponse"

GetAuditLogsCallback​

Ƭ GetAuditLogsCallback: (error: Error | null, response?: GetAuditLogsResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getAuditLogs.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetAuditLogsResponseGetAuditLogsResponse
Returns​

void


GetBillingReport​

Ƭ GetBillingReport: Object

Get a billing report

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetBillingReportRequest
callbackGetBillingReportCallback
Returns​

void

▸ (request): Promise<GetBillingReportResponse>

Parameters​
NameType
requestIGetBillingReportRequest
Returns​

Promise<GetBillingReportResponse>

Type declaration​

NameType
name"GetBillingReport"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetBillingReport"
requestStreamundefined
requestType"GetBillingReportRequest"
responseStreamundefined
responseType"GetBillingReportResponse"

GetBillingReportCallback​

Ƭ GetBillingReportCallback: (error: Error | null, response?: GetBillingReportResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getBillingReport.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetBillingReportResponseGetBillingReportResponse
Returns​

void


GetConnectivityRule​

Ƭ GetConnectivityRule: Object

Gets a connectivity rule by id

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetConnectivityRuleRequest
callbackGetConnectivityRuleCallback
Returns​

void

▸ (request): Promise<GetConnectivityRuleResponse>

Parameters​
NameType
requestIGetConnectivityRuleRequest
Returns​

Promise<GetConnectivityRuleResponse>

Type declaration​

NameType
name"GetConnectivityRule"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetConnectivityRule"
requestStreamundefined
requestType"GetConnectivityRuleRequest"
responseStreamundefined
responseType"GetConnectivityRuleResponse"

GetConnectivityRuleCallback​

Ƭ GetConnectivityRuleCallback: (error: Error | null, response?: GetConnectivityRuleResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getConnectivityRule.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetConnectivityRuleResponseGetConnectivityRuleResponse
Returns​

void


GetConnectivityRules​

Ƭ GetConnectivityRules: Object

Lists connectivity rules by account

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetConnectivityRulesRequest
callbackGetConnectivityRulesCallback
Returns​

void

▸ (request): Promise<GetConnectivityRulesResponse>

Parameters​
NameType
requestIGetConnectivityRulesRequest
Returns​

Promise<GetConnectivityRulesResponse>

Type declaration​

NameType
name"GetConnectivityRules"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetConnectivityRules"
requestStreamundefined
requestType"GetConnectivityRulesRequest"
responseStreamundefined
responseType"GetConnectivityRulesResponse"

GetConnectivityRulesCallback​

Ƭ GetConnectivityRulesCallback: (error: Error | null, response?: GetConnectivityRulesResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getConnectivityRules.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetConnectivityRulesResponseGetConnectivityRulesResponse
Returns​

void


GetCurrentIdentity​

Ƭ GetCurrentIdentity: Object

Get information about the current authenticated user or service account principal

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetCurrentIdentityRequest
callbackGetCurrentIdentityCallback
Returns​

void

▸ (request): Promise<GetCurrentIdentityResponse>

Parameters​
NameType
requestIGetCurrentIdentityRequest
Returns​

Promise<GetCurrentIdentityResponse>

Type declaration​

NameType
name"GetCurrentIdentity"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetCurrentIdentity"
requestStreamundefined
requestType"GetCurrentIdentityRequest"
responseStreamundefined
responseType"GetCurrentIdentityResponse"

GetCurrentIdentityCallback​

Ƭ GetCurrentIdentityCallback: (error: Error | null, response?: GetCurrentIdentityResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getCurrentIdentity.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetCurrentIdentityResponseGetCurrentIdentityResponse
Returns​

void


GetCustomRole​

Ƭ GetCustomRole: Object

Get a custom role

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetCustomRoleRequest
callbackGetCustomRoleCallback
Returns​

void

▸ (request): Promise<GetCustomRoleResponse>

Parameters​
NameType
requestIGetCustomRoleRequest
Returns​

Promise<GetCustomRoleResponse>

Type declaration​

NameType
name"GetCustomRole"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetCustomRole"
requestStreamundefined
requestType"GetCustomRoleRequest"
responseStreamundefined
responseType"GetCustomRoleResponse"

GetCustomRoleCallback​

Ƭ GetCustomRoleCallback: (error: Error | null, response?: GetCustomRoleResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getCustomRole.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetCustomRoleResponseGetCustomRoleResponse
Returns​

void


GetCustomRoles​

Ƭ GetCustomRoles: Object

Get custom roles

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetCustomRolesRequest
callbackGetCustomRolesCallback
Returns​

void

▸ (request): Promise<GetCustomRolesResponse>

Parameters​
NameType
requestIGetCustomRolesRequest
Returns​

Promise<GetCustomRolesResponse>

Type declaration​

NameType
name"GetCustomRoles"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetCustomRoles"
requestStreamundefined
requestType"GetCustomRolesRequest"
responseStreamundefined
responseType"GetCustomRolesResponse"

GetCustomRolesCallback​

Ƭ GetCustomRolesCallback: (error: Error | null, response?: GetCustomRolesResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getCustomRoles.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetCustomRolesResponseGetCustomRolesResponse
Returns​

void


GetNamespace​

Ƭ GetNamespace: Object

Get a namespace

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetNamespaceRequest
callbackGetNamespaceCallback
Returns​

void

▸ (request): Promise<GetNamespaceResponse>

Parameters​
NameType
requestIGetNamespaceRequest
Returns​

Promise<GetNamespaceResponse>

Type declaration​

NameType
name"GetNamespace"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespace"
requestStreamundefined
requestType"GetNamespaceRequest"
responseStreamundefined
responseType"GetNamespaceResponse"

GetNamespaceCallback​

Ƭ GetNamespaceCallback: (error: Error | null, response?: GetNamespaceResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getNamespace.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetNamespaceResponseGetNamespaceResponse
Returns​

void


GetNamespaceCapacityInfo​

Ƭ GetNamespaceCapacityInfo: Object

Get namespace capacity information

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetNamespaceCapacityInfoRequest
callbackGetNamespaceCapacityInfoCallback
Returns​

void

▸ (request): Promise<GetNamespaceCapacityInfoResponse>

Parameters​
NameType
requestIGetNamespaceCapacityInfoRequest
Returns​

Promise<GetNamespaceCapacityInfoResponse>

Type declaration​

NameType
name"GetNamespaceCapacityInfo"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaceCapacityInfo"
requestStreamundefined
requestType"GetNamespaceCapacityInfoRequest"
responseStreamundefined
responseType"GetNamespaceCapacityInfoResponse"

GetNamespaceCapacityInfoCallback​

Ƭ GetNamespaceCapacityInfoCallback: (error: Error | null, response?: GetNamespaceCapacityInfoResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getNamespaceCapacityInfo.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetNamespaceCapacityInfoResponseGetNamespaceCapacityInfoResponse
Returns​

void


GetNamespaceExportSink​

Ƭ GetNamespaceExportSink: Object

Get an export sink

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetNamespaceExportSinkRequest
callbackGetNamespaceExportSinkCallback
Returns​

void

▸ (request): Promise<GetNamespaceExportSinkResponse>

Parameters​
NameType
requestIGetNamespaceExportSinkRequest
Returns​

Promise<GetNamespaceExportSinkResponse>

Type declaration​

NameType
name"GetNamespaceExportSink"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaceExportSink"
requestStreamundefined
requestType"GetNamespaceExportSinkRequest"
responseStreamundefined
responseType"GetNamespaceExportSinkResponse"

GetNamespaceExportSinkCallback​

Ƭ GetNamespaceExportSinkCallback: (error: Error | null, response?: GetNamespaceExportSinkResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getNamespaceExportSink.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetNamespaceExportSinkResponseGetNamespaceExportSinkResponse
Returns​

void


GetNamespaceExportSinks​

Ƭ GetNamespaceExportSinks: Object

Get export sinks

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetNamespaceExportSinksRequest
callbackGetNamespaceExportSinksCallback
Returns​

void

▸ (request): Promise<GetNamespaceExportSinksResponse>

Parameters​
NameType
requestIGetNamespaceExportSinksRequest
Returns​

Promise<GetNamespaceExportSinksResponse>

Type declaration​

NameType
name"GetNamespaceExportSinks"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaceExportSinks"
requestStreamundefined
requestType"GetNamespaceExportSinksRequest"
responseStreamundefined
responseType"GetNamespaceExportSinksResponse"

GetNamespaceExportSinksCallback​

Ƭ GetNamespaceExportSinksCallback: (error: Error | null, response?: GetNamespaceExportSinksResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getNamespaceExportSinks.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetNamespaceExportSinksResponseGetNamespaceExportSinksResponse
Returns​

void


GetNamespaces​

Ƭ GetNamespaces: Object

Get all namespaces

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetNamespacesRequest
callbackGetNamespacesCallback
Returns​

void

▸ (request): Promise<GetNamespacesResponse>

Parameters​
NameType
requestIGetNamespacesRequest
Returns​

Promise<GetNamespacesResponse>

Type declaration​

NameType
name"GetNamespaces"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaces"
requestStreamundefined
requestType"GetNamespacesRequest"
responseStreamundefined
responseType"GetNamespacesResponse"

GetNamespacesCallback​

Ƭ GetNamespacesCallback: (error: Error | null, response?: GetNamespacesResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getNamespaces.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetNamespacesResponseGetNamespacesResponse
Returns​

void


GetNexusEndpoint​

Ƭ GetNexusEndpoint: Object

Get a nexus endpoint

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetNexusEndpointRequest
callbackGetNexusEndpointCallback
Returns​

void

▸ (request): Promise<GetNexusEndpointResponse>

Parameters​
NameType
requestIGetNexusEndpointRequest
Returns​

Promise<GetNexusEndpointResponse>

Type declaration​

NameType
name"GetNexusEndpoint"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetNexusEndpoint"
requestStreamundefined
requestType"GetNexusEndpointRequest"
responseStreamundefined
responseType"GetNexusEndpointResponse"

GetNexusEndpointCallback​

Ƭ GetNexusEndpointCallback: (error: Error | null, response?: GetNexusEndpointResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getNexusEndpoint.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetNexusEndpointResponseGetNexusEndpointResponse
Returns​

void


GetNexusEndpoints​

Ƭ GetNexusEndpoints: Object

Gets nexus endpoints

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetNexusEndpointsRequest
callbackGetNexusEndpointsCallback
Returns​

void

▸ (request): Promise<GetNexusEndpointsResponse>

Parameters​
NameType
requestIGetNexusEndpointsRequest
Returns​

Promise<GetNexusEndpointsResponse>

Type declaration​

NameType
name"GetNexusEndpoints"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetNexusEndpoints"
requestStreamundefined
requestType"GetNexusEndpointsRequest"
responseStreamundefined
responseType"GetNexusEndpointsResponse"

GetNexusEndpointsCallback​

Ƭ GetNexusEndpointsCallback: (error: Error | null, response?: GetNexusEndpointsResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getNexusEndpoints.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetNexusEndpointsResponseGetNexusEndpointsResponse
Returns​

void


GetRegion​

Ƭ GetRegion: Object

Get a region

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetRegionRequest
callbackGetRegionCallback
Returns​

void

▸ (request): Promise<GetRegionResponse>

Parameters​
NameType
requestIGetRegionRequest
Returns​

Promise<GetRegionResponse>

Type declaration​

NameType
name"GetRegion"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetRegion"
requestStreamundefined
requestType"GetRegionRequest"
responseStreamundefined
responseType"GetRegionResponse"

GetRegionCallback​

Ƭ GetRegionCallback: (error: Error | null, response?: GetRegionResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getRegion.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetRegionResponseGetRegionResponse
Returns​

void


GetRegions​

Ƭ GetRegions: Object

Get all regions

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetRegionsRequest
callbackGetRegionsCallback
Returns​

void

▸ (request): Promise<GetRegionsResponse>

Parameters​
NameType
requestIGetRegionsRequest
Returns​

Promise<GetRegionsResponse>

Type declaration​

NameType
name"GetRegions"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetRegions"
requestStreamundefined
requestType"GetRegionsRequest"
responseStreamundefined
responseType"GetRegionsResponse"

GetRegionsCallback​

Ƭ GetRegionsCallback: (error: Error | null, response?: GetRegionsResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getRegions.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetRegionsResponseGetRegionsResponse
Returns​

void


GetServiceAccount​

Ƭ GetServiceAccount: Object

Get a service account.

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetServiceAccountRequest
callbackGetServiceAccountCallback
Returns​

void

▸ (request): Promise<GetServiceAccountResponse>

Parameters​
NameType
requestIGetServiceAccountRequest
Returns​

Promise<GetServiceAccountResponse>

Type declaration​

NameType
name"GetServiceAccount"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetServiceAccount"
requestStreamundefined
requestType"GetServiceAccountRequest"
responseStreamundefined
responseType"GetServiceAccountResponse"

GetServiceAccountCallback​

Ƭ GetServiceAccountCallback: (error: Error | null, response?: GetServiceAccountResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getServiceAccount.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetServiceAccountResponseGetServiceAccountResponse
Returns​

void


GetServiceAccountNamespaceAssignments​

Ƭ GetServiceAccountNamespaceAssignments: Object

Get service accounts with access to a namespace

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetServiceAccountNamespaceAssignmentsRequest
callbackGetServiceAccountNamespaceAssignmentsCallback
Returns​

void

▸ (request): Promise<GetServiceAccountNamespaceAssignmentsResponse>

Parameters​
NameType
requestIGetServiceAccountNamespaceAssignmentsRequest
Returns​

Promise<GetServiceAccountNamespaceAssignmentsResponse>

Type declaration​

NameType
name"GetServiceAccountNamespaceAssignments"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetServiceAccountNamespaceAssignments"
requestStreamundefined
requestType"GetServiceAccountNamespaceAssignmentsRequest"
responseStreamundefined
responseType"GetServiceAccountNamespaceAssignmentsResponse"

GetServiceAccountNamespaceAssignmentsCallback​

Ƭ GetServiceAccountNamespaceAssignmentsCallback: (error: Error | null, response?: GetServiceAccountNamespaceAssignmentsResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getServiceAccountNamespaceAssignments.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetServiceAccountNamespaceAssignmentsResponseGetServiceAccountNamespaceAssignmentsResponse
Returns​

void


GetServiceAccounts​

Ƭ GetServiceAccounts: Object

Get service accounts.

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetServiceAccountsRequest
callbackGetServiceAccountsCallback
Returns​

void

▸ (request): Promise<GetServiceAccountsResponse>

Parameters​
NameType
requestIGetServiceAccountsRequest
Returns​

Promise<GetServiceAccountsResponse>

Type declaration​

NameType
name"GetServiceAccounts"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetServiceAccounts"
requestStreamundefined
requestType"GetServiceAccountsRequest"
responseStreamundefined
responseType"GetServiceAccountsResponse"

GetServiceAccountsCallback​

Ƭ GetServiceAccountsCallback: (error: Error | null, response?: GetServiceAccountsResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getServiceAccounts.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetServiceAccountsResponseGetServiceAccountsResponse
Returns​

void


GetUsage​

Ƭ GetUsage: Object

WARNING: Pre-Release Feature Get usage data across namespaces

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetUsageRequest
callbackGetUsageCallback
Returns​

void

▸ (request): Promise<GetUsageResponse>

Parameters​
NameType
requestIGetUsageRequest
Returns​

Promise<GetUsageResponse>

Type declaration​

NameType
name"GetUsage"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetUsage"
requestStreamundefined
requestType"GetUsageRequest"
responseStreamundefined
responseType"GetUsageResponse"

GetUsageCallback​

Ƭ GetUsageCallback: (error: Error | null, response?: GetUsageResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getUsage.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetUsageResponseGetUsageResponse
Returns​

void


GetUser​

Ƭ GetUser: Object

Get a user

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetUserRequest
callbackGetUserCallback
Returns​

void

▸ (request): Promise<GetUserResponse>

Parameters​
NameType
requestIGetUserRequest
Returns​

Promise<GetUserResponse>

Type declaration​

NameType
name"GetUser"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetUser"
requestStreamundefined
requestType"GetUserRequest"
responseStreamundefined
responseType"GetUserResponse"

GetUserCallback​

Ƭ GetUserCallback: (error: Error | null, response?: GetUserResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getUser.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetUserResponseGetUserResponse
Returns​

void


GetUserGroup​

Ƭ GetUserGroup: Object

Get a user group

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetUserGroupRequest
callbackGetUserGroupCallback
Returns​

void

▸ (request): Promise<GetUserGroupResponse>

Parameters​
NameType
requestIGetUserGroupRequest
Returns​

Promise<GetUserGroupResponse>

Type declaration​

NameType
name"GetUserGroup"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroup"
requestStreamundefined
requestType"GetUserGroupRequest"
responseStreamundefined
responseType"GetUserGroupResponse"

GetUserGroupCallback​

Ƭ GetUserGroupCallback: (error: Error | null, response?: GetUserGroupResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getUserGroup.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetUserGroupResponseGetUserGroupResponse
Returns​

void


GetUserGroupMembers​

Ƭ GetUserGroupMembers: Object

Calls GetUserGroupMembers.

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetUserGroupMembersRequest
callbackGetUserGroupMembersCallback
Returns​

void

▸ (request): Promise<GetUserGroupMembersResponse>

Parameters​
NameType
requestIGetUserGroupMembersRequest
Returns​

Promise<GetUserGroupMembersResponse>

Type declaration​

NameType
name"GetUserGroupMembers"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroupMembers"
requestStreamundefined
requestType"GetUserGroupMembersRequest"
responseStreamundefined
responseType"GetUserGroupMembersResponse"

GetUserGroupMembersCallback​

Ƭ GetUserGroupMembersCallback: (error: Error | null, response?: GetUserGroupMembersResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getUserGroupMembers.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetUserGroupMembersResponseGetUserGroupMembersResponse
Returns​

void


GetUserGroupNamespaceAssignments​

Ƭ GetUserGroupNamespaceAssignments: Object

Get user groups with access to a namespace

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetUserGroupNamespaceAssignmentsRequest
callbackGetUserGroupNamespaceAssignmentsCallback
Returns​

void

▸ (request): Promise<GetUserGroupNamespaceAssignmentsResponse>

Parameters​
NameType
requestIGetUserGroupNamespaceAssignmentsRequest
Returns​

Promise<GetUserGroupNamespaceAssignmentsResponse>

Type declaration​

NameType
name"GetUserGroupNamespaceAssignments"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroupNamespaceAssignments"
requestStreamundefined
requestType"GetUserGroupNamespaceAssignmentsRequest"
responseStreamundefined
responseType"GetUserGroupNamespaceAssignmentsResponse"

GetUserGroupNamespaceAssignmentsCallback​

Ƭ GetUserGroupNamespaceAssignmentsCallback: (error: Error | null, response?: GetUserGroupNamespaceAssignmentsResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getUserGroupNamespaceAssignments.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetUserGroupNamespaceAssignmentsResponseGetUserGroupNamespaceAssignmentsResponse
Returns​

void


GetUserGroups​

Ƭ GetUserGroups: Object

Get all user groups

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetUserGroupsRequest
callbackGetUserGroupsCallback
Returns​

void

▸ (request): Promise<GetUserGroupsResponse>

Parameters​
NameType
requestIGetUserGroupsRequest
Returns​

Promise<GetUserGroupsResponse>

Type declaration​

NameType
name"GetUserGroups"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroups"
requestStreamundefined
requestType"GetUserGroupsRequest"
responseStreamundefined
responseType"GetUserGroupsResponse"

GetUserGroupsCallback​

Ƭ GetUserGroupsCallback: (error: Error | null, response?: GetUserGroupsResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getUserGroups.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetUserGroupsResponseGetUserGroupsResponse
Returns​

void


GetUserNamespaceAssignments​

Ƭ GetUserNamespaceAssignments: Object

Get users with access to a namespace

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetUserNamespaceAssignmentsRequest
callbackGetUserNamespaceAssignmentsCallback
Returns​

void

▸ (request): Promise<GetUserNamespaceAssignmentsResponse>

Parameters​
NameType
requestIGetUserNamespaceAssignmentsRequest
Returns​

Promise<GetUserNamespaceAssignmentsResponse>

Type declaration​

NameType
name"GetUserNamespaceAssignments"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetUserNamespaceAssignments"
requestStreamundefined
requestType"GetUserNamespaceAssignmentsRequest"
responseStreamundefined
responseType"GetUserNamespaceAssignmentsResponse"

GetUserNamespaceAssignmentsCallback​

Ƭ GetUserNamespaceAssignmentsCallback: (error: Error | null, response?: GetUserNamespaceAssignmentsResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getUserNamespaceAssignments.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetUserNamespaceAssignmentsResponseGetUserNamespaceAssignmentsResponse
Returns​

void


GetUsers​

Ƭ GetUsers: Object

Gets all known users

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIGetUsersRequest
callbackGetUsersCallback
Returns​

void

▸ (request): Promise<GetUsersResponse>

Parameters​
NameType
requestIGetUsersRequest
Returns​

Promise<GetUsersResponse>

Type declaration​

NameType
name"GetUsers"
path"/temporal.api.cloud.cloudservice.v1.CloudService/GetUsers"
requestStreamundefined
requestType"GetUsersRequest"
responseStreamundefined
responseType"GetUsersResponse"

GetUsersCallback​

Ƭ GetUsersCallback: (error: Error | null, response?: GetUsersResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#getUsers.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?GetUsersResponseGetUsersResponse
Returns​

void


RemoveUserGroupMember​

Ƭ RemoveUserGroupMember: Object

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

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIRemoveUserGroupMemberRequest
callbackRemoveUserGroupMemberCallback
Returns​

void

▸ (request): Promise<RemoveUserGroupMemberResponse>

Parameters​
NameType
requestIRemoveUserGroupMemberRequest
Returns​

Promise<RemoveUserGroupMemberResponse>

Type declaration​

NameType
name"RemoveUserGroupMember"
path"/temporal.api.cloud.cloudservice.v1.CloudService/RemoveUserGroupMember"
requestStreamundefined
requestType"RemoveUserGroupMemberRequest"
responseStreamundefined
responseType"RemoveUserGroupMemberResponse"

RemoveUserGroupMemberCallback​

Ƭ RemoveUserGroupMemberCallback: (error: Error | null, response?: RemoveUserGroupMemberResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#removeUserGroupMember.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?RemoveUserGroupMemberResponseRemoveUserGroupMemberResponse
Returns​

void


RenameCustomSearchAttribute​

Ƭ RenameCustomSearchAttribute: Object

Rename an existing customer search attribute

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIRenameCustomSearchAttributeRequest
callbackRenameCustomSearchAttributeCallback
Returns​

void

▸ (request): Promise<RenameCustomSearchAttributeResponse>

Parameters​
NameType
requestIRenameCustomSearchAttributeRequest
Returns​

Promise<RenameCustomSearchAttributeResponse>

Type declaration​

NameType
name"RenameCustomSearchAttribute"
path"/temporal.api.cloud.cloudservice.v1.CloudService/RenameCustomSearchAttribute"
requestStreamundefined
requestType"RenameCustomSearchAttributeRequest"
responseStreamundefined
responseType"RenameCustomSearchAttributeResponse"

RenameCustomSearchAttributeCallback​

Ƭ RenameCustomSearchAttributeCallback: (error: Error | null, response?: RenameCustomSearchAttributeResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#renameCustomSearchAttribute.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?RenameCustomSearchAttributeResponseRenameCustomSearchAttributeResponse
Returns​

void


SetServiceAccountNamespaceAccess​

Ƭ SetServiceAccountNamespaceAccess: Object

Set a service account's access to a namespace.

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestISetServiceAccountNamespaceAccessRequest
callbackSetServiceAccountNamespaceAccessCallback
Returns​

void

▸ (request): Promise<SetServiceAccountNamespaceAccessResponse>

Parameters​
NameType
requestISetServiceAccountNamespaceAccessRequest
Returns​

Promise<SetServiceAccountNamespaceAccessResponse>

Type declaration​

NameType
name"SetServiceAccountNamespaceAccess"
path"/temporal.api.cloud.cloudservice.v1.CloudService/SetServiceAccountNamespaceAccess"
requestStreamundefined
requestType"SetServiceAccountNamespaceAccessRequest"
responseStreamundefined
responseType"SetServiceAccountNamespaceAccessResponse"

SetServiceAccountNamespaceAccessCallback​

Ƭ SetServiceAccountNamespaceAccessCallback: (error: Error | null, response?: SetServiceAccountNamespaceAccessResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#setServiceAccountNamespaceAccess.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?SetServiceAccountNamespaceAccessResponseSetServiceAccountNamespaceAccessResponse
Returns​

void


SetUserGroupNamespaceAccess​

Ƭ SetUserGroupNamespaceAccess: Object

Set a user group's access to a namespace

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestISetUserGroupNamespaceAccessRequest
callbackSetUserGroupNamespaceAccessCallback
Returns​

void

▸ (request): Promise<SetUserGroupNamespaceAccessResponse>

Parameters​
NameType
requestISetUserGroupNamespaceAccessRequest
Returns​

Promise<SetUserGroupNamespaceAccessResponse>

Type declaration​

NameType
name"SetUserGroupNamespaceAccess"
path"/temporal.api.cloud.cloudservice.v1.CloudService/SetUserGroupNamespaceAccess"
requestStreamundefined
requestType"SetUserGroupNamespaceAccessRequest"
responseStreamundefined
responseType"SetUserGroupNamespaceAccessResponse"

SetUserGroupNamespaceAccessCallback​

Ƭ SetUserGroupNamespaceAccessCallback: (error: Error | null, response?: SetUserGroupNamespaceAccessResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#setUserGroupNamespaceAccess.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?SetUserGroupNamespaceAccessResponseSetUserGroupNamespaceAccessResponse
Returns​

void


SetUserNamespaceAccess​

Ƭ SetUserNamespaceAccess: Object

Set a user's access to a namespace

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestISetUserNamespaceAccessRequest
callbackSetUserNamespaceAccessCallback
Returns​

void

▸ (request): Promise<SetUserNamespaceAccessResponse>

Parameters​
NameType
requestISetUserNamespaceAccessRequest
Returns​

Promise<SetUserNamespaceAccessResponse>

Type declaration​

NameType
name"SetUserNamespaceAccess"
path"/temporal.api.cloud.cloudservice.v1.CloudService/SetUserNamespaceAccess"
requestStreamundefined
requestType"SetUserNamespaceAccessRequest"
responseStreamundefined
responseType"SetUserNamespaceAccessResponse"

SetUserNamespaceAccessCallback​

Ƭ SetUserNamespaceAccessCallback: (error: Error | null, response?: SetUserNamespaceAccessResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#setUserNamespaceAccess.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?SetUserNamespaceAccessResponseSetUserNamespaceAccessResponse
Returns​

void


UpdateAccount​

Ƭ UpdateAccount: Object

Update account information.

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIUpdateAccountRequest
callbackUpdateAccountCallback
Returns​

void

▸ (request): Promise<UpdateAccountResponse>

Parameters​
NameType
requestIUpdateAccountRequest
Returns​

Promise<UpdateAccountResponse>

Type declaration​

NameType
name"UpdateAccount"
path"/temporal.api.cloud.cloudservice.v1.CloudService/UpdateAccount"
requestStreamundefined
requestType"UpdateAccountRequest"
responseStreamundefined
responseType"UpdateAccountResponse"

UpdateAccountAuditLogSink​

Ƭ UpdateAccountAuditLogSink: Object

Update an audit log sink

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIUpdateAccountAuditLogSinkRequest
callbackUpdateAccountAuditLogSinkCallback
Returns​

void

▸ (request): Promise<UpdateAccountAuditLogSinkResponse>

Parameters​
NameType
requestIUpdateAccountAuditLogSinkRequest
Returns​

Promise<UpdateAccountAuditLogSinkResponse>

Type declaration​

NameType
name"UpdateAccountAuditLogSink"
path"/temporal.api.cloud.cloudservice.v1.CloudService/UpdateAccountAuditLogSink"
requestStreamundefined
requestType"UpdateAccountAuditLogSinkRequest"
responseStreamundefined
responseType"UpdateAccountAuditLogSinkResponse"

UpdateAccountAuditLogSinkCallback​

Ƭ UpdateAccountAuditLogSinkCallback: (error: Error | null, response?: UpdateAccountAuditLogSinkResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#updateAccountAuditLogSink.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?UpdateAccountAuditLogSinkResponseUpdateAccountAuditLogSinkResponse
Returns​

void


UpdateAccountCallback​

Ƭ UpdateAccountCallback: (error: Error | null, response?: UpdateAccountResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#updateAccount.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?UpdateAccountResponseUpdateAccountResponse
Returns​

void


UpdateApiKey​

Ƭ UpdateApiKey: Object

Update an API key

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIUpdateApiKeyRequest
callbackUpdateApiKeyCallback
Returns​

void

▸ (request): Promise<UpdateApiKeyResponse>

Parameters​
NameType
requestIUpdateApiKeyRequest
Returns​

Promise<UpdateApiKeyResponse>

Type declaration​

NameType
name"UpdateApiKey"
path"/temporal.api.cloud.cloudservice.v1.CloudService/UpdateApiKey"
requestStreamundefined
requestType"UpdateApiKeyRequest"
responseStreamundefined
responseType"UpdateApiKeyResponse"

UpdateApiKeyCallback​

Ƭ UpdateApiKeyCallback: (error: Error | null, response?: UpdateApiKeyResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#updateApiKey.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?UpdateApiKeyResponseUpdateApiKeyResponse
Returns​

void


UpdateCustomRole​

Ƭ UpdateCustomRole: Object

Update a custom role

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIUpdateCustomRoleRequest
callbackUpdateCustomRoleCallback
Returns​

void

▸ (request): Promise<UpdateCustomRoleResponse>

Parameters​
NameType
requestIUpdateCustomRoleRequest
Returns​

Promise<UpdateCustomRoleResponse>

Type declaration​

NameType
name"UpdateCustomRole"
path"/temporal.api.cloud.cloudservice.v1.CloudService/UpdateCustomRole"
requestStreamundefined
requestType"UpdateCustomRoleRequest"
responseStreamundefined
responseType"UpdateCustomRoleResponse"

UpdateCustomRoleCallback​

Ƭ UpdateCustomRoleCallback: (error: Error | null, response?: UpdateCustomRoleResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#updateCustomRole.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?UpdateCustomRoleResponseUpdateCustomRoleResponse
Returns​

void


UpdateNamespace​

Ƭ UpdateNamespace: Object

Update a namespace

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIUpdateNamespaceRequest
callbackUpdateNamespaceCallback
Returns​

void

▸ (request): Promise<UpdateNamespaceResponse>

Parameters​
NameType
requestIUpdateNamespaceRequest
Returns​

Promise<UpdateNamespaceResponse>

Type declaration​

NameType
name"UpdateNamespace"
path"/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNamespace"
requestStreamundefined
requestType"UpdateNamespaceRequest"
responseStreamundefined
responseType"UpdateNamespaceResponse"

UpdateNamespaceCallback​

Ƭ UpdateNamespaceCallback: (error: Error | null, response?: UpdateNamespaceResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#updateNamespace.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?UpdateNamespaceResponseUpdateNamespaceResponse
Returns​

void


UpdateNamespaceExportSink​

Ƭ UpdateNamespaceExportSink: Object

Update an export sink

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIUpdateNamespaceExportSinkRequest
callbackUpdateNamespaceExportSinkCallback
Returns​

void

▸ (request): Promise<UpdateNamespaceExportSinkResponse>

Parameters​
NameType
requestIUpdateNamespaceExportSinkRequest
Returns​

Promise<UpdateNamespaceExportSinkResponse>

Type declaration​

NameType
name"UpdateNamespaceExportSink"
path"/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNamespaceExportSink"
requestStreamundefined
requestType"UpdateNamespaceExportSinkRequest"
responseStreamundefined
responseType"UpdateNamespaceExportSinkResponse"

UpdateNamespaceExportSinkCallback​

Ƭ UpdateNamespaceExportSinkCallback: (error: Error | null, response?: UpdateNamespaceExportSinkResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#updateNamespaceExportSink.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?UpdateNamespaceExportSinkResponseUpdateNamespaceExportSinkResponse
Returns​

void


UpdateNamespaceTags​

Ƭ UpdateNamespaceTags: Object

Update the tags for a namespace

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIUpdateNamespaceTagsRequest
callbackUpdateNamespaceTagsCallback
Returns​

void

▸ (request): Promise<UpdateNamespaceTagsResponse>

Parameters​
NameType
requestIUpdateNamespaceTagsRequest
Returns​

Promise<UpdateNamespaceTagsResponse>

Type declaration​

NameType
name"UpdateNamespaceTags"
path"/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNamespaceTags"
requestStreamundefined
requestType"UpdateNamespaceTagsRequest"
responseStreamundefined
responseType"UpdateNamespaceTagsResponse"

UpdateNamespaceTagsCallback​

Ƭ UpdateNamespaceTagsCallback: (error: Error | null, response?: UpdateNamespaceTagsResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#updateNamespaceTags.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?UpdateNamespaceTagsResponseUpdateNamespaceTagsResponse
Returns​

void


UpdateNexusEndpoint​

Ƭ UpdateNexusEndpoint: Object

Update a nexus endpoint

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIUpdateNexusEndpointRequest
callbackUpdateNexusEndpointCallback
Returns​

void

▸ (request): Promise<UpdateNexusEndpointResponse>

Parameters​
NameType
requestIUpdateNexusEndpointRequest
Returns​

Promise<UpdateNexusEndpointResponse>

Type declaration​

NameType
name"UpdateNexusEndpoint"
path"/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNexusEndpoint"
requestStreamundefined
requestType"UpdateNexusEndpointRequest"
responseStreamundefined
responseType"UpdateNexusEndpointResponse"

UpdateNexusEndpointCallback​

Ƭ UpdateNexusEndpointCallback: (error: Error | null, response?: UpdateNexusEndpointResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#updateNexusEndpoint.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?UpdateNexusEndpointResponseUpdateNexusEndpointResponse
Returns​

void


UpdateServiceAccount​

Ƭ UpdateServiceAccount: Object

Update a service account.

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIUpdateServiceAccountRequest
callbackUpdateServiceAccountCallback
Returns​

void

▸ (request): Promise<UpdateServiceAccountResponse>

Parameters​
NameType
requestIUpdateServiceAccountRequest
Returns​

Promise<UpdateServiceAccountResponse>

Type declaration​

NameType
name"UpdateServiceAccount"
path"/temporal.api.cloud.cloudservice.v1.CloudService/UpdateServiceAccount"
requestStreamundefined
requestType"UpdateServiceAccountRequest"
responseStreamundefined
responseType"UpdateServiceAccountResponse"

UpdateServiceAccountCallback​

Ƭ UpdateServiceAccountCallback: (error: Error | null, response?: UpdateServiceAccountResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#updateServiceAccount.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?UpdateServiceAccountResponseUpdateServiceAccountResponse
Returns​

void


UpdateUser​

Ƭ UpdateUser: Object

Update a user

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIUpdateUserRequest
callbackUpdateUserCallback
Returns​

void

▸ (request): Promise<UpdateUserResponse>

Parameters​
NameType
requestIUpdateUserRequest
Returns​

Promise<UpdateUserResponse>

Type declaration​

NameType
name"UpdateUser"
path"/temporal.api.cloud.cloudservice.v1.CloudService/UpdateUser"
requestStreamundefined
requestType"UpdateUserRequest"
responseStreamundefined
responseType"UpdateUserResponse"

UpdateUserCallback​

Ƭ UpdateUserCallback: (error: Error | null, response?: UpdateUserResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#updateUser.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?UpdateUserResponseUpdateUserResponse
Returns​

void


UpdateUserGroup​

Ƭ UpdateUserGroup: Object

Update a user group

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIUpdateUserGroupRequest
callbackUpdateUserGroupCallback
Returns​

void

▸ (request): Promise<UpdateUserGroupResponse>

Parameters​
NameType
requestIUpdateUserGroupRequest
Returns​

Promise<UpdateUserGroupResponse>

Type declaration​

NameType
name"UpdateUserGroup"
path"/temporal.api.cloud.cloudservice.v1.CloudService/UpdateUserGroup"
requestStreamundefined
requestType"UpdateUserGroupRequest"
responseStreamundefined
responseType"UpdateUserGroupResponse"

UpdateUserGroupCallback​

Ƭ UpdateUserGroupCallback: (error: Error | null, response?: UpdateUserGroupResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#updateUserGroup.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?UpdateUserGroupResponseUpdateUserGroupResponse
Returns​

void


ValidateAccountAuditLogSink​

Ƭ ValidateAccountAuditLogSink: Object

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.

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIValidateAccountAuditLogSinkRequest
callbackValidateAccountAuditLogSinkCallback
Returns​

void

▸ (request): Promise<ValidateAccountAuditLogSinkResponse>

Parameters​
NameType
requestIValidateAccountAuditLogSinkRequest
Returns​

Promise<ValidateAccountAuditLogSinkResponse>

Type declaration​

NameType
name"ValidateAccountAuditLogSink"
path"/temporal.api.cloud.cloudservice.v1.CloudService/ValidateAccountAuditLogSink"
requestStreamundefined
requestType"ValidateAccountAuditLogSinkRequest"
responseStreamundefined
responseType"ValidateAccountAuditLogSinkResponse"

ValidateAccountAuditLogSinkCallback​

Ƭ ValidateAccountAuditLogSinkCallback: (error: Error | null, response?: ValidateAccountAuditLogSinkResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#validateAccountAuditLogSink.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?ValidateAccountAuditLogSinkResponseValidateAccountAuditLogSinkResponse
Returns​

void


ValidateNamespaceExportSink​

Ƭ ValidateNamespaceExportSink: Object

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.

Call signature​

▸ (request, callback): void

Parameters​
NameType
requestIValidateNamespaceExportSinkRequest
callbackValidateNamespaceExportSinkCallback
Returns​

void

▸ (request): Promise<ValidateNamespaceExportSinkResponse>

Parameters​
NameType
requestIValidateNamespaceExportSinkRequest
Returns​

Promise<ValidateNamespaceExportSinkResponse>

Type declaration​

NameType
name"ValidateNamespaceExportSink"
path"/temporal.api.cloud.cloudservice.v1.CloudService/ValidateNamespaceExportSink"
requestStreamundefined
requestType"ValidateNamespaceExportSinkRequest"
responseStreamundefined
responseType"ValidateNamespaceExportSinkResponse"

ValidateNamespaceExportSinkCallback​

Ƭ ValidateNamespaceExportSinkCallback: (error: Error | null, response?: ValidateNamespaceExportSinkResponse) => void

Callback as used by temporal.api.cloud.cloudservice.v1.CloudService#validateNamespaceExportSink.

Type declaration​

▸ (error, response?): void

Parameters​
NameTypeDescription
errorError | nullError, if any
response?ValidateNamespaceExportSinkResponseValidateNamespaceExportSinkResponse
Returns​

void