Skip to main content

CloudService

Type Aliases​

AddNamespaceRegion()​

AddNamespaceRegion = void

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

Call Signature​

AddNamespaceRegion(request, callback): void

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

Parameters​
request​

IAddNamespaceRegionRequest

callback​

AddNamespaceRegionCallback

Returns​

void

Call Signature​

AddNamespaceRegion(request): Promise<AddNamespaceRegionResponse>

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

Parameters​
request​

IAddNamespaceRegionRequest

Returns​

Promise<AddNamespaceRegionResponse>

Properties​

name​

readonly name: "AddNamespaceRegion"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/AddNamespaceRegion"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "AddNamespaceRegionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "AddNamespaceRegionResponse"

AddNamespaceRegionCallback​

AddNamespaceRegionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

AddNamespaceRegionResponse

AddNamespaceRegionResponse

Returns​

void

AddUserGroupMember()​

AddUserGroupMember = void

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

Call Signature​

AddUserGroupMember(request, callback): void

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

Parameters​
request​

IAddUserGroupMemberRequest

callback​

AddUserGroupMemberCallback

Returns​

void

Call Signature​

AddUserGroupMember(request): Promise<AddUserGroupMemberResponse>

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

Parameters​
request​

IAddUserGroupMemberRequest

Returns​

Promise<AddUserGroupMemberResponse>

Properties​

name​

readonly name: "AddUserGroupMember"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/AddUserGroupMember"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "AddUserGroupMemberRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "AddUserGroupMemberResponse"

AddUserGroupMemberCallback​

AddUserGroupMemberCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

AddUserGroupMemberResponse

AddUserGroupMemberResponse

Returns​

void

CreateAccountAuditLogSink()​

CreateAccountAuditLogSink = void

Create an audit log sink

Call Signature​

CreateAccountAuditLogSink(request, callback): void

Create an audit log sink

Parameters​
request​

ICreateAccountAuditLogSinkRequest

callback​

CreateAccountAuditLogSinkCallback

Returns​

void

Call Signature​

CreateAccountAuditLogSink(request): Promise<CreateAccountAuditLogSinkResponse>

Create an audit log sink

Parameters​
request​

ICreateAccountAuditLogSinkRequest

Returns​

Promise<CreateAccountAuditLogSinkResponse>

Properties​

name​

readonly name: "CreateAccountAuditLogSink"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/CreateAccountAuditLogSink"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateAccountAuditLogSinkRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateAccountAuditLogSinkResponse"

CreateAccountAuditLogSinkCallback​

CreateAccountAuditLogSinkCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateAccountAuditLogSinkResponse

CreateAccountAuditLogSinkResponse

Returns​

void

CreateApiKey()​

CreateApiKey = void

Create an API key

Call Signature​

CreateApiKey(request, callback): void

Create an API key

Parameters​
request​

ICreateApiKeyRequest

callback​

CreateApiKeyCallback

Returns​

void

Call Signature​

CreateApiKey(request): Promise<CreateApiKeyResponse>

Create an API key

Parameters​
request​

ICreateApiKeyRequest

Returns​

Promise<CreateApiKeyResponse>

Properties​

name​

readonly name: "CreateApiKey"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/CreateApiKey"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateApiKeyRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateApiKeyResponse"

CreateApiKeyCallback​

CreateApiKeyCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateApiKeyResponse

CreateApiKeyResponse

Returns​

void

CreateBillingReport()​

CreateBillingReport = void

Create a billing report

Call Signature​

CreateBillingReport(request, callback): void

Create a billing report

Parameters​
request​

ICreateBillingReportRequest

callback​

CreateBillingReportCallback

Returns​

void

Call Signature​

CreateBillingReport(request): Promise<CreateBillingReportResponse>

Create a billing report

Parameters​
request​

ICreateBillingReportRequest

Returns​

Promise<CreateBillingReportResponse>

Properties​

name​

readonly name: "CreateBillingReport"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/CreateBillingReport"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateBillingReportRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateBillingReportResponse"

CreateBillingReportCallback​

CreateBillingReportCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateBillingReportResponse

CreateBillingReportResponse

Returns​

void

CreateConnectivityRule()​

CreateConnectivityRule = void

Creates a connectivity rule

Call Signature​

CreateConnectivityRule(request, callback): void

Creates a connectivity rule

Parameters​
request​

ICreateConnectivityRuleRequest

callback​

CreateConnectivityRuleCallback

Returns​

void

Call Signature​

CreateConnectivityRule(request): Promise<CreateConnectivityRuleResponse>

Creates a connectivity rule

Parameters​
request​

ICreateConnectivityRuleRequest

Returns​

Promise<CreateConnectivityRuleResponse>

Properties​

name​

readonly name: "CreateConnectivityRule"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/CreateConnectivityRule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateConnectivityRuleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateConnectivityRuleResponse"

CreateConnectivityRuleCallback​

CreateConnectivityRuleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateConnectivityRuleResponse

CreateConnectivityRuleResponse

Returns​

void

CreateCustomRole()​

CreateCustomRole = void

Create a custom role

Call Signature​

CreateCustomRole(request, callback): void

Create a custom role

Parameters​
request​

ICreateCustomRoleRequest

callback​

CreateCustomRoleCallback

Returns​

void

Call Signature​

CreateCustomRole(request): Promise<CreateCustomRoleResponse>

Create a custom role

Parameters​
request​

ICreateCustomRoleRequest

Returns​

Promise<CreateCustomRoleResponse>

Properties​

name​

readonly name: "CreateCustomRole"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/CreateCustomRole"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateCustomRoleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateCustomRoleResponse"

CreateCustomRoleCallback​

CreateCustomRoleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateCustomRoleResponse

CreateCustomRoleResponse

Returns​

void

CreateNamespace()​

CreateNamespace = void

Create a new namespace

Call Signature​

CreateNamespace(request, callback): void

Create a new namespace

Parameters​
request​

ICreateNamespaceRequest

callback​

CreateNamespaceCallback

Returns​

void

Call Signature​

CreateNamespace(request): Promise<CreateNamespaceResponse>

Create a new namespace

Parameters​
request​

ICreateNamespaceRequest

Returns​

Promise<CreateNamespaceResponse>

Properties​

name​

readonly name: "CreateNamespace"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/CreateNamespace"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateNamespaceRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateNamespaceResponse"

CreateNamespaceCallback​

CreateNamespaceCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateNamespaceResponse

CreateNamespaceResponse

Returns​

void

CreateNamespaceExportSink()​

CreateNamespaceExportSink = void

Create an export sink

Call Signature​

CreateNamespaceExportSink(request, callback): void

Create an export sink

Parameters​
request​

ICreateNamespaceExportSinkRequest

callback​

CreateNamespaceExportSinkCallback

Returns​

void

Call Signature​

CreateNamespaceExportSink(request): Promise<CreateNamespaceExportSinkResponse>

Create an export sink

Parameters​
request​

ICreateNamespaceExportSinkRequest

Returns​

Promise<CreateNamespaceExportSinkResponse>

Properties​

name​

readonly name: "CreateNamespaceExportSink"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/CreateNamespaceExportSink"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateNamespaceExportSinkRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateNamespaceExportSinkResponse"

CreateNamespaceExportSinkCallback​

CreateNamespaceExportSinkCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateNamespaceExportSinkResponse

CreateNamespaceExportSinkResponse

Returns​

void

CreateNexusEndpoint()​

CreateNexusEndpoint = void

Create a nexus endpoint

Call Signature​

CreateNexusEndpoint(request, callback): void

Create a nexus endpoint

Parameters​
request​

ICreateNexusEndpointRequest

callback​

CreateNexusEndpointCallback

Returns​

void

Call Signature​

CreateNexusEndpoint(request): Promise<CreateNexusEndpointResponse>

Create a nexus endpoint

