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
| Name | Type |
|---|---|
request | IAddNamespaceRegionRequest |
callback | AddNamespaceRegionCallback |
Returns
void
▸ (request): Promise<AddNamespaceRegionResponse>
Parameters
| Name | Type |
|---|---|
request | IAddNamespaceRegionRequest |
Returns
Promise<AddNamespaceRegionResponse>
Type declaration
| Name | Type |
|---|---|
name | "AddNamespaceRegion" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/AddNamespaceRegion" |
requestStream | undefined |
requestType | "AddNamespaceRegionRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | AddNamespaceRegionResponse | AddNamespaceRegionResponse |
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
| Name | Type |
|---|---|
request | IAddUserGroupMemberRequest |
callback | AddUserGroupMemberCallback |
Returns
void
▸ (request): Promise<AddUserGroupMemberResponse>
Parameters
| Name | Type |
|---|---|
request | IAddUserGroupMemberRequest |
Returns
Promise<AddUserGroupMemberResponse>
Type declaration
| Name | Type |
|---|---|
name | "AddUserGroupMember" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/AddUserGroupMember" |
requestStream | undefined |
requestType | "AddUserGroupMemberRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | AddUserGroupMemberResponse | AddUserGroupMemberResponse |
Returns
void
CreateAccountAuditLogSink
Ƭ CreateAccountAuditLogSink: Object
Create an audit log sink
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ICreateAccountAuditLogSinkRequest |
callback | CreateAccountAuditLogSinkCallback |
Returns
void
▸ (request): Promise<CreateAccountAuditLogSinkResponse>
Parameters
| Name | Type |
|---|---|
request | ICreateAccountAuditLogSinkRequest |
Returns
Promise<CreateAccountAuditLogSinkResponse>
Type declaration
| Name | Type |
|---|---|
name | "CreateAccountAuditLogSink" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/CreateAccountAuditLogSink" |
requestStream | undefined |
requestType | "CreateAccountAuditLogSinkRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateAccountAuditLogSinkResponse | CreateAccountAuditLogSinkResponse |
Returns
void
CreateApiKey
Ƭ CreateApiKey: Object
Create an API key
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ICreateApiKeyRequest |
callback | CreateApiKeyCallback |
Returns
void
▸ (request): Promise<CreateApiKeyResponse>
Parameters
| Name | Type |
|---|---|
request | ICreateApiKeyRequest |
Returns
Promise<CreateApiKeyResponse>
Type declaration
| Name | Type |
|---|---|
name | "CreateApiKey" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/CreateApiKey" |
requestStream | undefined |
requestType | "CreateApiKeyRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateApiKeyResponse | CreateApiKeyResponse |
Returns
void
CreateBillingReport
Ƭ CreateBillingReport: Object
Create a billing report
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ICreateBillingReportRequest |
callback | CreateBillingReportCallback |
Returns
void
▸ (request): Promise<CreateBillingReportResponse>
Parameters
| Name | Type |
|---|---|
request | ICreateBillingReportRequest |
Returns
Promise<CreateBillingReportResponse>
Type declaration
| Name | Type |
|---|---|
name | "CreateBillingReport" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/CreateBillingReport" |
requestStream | undefined |
requestType | "CreateBillingReportRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateBillingReportResponse | CreateBillingReportResponse |
Returns
void
CreateConnectivityRule
Ƭ CreateConnectivityRule: Object
Creates a connectivity rule
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ICreateConnectivityRuleRequest |
callback | CreateConnectivityRuleCallback |
Returns
void
▸ (request): Promise<CreateConnectivityRuleResponse>
Parameters
| Name | Type |
|---|---|
request | ICreateConnectivityRuleRequest |
Returns
Promise<CreateConnectivityRuleResponse>
Type declaration
| Name | Type |
|---|---|
name | "CreateConnectivityRule" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/CreateConnectivityRule" |
requestStream | undefined |
requestType | "CreateConnectivityRuleRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateConnectivityRuleResponse | CreateConnectivityRuleResponse |
Returns
void
CreateCustomRole
Ƭ CreateCustomRole: Object
Create a custom role
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ICreateCustomRoleRequest |
callback | CreateCustomRoleCallback |
Returns
void
▸ (request): Promise<CreateCustomRoleResponse>
Parameters
| Name | Type |
|---|---|
request | ICreateCustomRoleRequest |
Returns
Promise<CreateCustomRoleResponse>
Type declaration
| Name | Type |
|---|---|
name | "CreateCustomRole" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/CreateCustomRole" |
requestStream | undefined |
requestType | "CreateCustomRoleRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateCustomRoleResponse | CreateCustomRoleResponse |
Returns
void
CreateNamespace
Ƭ CreateNamespace: Object
Create a new namespace
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ICreateNamespaceRequest |
callback | CreateNamespaceCallback |
Returns
void
▸ (request): Promise<CreateNamespaceResponse>
Parameters
| Name | Type |
|---|---|
request | ICreateNamespaceRequest |
Returns
Promise<CreateNamespaceResponse>
Type declaration
| Name | Type |
|---|---|
name | "CreateNamespace" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/CreateNamespace" |
requestStream | undefined |
requestType | "CreateNamespaceRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateNamespaceResponse | CreateNamespaceResponse |
Returns
void
CreateNamespaceExportSink
Ƭ CreateNamespaceExportSink: Object
Create an export sink
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ICreateNamespaceExportSinkRequest |
callback | CreateNamespaceExportSinkCallback |
Returns
void
▸ (request): Promise<CreateNamespaceExportSinkResponse>
Parameters
| Name | Type |
|---|---|
request | ICreateNamespaceExportSinkRequest |
Returns
Promise<CreateNamespaceExportSinkResponse>
Type declaration
| Name | Type |
|---|---|
name | "CreateNamespaceExportSink" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/CreateNamespaceExportSink" |
requestStream | undefined |
requestType | "CreateNamespaceExportSinkRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateNamespaceExportSinkResponse | CreateNamespaceExportSinkResponse |
Returns
void
CreateNexusEndpoint
Ƭ CreateNexusEndpoint: Object
Create a nexus endpoint
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ICreateNexusEndpointRequest |
callback | CreateNexusEndpointCallback |
Returns
void
▸ (request): Promise<CreateNexusEndpointResponse>
Parameters
| Name | Type |
|---|---|
request | ICreateNexusEndpointRequest |
Returns
Promise<CreateNexusEndpointResponse>
Type declaration
| Name | Type |
|---|---|
name | "CreateNexusEndpoint" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/CreateNexusEndpoint" |
requestStream | undefined |
requestType | "CreateNexusEndpointRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateNexusEndpointResponse | CreateNexusEndpointResponse |
Returns
void
CreateServiceAccount
Ƭ CreateServiceAccount: Object
Create a service account.
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ICreateServiceAccountRequest |
callback | CreateServiceAccountCallback |
Returns
void
▸ (request): Promise<CreateServiceAccountResponse>
Parameters
| Name | Type |
|---|---|
request | ICreateServiceAccountRequest |
Returns
Promise<CreateServiceAccountResponse>
Type declaration
| Name | Type |
|---|---|
name | "CreateServiceAccount" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/CreateServiceAccount" |
requestStream | undefined |
requestType | "CreateServiceAccountRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateServiceAccountResponse | CreateServiceAccountResponse |
Returns
void
CreateUser
Ƭ CreateUser: Object
Create a user
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ICreateUserRequest |
callback | CreateUserCallback |
Returns
void
▸ (request): Promise<CreateUserResponse>
Parameters
| Name | Type |
|---|---|
request | ICreateUserRequest |
Returns
Promise<CreateUserResponse>
Type declaration
| Name | Type |
|---|---|
name | "CreateUser" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/CreateUser" |
requestStream | undefined |
requestType | "CreateUserRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateUserResponse | CreateUserResponse |
Returns
void
CreateUserGroup
Ƭ CreateUserGroup: Object
Create new a user group
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ICreateUserGroupRequest |
callback | CreateUserGroupCallback |
Returns
void
▸ (request): Promise<CreateUserGroupResponse>
Parameters
| Name | Type |
|---|---|
request | ICreateUserGroupRequest |
Returns
Promise<CreateUserGroupResponse>
Type declaration
| Name | Type |
|---|---|
name | "CreateUserGroup" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/CreateUserGroup" |
requestStream | undefined |
requestType | "CreateUserGroupRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateUserGroupResponse | CreateUserGroupResponse |
Returns
void
DeleteAccountAuditLogSink
Ƭ DeleteAccountAuditLogSink: Object
Delete an audit log sink
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IDeleteAccountAuditLogSinkRequest |
callback | DeleteAccountAuditLogSinkCallback |
Returns
void
▸ (request): Promise<DeleteAccountAuditLogSinkResponse>
Parameters
| Name | Type |
|---|---|
request | IDeleteAccountAuditLogSinkRequest |
Returns
Promise<DeleteAccountAuditLogSinkResponse>
Type declaration
| Name | Type |
|---|---|
name | "DeleteAccountAuditLogSink" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteAccountAuditLogSink" |
requestStream | undefined |
requestType | "DeleteAccountAuditLogSinkRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteAccountAuditLogSinkResponse | DeleteAccountAuditLogSinkResponse |
Returns
void
DeleteApiKey
Ƭ DeleteApiKey: Object
Delete an API key
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IDeleteApiKeyRequest |
callback | DeleteApiKeyCallback |
Returns
void
▸ (request): Promise<DeleteApiKeyResponse>
Parameters
| Name | Type |
|---|---|
request | IDeleteApiKeyRequest |
Returns
Promise<DeleteApiKeyResponse>
Type declaration
| Name | Type |
|---|---|
name | "DeleteApiKey" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteApiKey" |
requestStream | undefined |
requestType | "DeleteApiKeyRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteApiKeyResponse | DeleteApiKeyResponse |
Returns
void
DeleteConnectivityRule
Ƭ DeleteConnectivityRule: Object
Deletes a connectivity rule by id
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IDeleteConnectivityRuleRequest |
callback | DeleteConnectivityRuleCallback |
Returns
void
▸ (request): Promise<DeleteConnectivityRuleResponse>
Parameters
| Name | Type |
|---|---|
request | IDeleteConnectivityRuleRequest |
Returns
Promise<DeleteConnectivityRuleResponse>
Type declaration
| Name | Type |
|---|---|
name | "DeleteConnectivityRule" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteConnectivityRule" |
requestStream | undefined |
requestType | "DeleteConnectivityRuleRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteConnectivityRuleResponse | DeleteConnectivityRuleResponse |
Returns
void
DeleteCustomRole
Ƭ DeleteCustomRole: Object
Delete a custom role
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IDeleteCustomRoleRequest |
callback | DeleteCustomRoleCallback |
Returns
void
▸ (request): Promise<DeleteCustomRoleResponse>
Parameters
| Name | Type |
|---|---|
request | IDeleteCustomRoleRequest |
Returns
Promise<DeleteCustomRoleResponse>
Type declaration
| Name | Type |
|---|---|
name | "DeleteCustomRole" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteCustomRole" |
requestStream | undefined |
requestType | "DeleteCustomRoleRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteCustomRoleResponse | DeleteCustomRoleResponse |
Returns
void
DeleteNamespace
Ƭ DeleteNamespace: Object
Delete a namespace
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IDeleteNamespaceRequest |
callback | DeleteNamespaceCallback |
Returns
void
▸ (request): Promise<DeleteNamespaceResponse>
Parameters
| Name | Type |
|---|---|
request | IDeleteNamespaceRequest |
Returns
Promise<DeleteNamespaceResponse>
Type declaration
| Name | Type |
|---|---|
name | "DeleteNamespace" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNamespace" |
requestStream | undefined |
requestType | "DeleteNamespaceRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteNamespaceResponse | DeleteNamespaceResponse |
Returns
void
DeleteNamespaceExportSink
Ƭ DeleteNamespaceExportSink: Object
Delete an export sink
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IDeleteNamespaceExportSinkRequest |
callback | DeleteNamespaceExportSinkCallback |
Returns
void
▸ (request): Promise<DeleteNamespaceExportSinkResponse>
Parameters
| Name | Type |
|---|---|
request | IDeleteNamespaceExportSinkRequest |
Returns
Promise<DeleteNamespaceExportSinkResponse>
Type declaration
| Name | Type |
|---|---|
name | "DeleteNamespaceExportSink" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNamespaceExportSink" |
requestStream | undefined |
requestType | "DeleteNamespaceExportSinkRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteNamespaceExportSinkResponse | DeleteNamespaceExportSinkResponse |
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
| Name | Type |
|---|---|
request | IDeleteNamespaceRegionRequest |
callback | DeleteNamespaceRegionCallback |
Returns
void
▸ (request): Promise<DeleteNamespaceRegionResponse>
Parameters
| Name | Type |
|---|---|
request | IDeleteNamespaceRegionRequest |
Returns
Promise<DeleteNamespaceRegionResponse>
Type declaration
| Name | Type |
|---|---|
name | "DeleteNamespaceRegion" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNamespaceRegion" |
requestStream | undefined |
requestType | "DeleteNamespaceRegionRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteNamespaceRegionResponse | DeleteNamespaceRegionResponse |
Returns
void
DeleteNexusEndpoint
Ƭ DeleteNexusEndpoint: Object
Delete a nexus endpoint
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IDeleteNexusEndpointRequest |
callback | DeleteNexusEndpointCallback |
Returns
void
▸ (request): Promise<DeleteNexusEndpointResponse>
Parameters
| Name | Type |
|---|---|
request | IDeleteNexusEndpointRequest |
Returns
Promise<DeleteNexusEndpointResponse>
Type declaration
| Name | Type |
|---|---|
name | "DeleteNexusEndpoint" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteNexusEndpoint" |
requestStream | undefined |
requestType | "DeleteNexusEndpointRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteNexusEndpointResponse | DeleteNexusEndpointResponse |
Returns
void
DeleteServiceAccount
Ƭ DeleteServiceAccount: Object
Delete a service account.
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IDeleteServiceAccountRequest |
callback | DeleteServiceAccountCallback |
Returns
void
▸ (request): Promise<DeleteServiceAccountResponse>
Parameters
| Name | Type |
|---|---|
request | IDeleteServiceAccountRequest |
Returns
Promise<DeleteServiceAccountResponse>
Type declaration
| Name | Type |
|---|---|
name | "DeleteServiceAccount" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteServiceAccount" |
requestStream | undefined |
requestType | "DeleteServiceAccountRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteServiceAccountResponse | DeleteServiceAccountResponse |
Returns
void
DeleteUser
Ƭ DeleteUser: Object
Delete a user
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IDeleteUserRequest |
callback | DeleteUserCallback |
Returns
void
▸ (request): Promise<DeleteUserResponse>
Parameters
| Name | Type |
|---|---|
request | IDeleteUserRequest |
Returns
Promise<DeleteUserResponse>
Type declaration
| Name | Type |
|---|---|
name | "DeleteUser" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteUser" |
requestStream | undefined |
requestType | "DeleteUserRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteUserResponse | DeleteUserResponse |
Returns
void
DeleteUserGroup
Ƭ DeleteUserGroup: Object
Delete a user group
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IDeleteUserGroupRequest |
callback | DeleteUserGroupCallback |
Returns
void
▸ (request): Promise<DeleteUserGroupResponse>
Parameters
| Name | Type |
|---|---|
request | IDeleteUserGroupRequest |
Returns
Promise<DeleteUserGroupResponse>
Type declaration
| Name | Type |
|---|---|
name | "DeleteUserGroup" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/DeleteUserGroup" |
requestStream | undefined |
requestType | "DeleteUserGroupRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteUserGroupResponse | DeleteUserGroupResponse |
Returns
void
FailoverNamespaceRegion
Ƭ FailoverNamespaceRegion: Object
Failover a multi-region namespace
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IFailoverNamespaceRegionRequest |
callback | FailoverNamespaceRegionCallback |
Returns
void
▸ (request): Promise<FailoverNamespaceRegionResponse>
Parameters
| Name | Type |
|---|---|
request | IFailoverNamespaceRegionRequest |
Returns
Promise<FailoverNamespaceRegionResponse>
Type declaration
| Name | Type |
|---|---|
name | "FailoverNamespaceRegion" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/FailoverNamespaceRegion" |
requestStream | undefined |
requestType | "FailoverNamespaceRegionRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | FailoverNamespaceRegionResponse | FailoverNamespaceRegionResponse |
Returns
void
GetAccount
Ƭ GetAccount: Object
Get account information.
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetAccountRequest |
callback | GetAccountCallback |
Returns
void
▸ (request): Promise<GetAccountResponse>
Parameters
| Name | Type |
|---|---|
request | IGetAccountRequest |
Returns
Promise<GetAccountResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetAccount" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetAccount" |
requestStream | undefined |
requestType | "GetAccountRequest" |
responseStream | undefined |
responseType | "GetAccountResponse" |
GetAccountAuditLogSink
Ƭ GetAccountAuditLogSink: Object
Get an audit log sink
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetAccountAuditLogSinkRequest |
callback | GetAccountAuditLogSinkCallback |
Returns
void
▸ (request): Promise<GetAccountAuditLogSinkResponse>
Parameters
| Name | Type |
|---|---|
request | IGetAccountAuditLogSinkRequest |
Returns
Promise<GetAccountAuditLogSinkResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetAccountAuditLogSink" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetAccountAuditLogSink" |
requestStream | undefined |
requestType | "GetAccountAuditLogSinkRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetAccountAuditLogSinkResponse | GetAccountAuditLogSinkResponse |
Returns
void
GetAccountAuditLogSinks
Ƭ GetAccountAuditLogSinks: Object
Get audit log sinks
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetAccountAuditLogSinksRequest |
callback | GetAccountAuditLogSinksCallback |
Returns
void
▸ (request): Promise<GetAccountAuditLogSinksResponse>
Parameters
| Name | Type |
|---|---|
request | IGetAccountAuditLogSinksRequest |
Returns
Promise<GetAccountAuditLogSinksResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetAccountAuditLogSinks" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetAccountAuditLogSinks" |
requestStream | undefined |
requestType | "GetAccountAuditLogSinksRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetAccountAuditLogSinksResponse | GetAccountAuditLogSinksResponse |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetAccountResponse | GetAccountResponse |
Returns
void
GetApiKey
Ƭ GetApiKey: Object
Get an API key
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetApiKeyRequest |
callback | GetApiKeyCallback |
Returns
void
▸ (request): Promise<GetApiKeyResponse>
Parameters
| Name | Type |
|---|---|
request | IGetApiKeyRequest |
Returns
Promise<GetApiKeyResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetApiKey" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetApiKey" |
requestStream | undefined |
requestType | "GetApiKeyRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetApiKeyResponse | GetApiKeyResponse |
Returns
void
GetApiKeys
Ƭ GetApiKeys: Object
Get all known API keys
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetApiKeysRequest |
callback | GetApiKeysCallback |
Returns
void
▸ (request): Promise<GetApiKeysResponse>
Parameters
| Name | Type |
|---|---|
request | IGetApiKeysRequest |
Returns
Promise<GetApiKeysResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetApiKeys" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetApiKeys" |
requestStream | undefined |
requestType | "GetApiKeysRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetApiKeysResponse | GetApiKeysResponse |
Returns
void
GetAsyncOperation
Ƭ GetAsyncOperation: Object
Get the latest information on an async operation
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetAsyncOperationRequest |
callback | GetAsyncOperationCallback |
Returns
void
▸ (request): Promise<GetAsyncOperationResponse>
Parameters
| Name | Type |
|---|---|
request | IGetAsyncOperationRequest |
Returns
Promise<GetAsyncOperationResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetAsyncOperation" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetAsyncOperation" |
requestStream | undefined |
requestType | "GetAsyncOperationRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetAsyncOperationResponse | GetAsyncOperationResponse |
Returns
void
GetAuditLogs
Ƭ GetAuditLogs: Object
Get audit logs
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetAuditLogsRequest |
callback | GetAuditLogsCallback |
Returns
void
▸ (request): Promise<GetAuditLogsResponse>
Parameters
| Name | Type |
|---|---|
request | IGetAuditLogsRequest |
Returns
Promise<GetAuditLogsResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetAuditLogs" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetAuditLogs" |
requestStream | undefined |
requestType | "GetAuditLogsRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetAuditLogsResponse | GetAuditLogsResponse |
Returns
void
GetBillingReport
Ƭ GetBillingReport: Object
Get a billing report
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetBillingReportRequest |
callback | GetBillingReportCallback |
Returns
void
▸ (request): Promise<GetBillingReportResponse>
Parameters
| Name | Type |
|---|---|
request | IGetBillingReportRequest |
Returns
Promise<GetBillingReportResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetBillingReport" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetBillingReport" |
requestStream | undefined |
requestType | "GetBillingReportRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetBillingReportResponse | GetBillingReportResponse |
Returns
void
GetConnectivityRule
Ƭ GetConnectivityRule: Object
Gets a connectivity rule by id
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetConnectivityRuleRequest |
callback | GetConnectivityRuleCallback |
Returns
void
▸ (request): Promise<GetConnectivityRuleResponse>
Parameters
| Name | Type |
|---|---|
request | IGetConnectivityRuleRequest |
Returns
Promise<GetConnectivityRuleResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetConnectivityRule" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetConnectivityRule" |
requestStream | undefined |
requestType | "GetConnectivityRuleRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetConnectivityRuleResponse | GetConnectivityRuleResponse |
Returns
void
GetConnectivityRules
Ƭ GetConnectivityRules: Object
Lists connectivity rules by account
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetConnectivityRulesRequest |
callback | GetConnectivityRulesCallback |
Returns
void
▸ (request): Promise<GetConnectivityRulesResponse>
Parameters
| Name | Type |
|---|---|
request | IGetConnectivityRulesRequest |
Returns
Promise<GetConnectivityRulesResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetConnectivityRules" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetConnectivityRules" |
requestStream | undefined |
requestType | "GetConnectivityRulesRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetConnectivityRulesResponse | GetConnectivityRulesResponse |
Returns
void
GetCurrentIdentity
Ƭ GetCurrentIdentity: Object
Get information about the current authenticated user or service account principal
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetCurrentIdentityRequest |
callback | GetCurrentIdentityCallback |
Returns
void
▸ (request): Promise<GetCurrentIdentityResponse>
Parameters
| Name | Type |
|---|---|
request | IGetCurrentIdentityRequest |
Returns
Promise<GetCurrentIdentityResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetCurrentIdentity" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetCurrentIdentity" |
requestStream | undefined |
requestType | "GetCurrentIdentityRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetCurrentIdentityResponse | GetCurrentIdentityResponse |
Returns
void
GetCustomRole
Ƭ GetCustomRole: Object
Get a custom role
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetCustomRoleRequest |
callback | GetCustomRoleCallback |
Returns
void
▸ (request): Promise<GetCustomRoleResponse>
Parameters
| Name | Type |
|---|---|
request | IGetCustomRoleRequest |
Returns
Promise<GetCustomRoleResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetCustomRole" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetCustomRole" |
requestStream | undefined |
requestType | "GetCustomRoleRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetCustomRoleResponse | GetCustomRoleResponse |
Returns
void
GetCustomRoles
Ƭ GetCustomRoles: Object
Get custom roles
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetCustomRolesRequest |
callback | GetCustomRolesCallback |
Returns
void
▸ (request): Promise<GetCustomRolesResponse>
Parameters
| Name | Type |
|---|---|
request | IGetCustomRolesRequest |
Returns
Promise<GetCustomRolesResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetCustomRoles" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetCustomRoles" |
requestStream | undefined |
requestType | "GetCustomRolesRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetCustomRolesResponse | GetCustomRolesResponse |
Returns
void
GetNamespace
Ƭ GetNamespace: Object
Get a namespace
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetNamespaceRequest |
callback | GetNamespaceCallback |
Returns
void
▸ (request): Promise<GetNamespaceResponse>
Parameters
| Name | Type |
|---|---|
request | IGetNamespaceRequest |
Returns
Promise<GetNamespaceResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetNamespace" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespace" |
requestStream | undefined |
requestType | "GetNamespaceRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetNamespaceResponse | GetNamespaceResponse |
Returns
void
GetNamespaceCapacityInfo
Ƭ GetNamespaceCapacityInfo: Object
Get namespace capacity information
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetNamespaceCapacityInfoRequest |
callback | GetNamespaceCapacityInfoCallback |
Returns
void
▸ (request): Promise<GetNamespaceCapacityInfoResponse>
Parameters
| Name | Type |
|---|---|
request | IGetNamespaceCapacityInfoRequest |
Returns
Promise<GetNamespaceCapacityInfoResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetNamespaceCapacityInfo" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaceCapacityInfo" |
requestStream | undefined |
requestType | "GetNamespaceCapacityInfoRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetNamespaceCapacityInfoResponse | GetNamespaceCapacityInfoResponse |
Returns
void
GetNamespaceExportSink
Ƭ GetNamespaceExportSink: Object
Get an export sink
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetNamespaceExportSinkRequest |
callback | GetNamespaceExportSinkCallback |
Returns
void
▸ (request): Promise<GetNamespaceExportSinkResponse>
Parameters
| Name | Type |
|---|---|
request | IGetNamespaceExportSinkRequest |
Returns
Promise<GetNamespaceExportSinkResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetNamespaceExportSink" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaceExportSink" |
requestStream | undefined |
requestType | "GetNamespaceExportSinkRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetNamespaceExportSinkResponse | GetNamespaceExportSinkResponse |
Returns
void
GetNamespaceExportSinks
Ƭ GetNamespaceExportSinks: Object
Get export sinks
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetNamespaceExportSinksRequest |
callback | GetNamespaceExportSinksCallback |
Returns
void
▸ (request): Promise<GetNamespaceExportSinksResponse>
Parameters
| Name | Type |
|---|---|
request | IGetNamespaceExportSinksRequest |
Returns
Promise<GetNamespaceExportSinksResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetNamespaceExportSinks" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaceExportSinks" |
requestStream | undefined |
requestType | "GetNamespaceExportSinksRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetNamespaceExportSinksResponse | GetNamespaceExportSinksResponse |
Returns
void
GetNamespaces
Ƭ GetNamespaces: Object
Get all namespaces
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetNamespacesRequest |
callback | GetNamespacesCallback |
Returns
void
▸ (request): Promise<GetNamespacesResponse>
Parameters
| Name | Type |
|---|---|
request | IGetNamespacesRequest |
Returns
Promise<GetNamespacesResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetNamespaces" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetNamespaces" |
requestStream | undefined |
requestType | "GetNamespacesRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetNamespacesResponse | GetNamespacesResponse |
Returns
void
GetNexusEndpoint
Ƭ GetNexusEndpoint: Object
Get a nexus endpoint
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetNexusEndpointRequest |
callback | GetNexusEndpointCallback |
Returns
void
▸ (request): Promise<GetNexusEndpointResponse>
Parameters
| Name | Type |
|---|---|
request | IGetNexusEndpointRequest |
Returns
Promise<GetNexusEndpointResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetNexusEndpoint" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetNexusEndpoint" |
requestStream | undefined |
requestType | "GetNexusEndpointRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetNexusEndpointResponse | GetNexusEndpointResponse |
Returns
void
GetNexusEndpoints
Ƭ GetNexusEndpoints: Object
Gets nexus endpoints
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetNexusEndpointsRequest |
callback | GetNexusEndpointsCallback |
Returns
void
▸ (request): Promise<GetNexusEndpointsResponse>
Parameters
| Name | Type |
|---|---|
request | IGetNexusEndpointsRequest |
Returns
Promise<GetNexusEndpointsResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetNexusEndpoints" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetNexusEndpoints" |
requestStream | undefined |
requestType | "GetNexusEndpointsRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetNexusEndpointsResponse | GetNexusEndpointsResponse |
Returns
void
GetRegion
Ƭ GetRegion: Object
Get a region
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetRegionRequest |
callback | GetRegionCallback |
Returns
void
▸ (request): Promise<GetRegionResponse>
Parameters
| Name | Type |
|---|---|
request | IGetRegionRequest |
Returns
Promise<GetRegionResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetRegion" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetRegion" |
requestStream | undefined |
requestType | "GetRegionRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetRegionResponse | GetRegionResponse |
Returns
void
GetRegions
Ƭ GetRegions: Object
Get all regions
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetRegionsRequest |
callback | GetRegionsCallback |
Returns
void
▸ (request): Promise<GetRegionsResponse>
Parameters
| Name | Type |
|---|---|
request | IGetRegionsRequest |
Returns
Promise<GetRegionsResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetRegions" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetRegions" |
requestStream | undefined |
requestType | "GetRegionsRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetRegionsResponse | GetRegionsResponse |
Returns
void
GetServiceAccount
Ƭ GetServiceAccount: Object
Get a service account.
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetServiceAccountRequest |
callback | GetServiceAccountCallback |
Returns
void
▸ (request): Promise<GetServiceAccountResponse>
Parameters
| Name | Type |
|---|---|
request | IGetServiceAccountRequest |
Returns
Promise<GetServiceAccountResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetServiceAccount" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetServiceAccount" |
requestStream | undefined |
requestType | "GetServiceAccountRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetServiceAccountResponse | GetServiceAccountResponse |
Returns
void
GetServiceAccountNamespaceAssignments
Ƭ GetServiceAccountNamespaceAssignments: Object
Get service accounts with access to a namespace
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetServiceAccountNamespaceAssignmentsRequest |
callback | GetServiceAccountNamespaceAssignmentsCallback |
Returns
void
▸ (request): Promise<GetServiceAccountNamespaceAssignmentsResponse>
Parameters
| Name | Type |
|---|---|
request | IGetServiceAccountNamespaceAssignmentsRequest |
Returns
Promise<GetServiceAccountNamespaceAssignmentsResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetServiceAccountNamespaceAssignments" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetServiceAccountNamespaceAssignments" |
requestStream | undefined |
requestType | "GetServiceAccountNamespaceAssignmentsRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetServiceAccountNamespaceAssignmentsResponse | GetServiceAccountNamespaceAssignmentsResponse |
Returns
void
GetServiceAccounts
Ƭ GetServiceAccounts: Object
Get service accounts.
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetServiceAccountsRequest |
callback | GetServiceAccountsCallback |
Returns
void
▸ (request): Promise<GetServiceAccountsResponse>
Parameters
| Name | Type |
|---|---|
request | IGetServiceAccountsRequest |
Returns
Promise<GetServiceAccountsResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetServiceAccounts" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetServiceAccounts" |
requestStream | undefined |
requestType | "GetServiceAccountsRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetServiceAccountsResponse | GetServiceAccountsResponse |
Returns
void
GetUsage
Ƭ GetUsage: Object
WARNING: Pre-Release Feature Get usage data across namespaces
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetUsageRequest |
callback | GetUsageCallback |
Returns
void
▸ (request): Promise<GetUsageResponse>
Parameters
| Name | Type |
|---|---|
request | IGetUsageRequest |
Returns
Promise<GetUsageResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetUsage" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetUsage" |
requestStream | undefined |
requestType | "GetUsageRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetUsageResponse | GetUsageResponse |
Returns
void
GetUser
Ƭ GetUser: Object
Get a user
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetUserRequest |
callback | GetUserCallback |
Returns
void
▸ (request): Promise<GetUserResponse>
Parameters
| Name | Type |
|---|---|
request | IGetUserRequest |
Returns
Promise<GetUserResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetUser" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetUser" |
requestStream | undefined |
requestType | "GetUserRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetUserResponse | GetUserResponse |
Returns
void
GetUserGroup
Ƭ GetUserGroup: Object
Get a user group
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetUserGroupRequest |
callback | GetUserGroupCallback |
Returns
void
▸ (request): Promise<GetUserGroupResponse>
Parameters
| Name | Type |
|---|---|
request | IGetUserGroupRequest |
Returns
Promise<GetUserGroupResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetUserGroup" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroup" |
requestStream | undefined |
requestType | "GetUserGroupRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetUserGroupResponse | GetUserGroupResponse |
Returns
void
GetUserGroupMembers
Ƭ GetUserGroupMembers: Object
Calls GetUserGroupMembers.
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetUserGroupMembersRequest |
callback | GetUserGroupMembersCallback |
Returns
void
▸ (request): Promise<GetUserGroupMembersResponse>
Parameters
| Name | Type |
|---|---|
request | IGetUserGroupMembersRequest |
Returns
Promise<GetUserGroupMembersResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetUserGroupMembers" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroupMembers" |
requestStream | undefined |
requestType | "GetUserGroupMembersRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetUserGroupMembersResponse | GetUserGroupMembersResponse |
Returns
void
GetUserGroupNamespaceAssignments
Ƭ GetUserGroupNamespaceAssignments: Object
Get user groups with access to a namespace
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetUserGroupNamespaceAssignmentsRequest |
callback | GetUserGroupNamespaceAssignmentsCallback |
Returns
void
▸ (request): Promise<GetUserGroupNamespaceAssignmentsResponse>
Parameters
| Name | Type |
|---|---|
request | IGetUserGroupNamespaceAssignmentsRequest |
Returns
Promise<GetUserGroupNamespaceAssignmentsResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetUserGroupNamespaceAssignments" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroupNamespaceAssignments" |
requestStream | undefined |
requestType | "GetUserGroupNamespaceAssignmentsRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetUserGroupNamespaceAssignmentsResponse | GetUserGroupNamespaceAssignmentsResponse |
Returns
void
GetUserGroups
Ƭ GetUserGroups: Object
Get all user groups
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetUserGroupsRequest |
callback | GetUserGroupsCallback |
Returns
void
▸ (request): Promise<GetUserGroupsResponse>
Parameters
| Name | Type |
|---|---|
request | IGetUserGroupsRequest |
Returns
Promise<GetUserGroupsResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetUserGroups" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetUserGroups" |
requestStream | undefined |
requestType | "GetUserGroupsRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetUserGroupsResponse | GetUserGroupsResponse |
Returns
void
GetUserNamespaceAssignments
Ƭ GetUserNamespaceAssignments: Object
Get users with access to a namespace
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetUserNamespaceAssignmentsRequest |
callback | GetUserNamespaceAssignmentsCallback |
Returns
void
▸ (request): Promise<GetUserNamespaceAssignmentsResponse>
Parameters
| Name | Type |
|---|---|
request | IGetUserNamespaceAssignmentsRequest |
Returns
Promise<GetUserNamespaceAssignmentsResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetUserNamespaceAssignments" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetUserNamespaceAssignments" |
requestStream | undefined |
requestType | "GetUserNamespaceAssignmentsRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetUserNamespaceAssignmentsResponse | GetUserNamespaceAssignmentsResponse |
Returns
void
GetUsers
Ƭ GetUsers: Object
Gets all known users
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IGetUsersRequest |
callback | GetUsersCallback |
Returns
void
▸ (request): Promise<GetUsersResponse>
Parameters
| Name | Type |
|---|---|
request | IGetUsersRequest |
Returns
Promise<GetUsersResponse>
Type declaration
| Name | Type |
|---|---|
name | "GetUsers" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/GetUsers" |
requestStream | undefined |
requestType | "GetUsersRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetUsersResponse | GetUsersResponse |
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
| Name | Type |
|---|---|
request | IRemoveUserGroupMemberRequest |
callback | RemoveUserGroupMemberCallback |
Returns
void
▸ (request): Promise<RemoveUserGroupMemberResponse>
Parameters
| Name | Type |
|---|---|
request | IRemoveUserGroupMemberRequest |
Returns
Promise<RemoveUserGroupMemberResponse>
Type declaration
| Name | Type |
|---|---|
name | "RemoveUserGroupMember" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/RemoveUserGroupMember" |
requestStream | undefined |
requestType | "RemoveUserGroupMemberRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RemoveUserGroupMemberResponse | RemoveUserGroupMemberResponse |
Returns
void
RenameCustomSearchAttribute
Ƭ RenameCustomSearchAttribute: Object
Rename an existing customer search attribute
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IRenameCustomSearchAttributeRequest |
callback | RenameCustomSearchAttributeCallback |
Returns
void
▸ (request): Promise<RenameCustomSearchAttributeResponse>
Parameters
| Name | Type |
|---|---|
request | IRenameCustomSearchAttributeRequest |
Returns
Promise<RenameCustomSearchAttributeResponse>
Type declaration
| Name | Type |
|---|---|
name | "RenameCustomSearchAttribute" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/RenameCustomSearchAttribute" |
requestStream | undefined |
requestType | "RenameCustomSearchAttributeRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RenameCustomSearchAttributeResponse | RenameCustomSearchAttributeResponse |
Returns
void
SetServiceAccountNamespaceAccess
Ƭ SetServiceAccountNamespaceAccess: Object
Set a service account's access to a namespace.
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ISetServiceAccountNamespaceAccessRequest |
callback | SetServiceAccountNamespaceAccessCallback |
Returns
void
▸ (request): Promise<SetServiceAccountNamespaceAccessResponse>
Parameters
| Name | Type |
|---|---|
request | ISetServiceAccountNamespaceAccessRequest |
Returns
Promise<SetServiceAccountNamespaceAccessResponse>
Type declaration
| Name | Type |
|---|---|
name | "SetServiceAccountNamespaceAccess" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/SetServiceAccountNamespaceAccess" |
requestStream | undefined |
requestType | "SetServiceAccountNamespaceAccessRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | SetServiceAccountNamespaceAccessResponse | SetServiceAccountNamespaceAccessResponse |
Returns
void
SetUserGroupNamespaceAccess
Ƭ SetUserGroupNamespaceAccess: Object
Set a user group's access to a namespace
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ISetUserGroupNamespaceAccessRequest |
callback | SetUserGroupNamespaceAccessCallback |
Returns
void
▸ (request): Promise<SetUserGroupNamespaceAccessResponse>
Parameters
| Name | Type |
|---|---|
request | ISetUserGroupNamespaceAccessRequest |
Returns
Promise<SetUserGroupNamespaceAccessResponse>
Type declaration
| Name | Type |
|---|---|
name | "SetUserGroupNamespaceAccess" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/SetUserGroupNamespaceAccess" |
requestStream | undefined |
requestType | "SetUserGroupNamespaceAccessRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | SetUserGroupNamespaceAccessResponse | SetUserGroupNamespaceAccessResponse |
Returns
void
SetUserNamespaceAccess
Ƭ SetUserNamespaceAccess: Object
Set a user's access to a namespace
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | ISetUserNamespaceAccessRequest |
callback | SetUserNamespaceAccessCallback |
Returns
void
▸ (request): Promise<SetUserNamespaceAccessResponse>
Parameters
| Name | Type |
|---|---|
request | ISetUserNamespaceAccessRequest |
Returns
Promise<SetUserNamespaceAccessResponse>
Type declaration
| Name | Type |
|---|---|
name | "SetUserNamespaceAccess" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/SetUserNamespaceAccess" |
requestStream | undefined |
requestType | "SetUserNamespaceAccessRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | SetUserNamespaceAccessResponse | SetUserNamespaceAccessResponse |
Returns
void
UpdateAccount
Ƭ UpdateAccount: Object
Update account information.
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IUpdateAccountRequest |
callback | UpdateAccountCallback |
Returns
void
▸ (request): Promise<UpdateAccountResponse>
Parameters
| Name | Type |
|---|---|
request | IUpdateAccountRequest |
Returns
Promise<UpdateAccountResponse>
Type declaration
| Name | Type |
|---|---|
name | "UpdateAccount" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateAccount" |
requestStream | undefined |
requestType | "UpdateAccountRequest" |
responseStream | undefined |
responseType | "UpdateAccountResponse" |
UpdateAccountAuditLogSink
Ƭ UpdateAccountAuditLogSink: Object
Update an audit log sink
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IUpdateAccountAuditLogSinkRequest |
callback | UpdateAccountAuditLogSinkCallback |
Returns
void
▸ (request): Promise<UpdateAccountAuditLogSinkResponse>
Parameters
| Name | Type |
|---|---|
request | IUpdateAccountAuditLogSinkRequest |
Returns
Promise<UpdateAccountAuditLogSinkResponse>
Type declaration
| Name | Type |
|---|---|
name | "UpdateAccountAuditLogSink" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateAccountAuditLogSink" |
requestStream | undefined |
requestType | "UpdateAccountAuditLogSinkRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateAccountAuditLogSinkResponse | UpdateAccountAuditLogSinkResponse |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateAccountResponse | UpdateAccountResponse |
Returns
void
UpdateApiKey
Ƭ UpdateApiKey: Object
Update an API key
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IUpdateApiKeyRequest |
callback | UpdateApiKeyCallback |
Returns
void
▸ (request): Promise<UpdateApiKeyResponse>
Parameters
| Name | Type |
|---|---|
request | IUpdateApiKeyRequest |
Returns
Promise<UpdateApiKeyResponse>
Type declaration
| Name | Type |
|---|---|
name | "UpdateApiKey" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateApiKey" |
requestStream | undefined |
requestType | "UpdateApiKeyRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateApiKeyResponse | UpdateApiKeyResponse |
Returns
void
UpdateCustomRole
Ƭ UpdateCustomRole: Object
Update a custom role
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IUpdateCustomRoleRequest |
callback | UpdateCustomRoleCallback |
Returns
void
▸ (request): Promise<UpdateCustomRoleResponse>
Parameters
| Name | Type |
|---|---|
request | IUpdateCustomRoleRequest |
Returns
Promise<UpdateCustomRoleResponse>
Type declaration
| Name | Type |
|---|---|
name | "UpdateCustomRole" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateCustomRole" |
requestStream | undefined |
requestType | "UpdateCustomRoleRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateCustomRoleResponse | UpdateCustomRoleResponse |
Returns
void
UpdateNamespace
Ƭ UpdateNamespace: Object
Update a namespace
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IUpdateNamespaceRequest |
callback | UpdateNamespaceCallback |
Returns
void
▸ (request): Promise<UpdateNamespaceResponse>
Parameters
| Name | Type |
|---|---|
request | IUpdateNamespaceRequest |
Returns
Promise<UpdateNamespaceResponse>
Type declaration
| Name | Type |
|---|---|
name | "UpdateNamespace" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNamespace" |
requestStream | undefined |
requestType | "UpdateNamespaceRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateNamespaceResponse | UpdateNamespaceResponse |
Returns
void
UpdateNamespaceExportSink
Ƭ UpdateNamespaceExportSink: Object
Update an export sink
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IUpdateNamespaceExportSinkRequest |
callback | UpdateNamespaceExportSinkCallback |
Returns
void
▸ (request): Promise<UpdateNamespaceExportSinkResponse>
Parameters
| Name | Type |
|---|---|
request | IUpdateNamespaceExportSinkRequest |
Returns
Promise<UpdateNamespaceExportSinkResponse>
Type declaration
| Name | Type |
|---|---|
name | "UpdateNamespaceExportSink" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNamespaceExportSink" |
requestStream | undefined |
requestType | "UpdateNamespaceExportSinkRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateNamespaceExportSinkResponse | UpdateNamespaceExportSinkResponse |
Returns
void
UpdateNamespaceTags
Ƭ UpdateNamespaceTags: Object
Update the tags for a namespace
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IUpdateNamespaceTagsRequest |
callback | UpdateNamespaceTagsCallback |
Returns
void
▸ (request): Promise<UpdateNamespaceTagsResponse>
Parameters
| Name | Type |
|---|---|
request | IUpdateNamespaceTagsRequest |
Returns
Promise<UpdateNamespaceTagsResponse>
Type declaration
| Name | Type |
|---|---|
name | "UpdateNamespaceTags" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNamespaceTags" |
requestStream | undefined |
requestType | "UpdateNamespaceTagsRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateNamespaceTagsResponse | UpdateNamespaceTagsResponse |
Returns
void
UpdateNexusEndpoint
Ƭ UpdateNexusEndpoint: Object
Update a nexus endpoint
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IUpdateNexusEndpointRequest |
callback | UpdateNexusEndpointCallback |
Returns
void
▸ (request): Promise<UpdateNexusEndpointResponse>
Parameters
| Name | Type |
|---|---|
request | IUpdateNexusEndpointRequest |
Returns
Promise<UpdateNexusEndpointResponse>
Type declaration
| Name | Type |
|---|---|
name | "UpdateNexusEndpoint" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateNexusEndpoint" |
requestStream | undefined |
requestType | "UpdateNexusEndpointRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateNexusEndpointResponse | UpdateNexusEndpointResponse |
Returns
void
UpdateServiceAccount
Ƭ UpdateServiceAccount: Object
Update a service account.
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IUpdateServiceAccountRequest |
callback | UpdateServiceAccountCallback |
Returns
void
▸ (request): Promise<UpdateServiceAccountResponse>
Parameters
| Name | Type |
|---|---|
request | IUpdateServiceAccountRequest |
Returns
Promise<UpdateServiceAccountResponse>
Type declaration
| Name | Type |
|---|---|
name | "UpdateServiceAccount" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateServiceAccount" |
requestStream | undefined |
requestType | "UpdateServiceAccountRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateServiceAccountResponse | UpdateServiceAccountResponse |
Returns
void
UpdateUser
Ƭ UpdateUser: Object
Update a user
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IUpdateUserRequest |
callback | UpdateUserCallback |
Returns
void
▸ (request): Promise<UpdateUserResponse>
Parameters
| Name | Type |
|---|---|
request | IUpdateUserRequest |
Returns
Promise<UpdateUserResponse>
Type declaration
| Name | Type |
|---|---|
name | "UpdateUser" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateUser" |
requestStream | undefined |
requestType | "UpdateUserRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateUserResponse | UpdateUserResponse |
Returns
void
UpdateUserGroup
Ƭ UpdateUserGroup: Object
Update a user group
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IUpdateUserGroupRequest |
callback | UpdateUserGroupCallback |
Returns
void
▸ (request): Promise<UpdateUserGroupResponse>
Parameters
| Name | Type |
|---|---|
request | IUpdateUserGroupRequest |
Returns
Promise<UpdateUserGroupResponse>
Type declaration
| Name | Type |
|---|---|
name | "UpdateUserGroup" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/UpdateUserGroup" |
requestStream | undefined |
requestType | "UpdateUserGroupRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateUserGroupResponse | UpdateUserGroupResponse |
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
| Name | Type |
|---|---|
request | IValidateAccountAuditLogSinkRequest |
callback | ValidateAccountAuditLogSinkCallback |
Returns
void
▸ (request): Promise<ValidateAccountAuditLogSinkResponse>
Parameters
| Name | Type |
|---|---|
request | IValidateAccountAuditLogSinkRequest |
Returns
Promise<ValidateAccountAuditLogSinkResponse>
Type declaration
| Name | Type |
|---|---|
name | "ValidateAccountAuditLogSink" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/ValidateAccountAuditLogSink" |
requestStream | undefined |
requestType | "ValidateAccountAuditLogSinkRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ValidateAccountAuditLogSinkResponse | ValidateAccountAuditLogSinkResponse |
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
| Name | Type |
|---|---|
request | IValidateNamespaceExportSinkRequest |
callback | ValidateNamespaceExportSinkCallback |
Returns
void
▸ (request): Promise<ValidateNamespaceExportSinkResponse>
Parameters
| Name | Type |
|---|---|
request | IValidateNamespaceExportSinkRequest |
Returns
Promise<ValidateNamespaceExportSinkResponse>
Type declaration
| Name | Type |
|---|---|
name | "ValidateNamespaceExportSink" |
path | "/temporal.api.cloud.cloudservice.v1.CloudService/ValidateNamespaceExportSink" |
requestStream | undefined |
requestType | "ValidateNamespaceExportSinkRequest" |
responseStream | undefined |
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
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ValidateNamespaceExportSinkResponse | ValidateNamespaceExportSinkResponse |
Returns
void