Parameters​
request​

ICreateNexusEndpointRequest

Returns​

Promise<CreateNexusEndpointResponse>

Properties​

name​

readonly name: "CreateNexusEndpoint"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/CreateNexusEndpoint"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateNexusEndpointRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateNexusEndpointResponse"

CreateNexusEndpointCallback​

CreateNexusEndpointCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateNexusEndpointResponse

CreateNexusEndpointResponse

Returns​

void

CreateServiceAccount()​

CreateServiceAccount = void

Create a service account.

Call Signature​

CreateServiceAccount(request, callback): void

Create a service account.

Parameters​
request​

ICreateServiceAccountRequest

callback​

CreateServiceAccountCallback

Returns​

void

Call Signature​

CreateServiceAccount(request): Promise<CreateServiceAccountResponse>

Create a service account.

Parameters​
request​

ICreateServiceAccountRequest

Returns​

Promise<CreateServiceAccountResponse>

Properties​

name​

readonly name: "CreateServiceAccount"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/CreateServiceAccount"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateServiceAccountRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateServiceAccountResponse"

CreateServiceAccountCallback​

CreateServiceAccountCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateServiceAccountResponse

CreateServiceAccountResponse

Returns​

void

CreateUser()​

CreateUser = void

Create a user

Call Signature​

CreateUser(request, callback): void

Create a user

Parameters​
request​

ICreateUserRequest

callback​

CreateUserCallback

Returns​

void

Call Signature​

CreateUser(request): Promise<CreateUserResponse>

Create a user

Parameters​
request​

ICreateUserRequest

Returns​

Promise<CreateUserResponse>

Properties​

name​

readonly name: "CreateUser"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/CreateUser"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateUserRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateUserResponse"

CreateUserCallback​

CreateUserCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateUserResponse

CreateUserResponse

Returns​

void

CreateUserGroup()​

CreateUserGroup = void

Create new a user group

Call Signature​

CreateUserGroup(request, callback): void

Create new a user group

Parameters​
request​

ICreateUserGroupRequest

callback​

CreateUserGroupCallback

Returns​

void

Call Signature​

CreateUserGroup(request): Promise<CreateUserGroupResponse>

Create new a user group

Parameters​
request​

ICreateUserGroupRequest

Returns​

Promise<CreateUserGroupResponse>

Properties​

name​

readonly name: "CreateUserGroup"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/CreateUserGroup"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateUserGroupRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateUserGroupResponse"

CreateUserGroupCallback​

CreateUserGroupCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateUserGroupResponse

CreateUserGroupResponse

Returns​

void

DeleteAccountAuditLogSink()​

DeleteAccountAuditLogSink = void

Delete an audit log sink

Call Signature​

DeleteAccountAuditLogSink(request, callback): void

Delete an audit log sink

Parameters​
request​

IDeleteAccountAuditLogSinkRequest

callback​

DeleteAccountAuditLogSinkCallback

Returns​

void

Call Signature​

DeleteAccountAuditLogSink(request): Promise<DeleteAccountAuditLogSinkResponse>

Delete an audit log sink

Parameters​
request​

IDeleteAccountAuditLogSinkRequest

Returns​

Promise<DeleteAccountAuditLogSinkResponse>

Properties​

name​

readonly name: "DeleteAccountAuditLogSink"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteAccountAuditLogSink"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteAccountAuditLogSinkRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteAccountAuditLogSinkResponse"

DeleteAccountAuditLogSinkCallback​

DeleteAccountAuditLogSinkCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteAccountAuditLogSinkResponse

DeleteAccountAuditLogSinkResponse

Returns​

void

DeleteApiKey()​

DeleteApiKey = void

Delete an API key

Call Signature​

DeleteApiKey(request, callback): void

Delete an API key

Parameters​
request​

IDeleteApiKeyRequest

callback​

DeleteApiKeyCallback

Returns​

void

Call Signature​

DeleteApiKey(request): Promise<DeleteApiKeyResponse>

Delete an API key

Parameters​
request​

IDeleteApiKeyRequest

Returns​

Promise<DeleteApiKeyResponse>

Properties​

name​

readonly name: "DeleteApiKey"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteApiKey"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteApiKeyRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteApiKeyResponse"

DeleteApiKeyCallback​

DeleteApiKeyCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteApiKeyResponse

DeleteApiKeyResponse

Returns​

void

DeleteConnectivityRule()​

DeleteConnectivityRule = void

Deletes a connectivity rule by id

Call Signature​

DeleteConnectivityRule(request, callback): void

Deletes a connectivity rule by id

Parameters​
request​

IDeleteConnectivityRuleRequest

callback​

DeleteConnectivityRuleCallback

Returns​

void

Call Signature​

DeleteConnectivityRule(request): Promise<DeleteConnectivityRuleResponse>

Deletes a connectivity rule by id

Parameters​
request​

IDeleteConnectivityRuleRequest

Returns​

Promise<DeleteConnectivityRuleResponse>

Properties​

name​

readonly name: "DeleteConnectivityRule"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteConnectivityRule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteConnectivityRuleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteConnectivityRuleResponse"

DeleteConnectivityRuleCallback​

DeleteConnectivityRuleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteConnectivityRuleResponse

DeleteConnectivityRuleResponse

Returns​

void

DeleteCustomRole()​

DeleteCustomRole = void

Delete a custom role

Call Signature​

DeleteCustomRole(request, callback): void

Delete a custom role

Parameters​
request​

IDeleteCustomRoleRequest

callback​

DeleteCustomRoleCallback

Returns​

void

Call Signature​

DeleteCustomRole(request): Promise<DeleteCustomRoleResponse>

Delete a custom role

Parameters​
request​

IDeleteCustomRoleRequest

Returns​

Promise<DeleteCustomRoleResponse>

Properties​

name​

readonly name: "DeleteCustomRole"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteCustomRole"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteCustomRoleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteCustomRoleResponse"

DeleteCustomRoleCallback​

DeleteCustomRoleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteCustomRoleResponse

DeleteCustomRoleResponse

Returns​

void

DeleteNamespace()​

DeleteNamespace = void

Delete a namespace

Call Signature​

DeleteNamespace(request, callback): void

Delete a namespace

Parameters​
request​

IDeleteNamespaceRequest

callback​

DeleteNamespaceCallback

Returns​

void

Call Signature​

DeleteNamespace(request): Promise<DeleteNamespaceResponse>

Delete a namespace

Parameters​
request​

IDeleteNamespaceRequest

Returns​

Promise<DeleteNamespaceResponse>

Properties​

name​

readonly name: "DeleteNamespace"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNamespace"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteNamespaceRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteNamespaceResponse"

DeleteNamespaceCallback​

DeleteNamespaceCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteNamespaceResponse

DeleteNamespaceResponse

Returns​

void

DeleteNamespaceExportSink()​

DeleteNamespaceExportSink = void

Delete an export sink

Call Signature​

DeleteNamespaceExportSink(request, callback): void

Delete an export sink

Parameters​
request​

IDeleteNamespaceExportSinkRequest

callback​

DeleteNamespaceExportSinkCallback

Returns​

void

Call Signature​

DeleteNamespaceExportSink(request): Promise<DeleteNamespaceExportSinkResponse>

Delete an export sink

Parameters​
request​

IDeleteNamespaceExportSinkRequest

Returns​

Promise<DeleteNamespaceExportSinkResponse>

Properties​

name​

readonly name: "DeleteNamespaceExportSink"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNamespaceExportSink"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteNamespaceExportSinkRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteNamespaceExportSinkResponse"

DeleteNamespaceExportSinkCallback​

DeleteNamespaceExportSinkCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteNamespaceExportSinkResponse

DeleteNamespaceExportSinkResponse

Returns​

void

DeleteNamespaceRegion()​

DeleteNamespaceRegion = void

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

Call Signature​

DeleteNamespaceRegion(request, callback): void

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

Parameters​
request​

IDeleteNamespaceRegionRequest

callback​

DeleteNamespaceRegionCallback

Returns​

void

Call Signature​

DeleteNamespaceRegion(request): Promise<DeleteNamespaceRegionResponse>

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

Parameters​
request​

IDeleteNamespaceRegionRequest

Returns​

Promise<DeleteNamespaceRegionResponse>

Properties​

name​

readonly name: "DeleteNamespaceRegion"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNamespaceRegion"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteNamespaceRegionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteNamespaceRegionResponse"

DeleteNamespaceRegionCallback​

DeleteNamespaceRegionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteNamespaceRegionResponse

DeleteNamespaceRegionResponse

Returns​

void

DeleteNexusEndpoint()​

DeleteNexusEndpoint = void

Delete a nexus endpoint

Call Signature​

DeleteNexusEndpoint(request, callback): void

Delete a nexus endpoint

Parameters​
request​

IDeleteNexusEndpointRequest

callback​

DeleteNexusEndpointCallback

Returns​

void

Call Signature​

DeleteNexusEndpoint(request): Promise<DeleteNexusEndpointResponse>

Delete a nexus endpoint

Parameters​
request​

IDeleteNexusEndpointRequest

Returns​

Promise<DeleteNexusEndpointResponse>

Properties​

name​

readonly name: "DeleteNexusEndpoint"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNexusEndpoint"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteNexusEndpointRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteNexusEndpointResponse"

DeleteNexusEndpointCallback​

DeleteNexusEndpointCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteNexusEndpointResponse

DeleteNexusEndpointResponse

Returns​

void

DeleteServiceAccount()​

DeleteServiceAccount = void

Delete a service account.

Call Signature​

DeleteServiceAccount(request, callback): void

Delete a service account.

Parameters​
request​

IDeleteServiceAccountRequest

callback​

DeleteServiceAccountCallback

Returns​

void

Call Signature​

DeleteServiceAccount(request): Promise<DeleteServiceAccountResponse>

Delete a service account.

Parameters​
request​

IDeleteServiceAccountRequest

Returns​

Promise<DeleteServiceAccountResponse>

Properties​

name​

readonly name: "DeleteServiceAccount"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteServiceAccount"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteServiceAccountRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteServiceAccountResponse"

DeleteServiceAccountCallback​

DeleteServiceAccountCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteServiceAccountResponse

DeleteServiceAccountResponse

Returns​

void

DeleteUser()​

DeleteUser = void

Delete a user

Call Signature​

DeleteUser(request, callback): void

Delete a user

Parameters​
request​

IDeleteUserRequest

callback​

DeleteUserCallback

Returns​

void

Call Signature​

DeleteUser(request): Promise<DeleteUserResponse>

Delete a user

Parameters​
request​

IDeleteUserRequest

Returns​

Promise<DeleteUserResponse>

Properties​

name​

readonly name: "DeleteUser"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteUser"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteUserRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteUserResponse"

DeleteUserCallback​

DeleteUserCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteUserResponse

DeleteUserResponse

Returns​

void

DeleteUserGroup()​

DeleteUserGroup = void

Delete a user group

Call Signature​

DeleteUserGroup(request, callback): void

Delete a user group

Parameters​
request​

IDeleteUserGroupRequest

callback​

DeleteUserGroupCallback

Returns​

void

Call Signature​

DeleteUserGroup(request): Promise<DeleteUserGroupResponse>

Delete a user group

Parameters​
request​

IDeleteUserGroupRequest

Returns​

Promise<DeleteUserGroupResponse>

Properties​

name​

readonly name: "DeleteUserGroup"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteUserGroup"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteUserGroupRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteUserGroupResponse"

DeleteUserGroupCallback​

DeleteUserGroupCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteUserGroupResponse

DeleteUserGroupResponse

Returns​

void

FailoverNamespaceRegion()​

FailoverNamespaceRegion = void

Failover a multi-region namespace

Call Signature​

FailoverNamespaceRegion(request, callback): void

Failover a multi-region namespace

Parameters​
request​

IFailoverNamespaceRegionRequest

callback​

FailoverNamespaceRegionCallback

Returns​

void

Call Signature​

FailoverNamespaceRegion(request): Promise<FailoverNamespaceRegionResponse>

Failover a multi-region namespace

Parameters​
request​

IFailoverNamespaceRegionRequest

Returns​

Promise<FailoverNamespaceRegionResponse>

Properties​

name​

readonly name: "FailoverNamespaceRegion"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/FailoverNamespaceRegion"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "FailoverNamespaceRegionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "FailoverNamespaceRegionResponse"

FailoverNamespaceRegionCallback​

FailoverNamespaceRegionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

FailoverNamespaceRegionResponse

FailoverNamespaceRegionResponse

Returns​

void

GetAccount()​

GetAccount = void

Get account information.

Call Signature​

GetAccount(request, callback): void

Get account information.

Parameters​
request​

IGetAccountRequest

callback​

GetAccountCallback

Returns​

void

Call Signature​

GetAccount(request): Promise<GetAccountResponse>

Get account information.

Parameters​
request​

IGetAccountRequest

Returns​

Promise<GetAccountResponse>

Properties​

name​

readonly name: "GetAccount"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetAccount"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetAccountRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetAccountResponse"

GetAccountAuditLogSink()​

GetAccountAuditLogSink = void

Get an audit log sink

Call Signature​

GetAccountAuditLogSink(request, callback): void

Get an audit log sink

Parameters​
request​

IGetAccountAuditLogSinkRequest

callback​

GetAccountAuditLogSinkCallback

Returns​

void

Call Signature​

GetAccountAuditLogSink(request): Promise<GetAccountAuditLogSinkResponse>

Get an audit log sink

Parameters​
request​

IGetAccountAuditLogSinkRequest

Returns​

Promise<GetAccountAuditLogSinkResponse>

Properties​

name​

readonly name: "GetAccountAuditLogSink"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetAccountAuditLogSink"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetAccountAuditLogSinkRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetAccountAuditLogSinkResponse"

GetAccountAuditLogSinkCallback​

GetAccountAuditLogSinkCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetAccountAuditLogSinkResponse

GetAccountAuditLogSinkResponse

Returns​

void

GetAccountAuditLogSinks()​

GetAccountAuditLogSinks = void

Get audit log sinks

Call Signature​

GetAccountAuditLogSinks(request, callback): void

Get audit log sinks

Parameters​
request​

IGetAccountAuditLogSinksRequest

callback​

GetAccountAuditLogSinksCallback

Returns​

void

Call Signature​

GetAccountAuditLogSinks(request): Promise<GetAccountAuditLogSinksResponse>

Get audit log sinks

Parameters​
request​

IGetAccountAuditLogSinksRequest

Returns​

Promise<GetAccountAuditLogSinksResponse>

Properties​

name​

readonly name: "GetAccountAuditLogSinks"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetAccountAuditLogSinks"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetAccountAuditLogSinksRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetAccountAuditLogSinksResponse"

GetAccountAuditLogSinksCallback​

GetAccountAuditLogSinksCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetAccountAuditLogSinksResponse

GetAccountAuditLogSinksResponse

Returns​

void

GetAccountCallback​

GetAccountCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetAccountResponse

GetAccountResponse

Returns​

void

GetApiKey()​

GetApiKey = void

Get an API key

Call Signature​

GetApiKey(request, callback): void

Get an API key

Parameters​
request​

IGetApiKeyRequest

callback​

GetApiKeyCallback

Returns​

void

Call Signature​

GetApiKey(request): Promise<GetApiKeyResponse>

Get an API key

Parameters​
request​

IGetApiKeyRequest

Returns​

Promise<GetApiKeyResponse>

Properties​

name​

readonly name: "GetApiKey"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetApiKey"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetApiKeyRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetApiKeyResponse"

GetApiKeyCallback​

GetApiKeyCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetApiKeyResponse

GetApiKeyResponse

Returns​

void

GetApiKeys()​

GetApiKeys = void

Get all known API keys

Call Signature​

GetApiKeys(request, callback): void

Get all known API keys

Parameters​
request​

IGetApiKeysRequest

callback​

GetApiKeysCallback

Returns​

void

Call Signature​

GetApiKeys(request): Promise<GetApiKeysResponse>

Get all known API keys

Parameters​
request​

IGetApiKeysRequest

Returns​

Promise<GetApiKeysResponse>

Properties​

name​

readonly name: "GetApiKeys"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetApiKeys"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetApiKeysRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetApiKeysResponse"

GetApiKeysCallback​

GetApiKeysCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetApiKeysResponse

GetApiKeysResponse

Returns​

void

GetAsyncOperation()​

GetAsyncOperation = void

Get the latest information on an async operation

Call Signature​

GetAsyncOperation(request, callback): void

Get the latest information on an async operation

Parameters​
request​

IGetAsyncOperationRequest

callback​

GetAsyncOperationCallback

Returns​

void

Call Signature​

GetAsyncOperation(request): Promise<GetAsyncOperationResponse>

Get the latest information on an async operation

Parameters​
request​

IGetAsyncOperationRequest

Returns​

Promise<GetAsyncOperationResponse>

Properties​

name​

readonly name: "GetAsyncOperation"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetAsyncOperation"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetAsyncOperationRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetAsyncOperationResponse"

GetAsyncOperationCallback​

GetAsyncOperationCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetAsyncOperationResponse

GetAsyncOperationResponse

Returns​

void

GetAuditLogs()​

GetAuditLogs = void

Get audit logs

Call Signature​

GetAuditLogs(request, callback): void

Get audit logs

Parameters​
request​

IGetAuditLogsRequest

callback​

GetAuditLogsCallback

Returns​

void

Call Signature​

GetAuditLogs(request): Promise<GetAuditLogsResponse>

Get audit logs

Parameters​
request​

IGetAuditLogsRequest

Returns​

Promise<GetAuditLogsResponse>

Properties​

name​

readonly name: "GetAuditLogs"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetAuditLogs"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetAuditLogsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetAuditLogsResponse"

GetAuditLogsCallback​

GetAuditLogsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetAuditLogsResponse

GetAuditLogsResponse

Returns​

void

GetBillingReport()​

GetBillingReport = void

Get a billing report

Call Signature​

GetBillingReport(request, callback): void

Get a billing report

Parameters​
request​

IGetBillingReportRequest

callback​

GetBillingReportCallback

Returns​

void

Call Signature​

GetBillingReport(request): Promise<GetBillingReportResponse>

Get a billing report

Parameters​
request​

IGetBillingReportRequest

Returns​

Promise<GetBillingReportResponse>

Properties​

name​

readonly name: "GetBillingReport"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetBillingReport"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetBillingReportRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetBillingReportResponse"

GetBillingReportCallback​

GetBillingReportCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetBillingReportResponse

GetBillingReportResponse

Returns​

void

GetConnectivityRule()​

GetConnectivityRule = void

Gets a connectivity rule by id

Call Signature​

GetConnectivityRule(request, callback): void

Gets a connectivity rule by id

Parameters​
request​

IGetConnectivityRuleRequest

callback​

GetConnectivityRuleCallback

Returns​

void

Call Signature​

GetConnectivityRule(request): Promise<GetConnectivityRuleResponse>

Gets a connectivity rule by id

Parameters​
request​

IGetConnectivityRuleRequest

Returns​

Promise<GetConnectivityRuleResponse>

Properties​

name​

readonly name: "GetConnectivityRule"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetConnectivityRule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetConnectivityRuleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetConnectivityRuleResponse"

GetConnectivityRuleCallback​

GetConnectivityRuleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetConnectivityRuleResponse

GetConnectivityRuleResponse

Returns​

void

GetConnectivityRules()​

GetConnectivityRules = void

Lists connectivity rules by account

Call Signature​

GetConnectivityRules(request, callback): void

Lists connectivity rules by account

Parameters​
request​

IGetConnectivityRulesRequest

callback​

GetConnectivityRulesCallback

Returns​

void

Call Signature​

GetConnectivityRules(request): Promise<GetConnectivityRulesResponse>

Lists connectivity rules by account

Parameters​
request​

IGetConnectivityRulesRequest

Returns​

Promise<GetConnectivityRulesResponse>

Properties​

name​

readonly name: "GetConnectivityRules"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetConnectivityRules"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetConnectivityRulesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetConnectivityRulesResponse"

GetConnectivityRulesCallback​

GetConnectivityRulesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetConnectivityRulesResponse

GetConnectivityRulesResponse

Returns​

void

GetCurrentIdentity()​

GetCurrentIdentity = void

Get information about the current authenticated user or service account principal

Call Signature​

GetCurrentIdentity(request, callback): void

Get information about the current authenticated user or service account principal

Parameters​
request​

IGetCurrentIdentityRequest

callback​

GetCurrentIdentityCallback

Returns​

void

Call Signature​

GetCurrentIdentity(request): Promise<GetCurrentIdentityResponse>

Get information about the current authenticated user or service account principal

Parameters​
request​

IGetCurrentIdentityRequest

Returns​

Promise<GetCurrentIdentityResponse>

Properties​

name​

readonly name: "GetCurrentIdentity"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetCurrentIdentity"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetCurrentIdentityRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetCurrentIdentityResponse"

GetCurrentIdentityCallback​

GetCurrentIdentityCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetCurrentIdentityResponse

GetCurrentIdentityResponse

Returns​

void

GetCustomRole()​

GetCustomRole = void

Get a custom role

Call Signature​

GetCustomRole(request, callback): void

Get a custom role

Parameters​
request​

IGetCustomRoleRequest

callback​

GetCustomRoleCallback

Returns​

void

Call Signature​

GetCustomRole(request): Promise<GetCustomRoleResponse>

Get a custom role

Parameters​
request​

IGetCustomRoleRequest

Returns​

Promise<GetCustomRoleResponse>

Properties​

name​

readonly name: "GetCustomRole"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetCustomRole"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetCustomRoleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetCustomRoleResponse"

GetCustomRoleCallback​

GetCustomRoleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetCustomRoleResponse

GetCustomRoleResponse

Returns​

void

GetCustomRoles()​

GetCustomRoles = void

Get custom roles

Call Signature​

GetCustomRoles(request, callback): void

Get custom roles

Parameters​
request​

IGetCustomRolesRequest

callback​

GetCustomRolesCallback

Returns​

void

Call Signature​

GetCustomRoles(request): Promise<GetCustomRolesResponse>

Get custom roles

Parameters​
request​

IGetCustomRolesRequest

Returns​

Promise<GetCustomRolesResponse>

Properties​

name​

readonly name: "GetCustomRoles"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetCustomRoles"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetCustomRolesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetCustomRolesResponse"

GetCustomRolesCallback​

GetCustomRolesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetCustomRolesResponse

GetCustomRolesResponse

Returns​

void

GetNamespace()​

GetNamespace = void

Get a namespace

Call Signature​

GetNamespace(request, callback): void

Get a namespace

Parameters​
request​

IGetNamespaceRequest

callback​

GetNamespaceCallback

Returns​

void

Call Signature​

GetNamespace(request): Promise<GetNamespaceResponse>

Get a namespace

Parameters​
request​

IGetNamespaceRequest

Returns​

Promise<GetNamespaceResponse>

Properties​

name​

readonly name: "GetNamespace"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespace"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetNamespaceRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetNamespaceResponse"

GetNamespaceCallback​

GetNamespaceCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetNamespaceResponse

GetNamespaceResponse

Returns​

void

GetNamespaceCapacityInfo()​

GetNamespaceCapacityInfo = void

Get namespace capacity information

Call Signature​

GetNamespaceCapacityInfo(request, callback): void

Get namespace capacity information

Parameters​
request​

IGetNamespaceCapacityInfoRequest

callback​

GetNamespaceCapacityInfoCallback

Returns​

void

Call Signature​

GetNamespaceCapacityInfo(request): Promise<GetNamespaceCapacityInfoResponse>

Get namespace capacity information

Parameters​
request​

IGetNamespaceCapacityInfoRequest

Returns​

Promise<GetNamespaceCapacityInfoResponse>

Properties​

name​

readonly name: "GetNamespaceCapacityInfo"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaceCapacityInfo"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetNamespaceCapacityInfoRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetNamespaceCapacityInfoResponse"

GetNamespaceCapacityInfoCallback​

GetNamespaceCapacityInfoCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetNamespaceCapacityInfoResponse

GetNamespaceCapacityInfoResponse

Returns​

void

GetNamespaceExportSink()​

GetNamespaceExportSink = void

Get an export sink

Call Signature​

GetNamespaceExportSink(request, callback): void

Get an export sink

Parameters​
request​

IGetNamespaceExportSinkRequest

callback​

GetNamespaceExportSinkCallback

Returns​

void

Call Signature​

GetNamespaceExportSink(request): Promise<GetNamespaceExportSinkResponse>

Get an export sink

Parameters​
request​

IGetNamespaceExportSinkRequest

Returns​

Promise<GetNamespaceExportSinkResponse>

Properties​

name​

readonly name: "GetNamespaceExportSink"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaceExportSink"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetNamespaceExportSinkRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetNamespaceExportSinkResponse"

GetNamespaceExportSinkCallback​

GetNamespaceExportSinkCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetNamespaceExportSinkResponse

GetNamespaceExportSinkResponse

Returns​

void

GetNamespaceExportSinks()​

GetNamespaceExportSinks = void

Get export sinks

Call Signature​

GetNamespaceExportSinks(request, callback): void

Get export sinks

Parameters​
request​

IGetNamespaceExportSinksRequest

callback​

GetNamespaceExportSinksCallback

Returns​

void

Call Signature​

GetNamespaceExportSinks(request): Promise<GetNamespaceExportSinksResponse>

Get export sinks

Parameters​
request​

IGetNamespaceExportSinksRequest

Returns​

Promise<GetNamespaceExportSinksResponse>

Properties​

name​

readonly name: "GetNamespaceExportSinks"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaceExportSinks"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetNamespaceExportSinksRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetNamespaceExportSinksResponse"

GetNamespaceExportSinksCallback​

GetNamespaceExportSinksCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetNamespaceExportSinksResponse

GetNamespaceExportSinksResponse

Returns​

void

GetNamespaces()​

GetNamespaces = void

Get all namespaces

Call Signature​

GetNamespaces(request, callback): void

Get all namespaces

Parameters​
request​

IGetNamespacesRequest

callback​

GetNamespacesCallback

Returns​

void

Call Signature​

GetNamespaces(request): Promise<GetNamespacesResponse>

Get all namespaces

Parameters​
request​

IGetNamespacesRequest

Returns​

Promise<GetNamespacesResponse>

Properties​

name​

readonly name: "GetNamespaces"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaces"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetNamespacesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetNamespacesResponse"

GetNamespacesCallback​

GetNamespacesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetNamespacesResponse

GetNamespacesResponse

Returns​

void

GetNexusEndpoint()​

GetNexusEndpoint = void

Get a nexus endpoint

Call Signature​

GetNexusEndpoint(request, callback): void

Get a nexus endpoint

Parameters​
request​

IGetNexusEndpointRequest

callback​

GetNexusEndpointCallback

Returns​

void

Call Signature​

GetNexusEndpoint(request): Promise<GetNexusEndpointResponse>

Get a nexus endpoint

Parameters​
request​

IGetNexusEndpointRequest

Returns​

Promise<GetNexusEndpointResponse>

Properties​

name​

readonly name: "GetNexusEndpoint"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetNexusEndpoint"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetNexusEndpointRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetNexusEndpointResponse"

GetNexusEndpointCallback​

GetNexusEndpointCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetNexusEndpointResponse

GetNexusEndpointResponse

Returns​

void

GetNexusEndpoints()​

GetNexusEndpoints = void

Gets nexus endpoints

Call Signature​

GetNexusEndpoints(request, callback): void

Gets nexus endpoints

Parameters​
request​

IGetNexusEndpointsRequest

callback​

GetNexusEndpointsCallback

Returns​

void

Call Signature​

GetNexusEndpoints(request): Promise<GetNexusEndpointsResponse>

Gets nexus endpoints

Parameters​
request​

IGetNexusEndpointsRequest

Returns​

Promise<GetNexusEndpointsResponse>

Properties​

name​

readonly name: "GetNexusEndpoints"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetNexusEndpoints"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetNexusEndpointsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetNexusEndpointsResponse"

GetNexusEndpointsCallback​

GetNexusEndpointsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetNexusEndpointsResponse

GetNexusEndpointsResponse

Returns​

void

GetRegion()​

GetRegion = void

Get a region

Call Signature​

GetRegion(request, callback): void

Get a region

Parameters​
request​

IGetRegionRequest

callback​

GetRegionCallback

Returns​

void

Call Signature​

GetRegion(request): Promise<GetRegionResponse>

Get a region

Parameters​
request​

IGetRegionRequest

Returns​

Promise<GetRegionResponse>

Properties​

name​

readonly name: "GetRegion"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetRegion"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetRegionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetRegionResponse"

GetRegionCallback​

GetRegionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetRegionResponse

GetRegionResponse

Returns​

void

GetRegions()​

GetRegions = void

Get all regions

Call Signature​

GetRegions(request, callback): void

Get all regions

Parameters​
request​

IGetRegionsRequest

callback​

GetRegionsCallback

Returns​

void

Call Signature​

GetRegions(request): Promise<GetRegionsResponse>

Get all regions

Parameters​
request​

IGetRegionsRequest

Returns​

Promise<GetRegionsResponse>

Properties​

name​

readonly name: "GetRegions"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetRegions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetRegionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetRegionsResponse"

GetRegionsCallback​

GetRegionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetRegionsResponse

GetRegionsResponse

Returns​

void

GetServiceAccount()​

GetServiceAccount = void

Get a service account.

Call Signature​

GetServiceAccount(request, callback): void

Get a service account.

Parameters​
request​

IGetServiceAccountRequest

callback​

GetServiceAccountCallback

Returns​

void

Call Signature​

GetServiceAccount(request): Promise<GetServiceAccountResponse>

Get a service account.

Parameters​
request​

IGetServiceAccountRequest

Returns​

Promise<GetServiceAccountResponse>

Properties​

name​

readonly name: "GetServiceAccount"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetServiceAccount"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetServiceAccountRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetServiceAccountResponse"

GetServiceAccountCallback​

GetServiceAccountCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetServiceAccountResponse

GetServiceAccountResponse

Returns​

void

GetServiceAccountNamespaceAssignments()​

GetServiceAccountNamespaceAssignments = void

Get service accounts with access to a namespace

Call Signature​

GetServiceAccountNamespaceAssignments(request, callback): void

Get service accounts with access to a namespace

Parameters​
request​

IGetServiceAccountNamespaceAssignmentsRequest

callback​

GetServiceAccountNamespaceAssignmentsCallback

Returns​

void

Call Signature​

GetServiceAccountNamespaceAssignments(request): Promise<GetServiceAccountNamespaceAssignmentsResponse>

Get service accounts with access to a namespace

Parameters​
request​

IGetServiceAccountNamespaceAssignmentsRequest

Returns​

Promise<GetServiceAccountNamespaceAssignmentsResponse>

Properties​

name​

readonly name: "GetServiceAccountNamespaceAssignments"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetServiceAccountNamespaceAssignments"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetServiceAccountNamespaceAssignmentsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetServiceAccountNamespaceAssignmentsResponse"

GetServiceAccountNamespaceAssignmentsCallback​

GetServiceAccountNamespaceAssignmentsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetServiceAccountNamespaceAssignmentsResponse

GetServiceAccountNamespaceAssignmentsResponse

Returns​

void

GetServiceAccounts()​

GetServiceAccounts = void

Get service accounts.

Call Signature​

GetServiceAccounts(request, callback): void

Get service accounts.

Parameters​
request​

IGetServiceAccountsRequest

callback​

GetServiceAccountsCallback

Returns​

void

Call Signature​

GetServiceAccounts(request): Promise<GetServiceAccountsResponse>

Get service accounts.

Parameters​
request​

IGetServiceAccountsRequest

Returns​

Promise<GetServiceAccountsResponse>

Properties​

name​

readonly name: "GetServiceAccounts"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetServiceAccounts"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetServiceAccountsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetServiceAccountsResponse"

GetServiceAccountsCallback​

GetServiceAccountsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetServiceAccountsResponse

GetServiceAccountsResponse

Returns​

void

GetUsage()​

GetUsage = void

WARNING: Pre-Release Feature Get usage data across namespaces

Call Signature​

GetUsage(request, callback): void

WARNING: Pre-Release Feature Get usage data across namespaces

Parameters​
request​

IGetUsageRequest

callback​

GetUsageCallback

Returns​

void

Call Signature​

GetUsage(request): Promise<GetUsageResponse>

WARNING: Pre-Release Feature Get usage data across namespaces

Parameters​
request​

IGetUsageRequest

Returns​

Promise<GetUsageResponse>

Properties​

name​

readonly name: "GetUsage"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetUsage"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetUsageRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetUsageResponse"

GetUsageCallback​

GetUsageCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetUsageResponse

GetUsageResponse

Returns​

void

GetUser()​

GetUser = void

Get a user

Call Signature​

GetUser(request, callback): void

Get a user

Parameters​
request​

IGetUserRequest

callback​

GetUserCallback

Returns​

void

Call Signature​

GetUser(request): Promise<GetUserResponse>

Get a user

Parameters​
request​

IGetUserRequest

Returns​

Promise<GetUserResponse>

Properties​

name​

readonly name: "GetUser"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetUser"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetUserRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetUserResponse"

GetUserCallback​

GetUserCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetUserResponse

GetUserResponse

Returns​

void

GetUserGroup()​

GetUserGroup = void

Get a user group

Call Signature​

GetUserGroup(request, callback): void

Get a user group

Parameters​
request​

IGetUserGroupRequest

callback​

GetUserGroupCallback

Returns​

void

Call Signature​

GetUserGroup(request): Promise<GetUserGroupResponse>

Get a user group

Parameters​
request​

IGetUserGroupRequest

Returns​

Promise<GetUserGroupResponse>

Properties​

name​

readonly name: "GetUserGroup"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroup"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetUserGroupRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetUserGroupResponse"

GetUserGroupCallback​

GetUserGroupCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetUserGroupResponse

GetUserGroupResponse

Returns​

void

GetUserGroupMembers()​

GetUserGroupMembers = void

Calls GetUserGroupMembers.

Call Signature​

GetUserGroupMembers(request, callback): void

Calls GetUserGroupMembers.

Parameters​
request​

IGetUserGroupMembersRequest

callback​

GetUserGroupMembersCallback

Returns​

void

Call Signature​

GetUserGroupMembers(request): Promise<GetUserGroupMembersResponse>

Calls GetUserGroupMembers.

Parameters​
request​

IGetUserGroupMembersRequest

Returns​

Promise<GetUserGroupMembersResponse>

Properties​

name​

readonly name: "GetUserGroupMembers"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroupMembers"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetUserGroupMembersRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetUserGroupMembersResponse"

GetUserGroupMembersCallback​

GetUserGroupMembersCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetUserGroupMembersResponse

GetUserGroupMembersResponse

Returns​

void

GetUserGroupNamespaceAssignments()​

GetUserGroupNamespaceAssignments = void

Get user groups with access to a namespace

Call Signature​

GetUserGroupNamespaceAssignments(request, callback): void

Get user groups with access to a namespace

Parameters​
request​

IGetUserGroupNamespaceAssignmentsRequest

callback​

GetUserGroupNamespaceAssignmentsCallback

Returns​

void

Call Signature​

GetUserGroupNamespaceAssignments(request): Promise<GetUserGroupNamespaceAssignmentsResponse>

Get user groups with access to a namespace

Parameters​
request​

IGetUserGroupNamespaceAssignmentsRequest

Returns​

Promise<GetUserGroupNamespaceAssignmentsResponse>

Properties​

name​

readonly name: "GetUserGroupNamespaceAssignments"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroupNamespaceAssignments"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetUserGroupNamespaceAssignmentsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetUserGroupNamespaceAssignmentsResponse"

GetUserGroupNamespaceAssignmentsCallback​

GetUserGroupNamespaceAssignmentsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetUserGroupNamespaceAssignmentsResponse

GetUserGroupNamespaceAssignmentsResponse

Returns​

void

GetUserGroups()​

GetUserGroups = void

Get all user groups

Call Signature​

GetUserGroups(request, callback): void

Get all user groups

Parameters​
request​

IGetUserGroupsRequest

callback​

GetUserGroupsCallback

Returns​

void

Call Signature​

GetUserGroups(request): Promise<GetUserGroupsResponse>

Get all user groups

Parameters​
request​

IGetUserGroupsRequest

Returns​

Promise<GetUserGroupsResponse>

Properties​

name​

readonly name: "GetUserGroups"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroups"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetUserGroupsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetUserGroupsResponse"

GetUserGroupsCallback​

GetUserGroupsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetUserGroupsResponse

GetUserGroupsResponse

Returns​

void

GetUserNamespaceAssignments()​

GetUserNamespaceAssignments = void

Get users with access to a namespace

Call Signature​

GetUserNamespaceAssignments(request, callback): void

Get users with access to a namespace

Parameters​
request​

IGetUserNamespaceAssignmentsRequest

callback​

GetUserNamespaceAssignmentsCallback

Returns​

void

Call Signature​

GetUserNamespaceAssignments(request): Promise<GetUserNamespaceAssignmentsResponse>

Get users with access to a namespace

Parameters​
request​

IGetUserNamespaceAssignmentsRequest

Returns​

Promise<GetUserNamespaceAssignmentsResponse>

Properties​

name​

readonly name: "GetUserNamespaceAssignments"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetUserNamespaceAssignments"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetUserNamespaceAssignmentsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetUserNamespaceAssignmentsResponse"

GetUserNamespaceAssignmentsCallback​

GetUserNamespaceAssignmentsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetUserNamespaceAssignmentsResponse

GetUserNamespaceAssignmentsResponse

Returns​

void

GetUsers()​

GetUsers = void

Gets all known users

Call Signature​

GetUsers(request, callback): void

Gets all known users

Parameters​
request​

IGetUsersRequest

callback​

GetUsersCallback

Returns​

void

Call Signature​

GetUsers(request): Promise<GetUsersResponse>

Gets all known users

Parameters​
request​

IGetUsersRequest

Returns​

Promise<GetUsersResponse>

Properties​

name​

readonly name: "GetUsers"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/GetUsers"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetUsersRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetUsersResponse"

GetUsersCallback​

GetUsersCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetUsersResponse

GetUsersResponse

Returns​

void

RemoveUserGroupMember()​

RemoveUserGroupMember = void

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

Call Signature​

RemoveUserGroupMember(request, callback): void

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

Parameters​
request​

IRemoveUserGroupMemberRequest

callback​

RemoveUserGroupMemberCallback

Returns​

void

Call Signature​

RemoveUserGroupMember(request): Promise<RemoveUserGroupMemberResponse>

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

Parameters​
request​

IRemoveUserGroupMemberRequest

Returns​

Promise<RemoveUserGroupMemberResponse>

Properties​

name​

readonly name: "RemoveUserGroupMember"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/RemoveUserGroupMember"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RemoveUserGroupMemberRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RemoveUserGroupMemberResponse"

RemoveUserGroupMemberCallback​

RemoveUserGroupMemberCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RemoveUserGroupMemberResponse

RemoveUserGroupMemberResponse

Returns​

void

RenameCustomSearchAttribute()​

RenameCustomSearchAttribute = void

Rename an existing customer search attribute

Call Signature​

RenameCustomSearchAttribute(request, callback): void

Rename an existing customer search attribute

Parameters​
request​

IRenameCustomSearchAttributeRequest

callback​

RenameCustomSearchAttributeCallback

Returns​

void

Call Signature​

RenameCustomSearchAttribute(request): Promise<RenameCustomSearchAttributeResponse>

Rename an existing customer search attribute

Parameters​
request​

IRenameCustomSearchAttributeRequest

Returns​

Promise<RenameCustomSearchAttributeResponse>

Properties​

name​

readonly name: "RenameCustomSearchAttribute"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/RenameCustomSearchAttribute"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RenameCustomSearchAttributeRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RenameCustomSearchAttributeResponse"

RenameCustomSearchAttributeCallback​

RenameCustomSearchAttributeCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RenameCustomSearchAttributeResponse

RenameCustomSearchAttributeResponse

Returns​

void

SetServiceAccountNamespaceAccess()​

SetServiceAccountNamespaceAccess = void

Set a service account's access to a namespace.

Call Signature​

SetServiceAccountNamespaceAccess(request, callback): void

Set a service account's access to a namespace.

Parameters​
request​

ISetServiceAccountNamespaceAccessRequest

callback​

SetServiceAccountNamespaceAccessCallback

Returns​

void

Call Signature​

SetServiceAccountNamespaceAccess(request): Promise<SetServiceAccountNamespaceAccessResponse>

Set a service account's access to a namespace.

Parameters​
request​

ISetServiceAccountNamespaceAccessRequest

Returns​

Promise<SetServiceAccountNamespaceAccessResponse>

Properties​

name​

readonly name: "SetServiceAccountNamespaceAccess"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/SetServiceAccountNamespaceAccess"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "SetServiceAccountNamespaceAccessRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "SetServiceAccountNamespaceAccessResponse"

SetServiceAccountNamespaceAccessCallback​

SetServiceAccountNamespaceAccessCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

SetServiceAccountNamespaceAccessResponse

SetServiceAccountNamespaceAccessResponse

Returns​

void

SetUserGroupNamespaceAccess()​

SetUserGroupNamespaceAccess = void

Set a user group's access to a namespace

Call Signature​

SetUserGroupNamespaceAccess(request, callback): void

Set a user group's access to a namespace

Parameters​
request​

ISetUserGroupNamespaceAccessRequest

callback​

SetUserGroupNamespaceAccessCallback

Returns​

void

Call Signature​

SetUserGroupNamespaceAccess(request): Promise<SetUserGroupNamespaceAccessResponse>

Set a user group's access to a namespace

Parameters​
request​

ISetUserGroupNamespaceAccessRequest

Returns​

Promise<SetUserGroupNamespaceAccessResponse>

Properties​

name​

readonly name: "SetUserGroupNamespaceAccess"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/SetUserGroupNamespaceAccess"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "SetUserGroupNamespaceAccessRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "SetUserGroupNamespaceAccessResponse"

SetUserGroupNamespaceAccessCallback​

SetUserGroupNamespaceAccessCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

SetUserGroupNamespaceAccessResponse

SetUserGroupNamespaceAccessResponse

Returns​

void

SetUserNamespaceAccess()​

SetUserNamespaceAccess = void

Set a user's access to a namespace

Call Signature​

SetUserNamespaceAccess(request, callback): void

Set a user's access to a namespace

Parameters​
request​

ISetUserNamespaceAccessRequest

callback​

SetUserNamespaceAccessCallback

Returns​

void

Call Signature​

SetUserNamespaceAccess(request): Promise<SetUserNamespaceAccessResponse>

Set a user's access to a namespace

Parameters​
request​

ISetUserNamespaceAccessRequest

Returns​

Promise<SetUserNamespaceAccessResponse>

Properties​

name​

readonly name: "SetUserNamespaceAccess"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/SetUserNamespaceAccess"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "SetUserNamespaceAccessRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "SetUserNamespaceAccessResponse"

SetUserNamespaceAccessCallback​

SetUserNamespaceAccessCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

SetUserNamespaceAccessResponse

SetUserNamespaceAccessResponse

Returns​

void

UpdateAccount()​

UpdateAccount = void

Update account information.

Call Signature​

UpdateAccount(request, callback): void

Update account information.

Parameters​
request​

IUpdateAccountRequest

callback​

UpdateAccountCallback

Returns​

void

Call Signature​

UpdateAccount(request): Promise<UpdateAccountResponse>

Update account information.

Parameters​
request​

IUpdateAccountRequest

Returns​

Promise<UpdateAccountResponse>

Properties​

name​

readonly name: "UpdateAccount"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateAccount"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateAccountRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateAccountResponse"

UpdateAccountAuditLogSink()​

UpdateAccountAuditLogSink = void

Update an audit log sink

Call Signature​

UpdateAccountAuditLogSink(request, callback): void

Update an audit log sink

Parameters​
request​

IUpdateAccountAuditLogSinkRequest

callback​

UpdateAccountAuditLogSinkCallback

Returns​

void

Call Signature​

UpdateAccountAuditLogSink(request): Promise<UpdateAccountAuditLogSinkResponse>

Update an audit log sink

Parameters​
request​

IUpdateAccountAuditLogSinkRequest

Returns​

Promise<UpdateAccountAuditLogSinkResponse>

Properties​

name​

readonly name: "UpdateAccountAuditLogSink"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateAccountAuditLogSink"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateAccountAuditLogSinkRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateAccountAuditLogSinkResponse"

UpdateAccountAuditLogSinkCallback​

UpdateAccountAuditLogSinkCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateAccountAuditLogSinkResponse

UpdateAccountAuditLogSinkResponse

Returns​

void

UpdateAccountCallback​

UpdateAccountCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateAccountResponse

UpdateAccountResponse

Returns​

void

UpdateApiKey()​

UpdateApiKey = void

Update an API key

Call Signature​

UpdateApiKey(request, callback): void

Update an API key

Parameters​
request​

IUpdateApiKeyRequest

callback​

UpdateApiKeyCallback

Returns​

void

Call Signature​

UpdateApiKey(request): Promise<UpdateApiKeyResponse>

Update an API key

Parameters​
request​

IUpdateApiKeyRequest

Returns​

Promise<UpdateApiKeyResponse>

Properties​

name​

readonly name: "UpdateApiKey"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateApiKey"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateApiKeyRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateApiKeyResponse"

UpdateApiKeyCallback​

UpdateApiKeyCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateApiKeyResponse

UpdateApiKeyResponse

Returns​

void

UpdateCustomRole()​

UpdateCustomRole = void

Update a custom role

Call Signature​

UpdateCustomRole(request, callback): void

Update a custom role

Parameters​
request​

IUpdateCustomRoleRequest

callback​

UpdateCustomRoleCallback

Returns​

void

Call Signature​

UpdateCustomRole(request): Promise<UpdateCustomRoleResponse>

Update a custom role

Parameters​
request​

IUpdateCustomRoleRequest

Returns​

Promise<UpdateCustomRoleResponse>

Properties​

name​

readonly name: "UpdateCustomRole"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateCustomRole"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateCustomRoleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateCustomRoleResponse"

UpdateCustomRoleCallback​

UpdateCustomRoleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateCustomRoleResponse

UpdateCustomRoleResponse

Returns​

void

UpdateNamespace()​

UpdateNamespace = void

Update a namespace

Call Signature​

UpdateNamespace(request, callback): void

Update a namespace

Parameters​
request​

IUpdateNamespaceRequest

callback​

UpdateNamespaceCallback

Returns​

void

Call Signature​

UpdateNamespace(request): Promise<UpdateNamespaceResponse>

Update a namespace

Parameters​
request​

IUpdateNamespaceRequest

Returns​

Promise<UpdateNamespaceResponse>

Properties​

name​

readonly name: "UpdateNamespace"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNamespace"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateNamespaceRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateNamespaceResponse"

UpdateNamespaceCallback​

UpdateNamespaceCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateNamespaceResponse

UpdateNamespaceResponse

Returns​

void

UpdateNamespaceExportSink()​

UpdateNamespaceExportSink = void

Update an export sink

Call Signature​

UpdateNamespaceExportSink(request, callback): void

Update an export sink

Parameters​
request​

IUpdateNamespaceExportSinkRequest

callback​

UpdateNamespaceExportSinkCallback

Returns​

void

Call Signature​

UpdateNamespaceExportSink(request): Promise<UpdateNamespaceExportSinkResponse>

Update an export sink

Parameters​
request​

IUpdateNamespaceExportSinkRequest

Returns​

Promise<UpdateNamespaceExportSinkResponse>

Properties​

name​

readonly name: "UpdateNamespaceExportSink"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNamespaceExportSink"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateNamespaceExportSinkRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateNamespaceExportSinkResponse"

UpdateNamespaceExportSinkCallback​

UpdateNamespaceExportSinkCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateNamespaceExportSinkResponse

UpdateNamespaceExportSinkResponse

Returns​

void

UpdateNamespaceTags()​

UpdateNamespaceTags = void

Update the tags for a namespace

Call Signature​

UpdateNamespaceTags(request, callback): void

Update the tags for a namespace

Parameters​
request​

IUpdateNamespaceTagsRequest

callback​

UpdateNamespaceTagsCallback

Returns​

void

Call Signature​

UpdateNamespaceTags(request): Promise<UpdateNamespaceTagsResponse>

Update the tags for a namespace

Parameters​
request​

IUpdateNamespaceTagsRequest

Returns​

Promise<UpdateNamespaceTagsResponse>

Properties​

name​

readonly name: "UpdateNamespaceTags"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNamespaceTags"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateNamespaceTagsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateNamespaceTagsResponse"

UpdateNamespaceTagsCallback​

UpdateNamespaceTagsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateNamespaceTagsResponse

UpdateNamespaceTagsResponse

Returns​

void

UpdateNexusEndpoint()​

UpdateNexusEndpoint = void

Update a nexus endpoint

Call Signature​

UpdateNexusEndpoint(request, callback): void

Update a nexus endpoint

Parameters​
request​

IUpdateNexusEndpointRequest

callback​

UpdateNexusEndpointCallback

Returns​

void

Call Signature​

UpdateNexusEndpoint(request): Promise<UpdateNexusEndpointResponse>

Update a nexus endpoint

Parameters​
request​

IUpdateNexusEndpointRequest

Returns​

Promise<UpdateNexusEndpointResponse>

Properties​

name​

readonly name: "UpdateNexusEndpoint"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNexusEndpoint"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateNexusEndpointRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateNexusEndpointResponse"

UpdateNexusEndpointCallback​

UpdateNexusEndpointCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateNexusEndpointResponse

UpdateNexusEndpointResponse

Returns​

void

UpdateServiceAccount()​

UpdateServiceAccount = void

Update a service account.

Call Signature​

UpdateServiceAccount(request, callback): void

Update a service account.

Parameters​
request​

IUpdateServiceAccountRequest

callback​

UpdateServiceAccountCallback

Returns​

void

Call Signature​

UpdateServiceAccount(request): Promise<UpdateServiceAccountResponse>

Update a service account.

Parameters​
request​

IUpdateServiceAccountRequest

Returns​

Promise<UpdateServiceAccountResponse>

Properties​

name​

readonly name: "UpdateServiceAccount"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateServiceAccount"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateServiceAccountRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateServiceAccountResponse"

UpdateServiceAccountCallback​

UpdateServiceAccountCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateServiceAccountResponse

UpdateServiceAccountResponse

Returns​

void

UpdateUser()​

UpdateUser = void

Update a user

Call Signature​

UpdateUser(request, callback): void

Update a user

Parameters​
request​

IUpdateUserRequest

callback​

UpdateUserCallback

Returns​

void

Call Signature​

UpdateUser(request): Promise<UpdateUserResponse>

Update a user

Parameters​
request​

IUpdateUserRequest

Returns​

Promise<UpdateUserResponse>

Properties​

name​

readonly name: "UpdateUser"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateUser"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateUserRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateUserResponse"

UpdateUserCallback​

UpdateUserCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateUserResponse

UpdateUserResponse

Returns​

void

UpdateUserGroup()​

UpdateUserGroup = void

Update a user group

Call Signature​

UpdateUserGroup(request, callback): void

Update a user group

Parameters​
request​

IUpdateUserGroupRequest

callback​

UpdateUserGroupCallback

Returns​

void

Call Signature​

UpdateUserGroup(request): Promise<UpdateUserGroupResponse>

Update a user group

Parameters​
request​

IUpdateUserGroupRequest

Returns​

Promise<UpdateUserGroupResponse>

Properties​

name​

readonly name: "UpdateUserGroup"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateUserGroup"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateUserGroupRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateUserGroupResponse"

UpdateUserGroupCallback​

UpdateUserGroupCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateUserGroupResponse

UpdateUserGroupResponse

Returns​

void

ValidateAccountAuditLogSink()​

ValidateAccountAuditLogSink = void

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​

ValidateAccountAuditLogSink(request, callback): void

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.

Parameters​
request​

IValidateAccountAuditLogSinkRequest

callback​

ValidateAccountAuditLogSinkCallback

Returns​

void

Call Signature​

ValidateAccountAuditLogSink(request): Promise<ValidateAccountAuditLogSinkResponse>

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.

Parameters​
request​

IValidateAccountAuditLogSinkRequest

Returns​

Promise<ValidateAccountAuditLogSinkResponse>

Properties​

name​

readonly name: "ValidateAccountAuditLogSink"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/ValidateAccountAuditLogSink"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ValidateAccountAuditLogSinkRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ValidateAccountAuditLogSinkResponse"

ValidateAccountAuditLogSinkCallback​

ValidateAccountAuditLogSinkCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ValidateAccountAuditLogSinkResponse

ValidateAccountAuditLogSinkResponse

Returns​

void

ValidateNamespaceExportSink()​

ValidateNamespaceExportSink = void

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​

ValidateNamespaceExportSink(request, callback): void

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.

Parameters​
request​

IValidateNamespaceExportSinkRequest

callback​

ValidateNamespaceExportSinkCallback

Returns​

void

Call Signature​

ValidateNamespaceExportSink(request): Promise<ValidateNamespaceExportSinkResponse>

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.

Parameters​
request​

IValidateNamespaceExportSinkRequest

Returns​

Promise<ValidateNamespaceExportSinkResponse>

Properties​

name​

readonly name: "ValidateNamespaceExportSink"

path​

readonly path: "/temporal.api.cloud.cloudservice.v1.CloudService/ValidateNamespaceExportSink"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ValidateNamespaceExportSinkRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ValidateNamespaceExportSinkResponse"

ValidateNamespaceExportSinkCallback​

ValidateNamespaceExportSinkCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ValidateNamespaceExportSinkResponse

ValidateNamespaceExportSinkResponse

Returns​

void