Class: CloudService
cloudservice.v1.CloudService
WARNING: This service is currently experimental and may change in incompatible ways.
Hierarchy
-
Service↳
CloudService
Constructors
constructor
• new CloudService(rpcImpl, requestDelimited?, responseDelimited?): CloudService
Constructs a new CloudService service.
Parameters
| Name | Type | Description |
|---|---|---|
rpcImpl | RPCImpl | RPC implementation |
requestDelimited? | boolean | Whether requests are length-delimited |
responseDelimited? | boolean | Whether responses are length-delimited |
Returns
Overrides
$protobuf.rpc.Service.constructor
Properties
requestDelimited
• requestDelimited: boolean
Whether requests are length-delimited.
Inherited from
$protobuf.rpc.Service.requestDelimited
responseDelimited
• responseDelimited: boolean
Whether responses are length-delimited.
Inherited from
$protobuf.rpc.Service.responseDelimited
rpcImpl
• rpcImpl: null | RPCImpl
RPC implementation. Becomes null once the service is ended.
Inherited from
$protobuf.rpc.Service.rpcImpl
Methods
addNamespaceRegion
▸ addNamespaceRegion(request, callback): void
Add a new region to a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IAddNamespaceRegionRequest | AddNamespaceRegionRequest message or plain object |
callback | AddNamespaceRegionCallback | Node-style callback called with the error, if any, and AddNamespaceRegionResponse |
Returns
void
▸ addNamespaceRegion(request): Promise<AddNamespaceRegionResponse>
Add a new region to a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IAddNamespaceRegionRequest | AddNamespaceRegionRequest message or plain object |
Returns
Promise<AddNamespaceRegionResponse>
Promise
createApiKey
▸ createApiKey(request, callback): void
Create an API key
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateApiKeyRequest | CreateApiKeyRequest message or plain object |
callback | CreateApiKeyCallback | Node-style callback called with the error, if any, and CreateApiKeyResponse |
Returns
void
▸ createApiKey(request): Promise<CreateApiKeyResponse>
Create an API key
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateApiKeyRequest | CreateApiKeyRequest message or plain object |
Returns
Promise<CreateApiKeyResponse>
Promise
createNamespace
▸ createNamespace(request, callback): void
Create a new namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateNamespaceRequest | CreateNamespaceRequest message or plain object |
callback | CreateNamespaceCallback | Node-style callback called with the error, if any, and CreateNamespaceResponse |
Returns
void
▸ createNamespace(request): Promise<CreateNamespaceResponse>
Create a new namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateNamespaceRequest | CreateNamespaceRequest message or plain object |
Returns
Promise<CreateNamespaceResponse>
Promise
createServiceAccount
▸ createServiceAccount(request, callback): void
Create a service account.
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateServiceAccountRequest | CreateServiceAccountRequest message or plain object |
callback | CreateServiceAccountCallback | Node-style callback called with the error, if any, and CreateServiceAccountResponse |
Returns
void
▸ createServiceAccount(request): Promise<CreateServiceAccountResponse>
Create a service account.
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateServiceAccountRequest | CreateServiceAccountRequest message or plain object |
Returns
Promise<CreateServiceAccountResponse>
Promise
createUser
▸ createUser(request, callback): void
Create a user
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateUserRequest | CreateUserRequest message or plain object |
callback | CreateUserCallback | Node-style callback called with the error, if any, and CreateUserResponse |
Returns
void
▸ createUser(request): Promise<CreateUserResponse>
Create a user
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateUserRequest | CreateUserRequest message or plain object |
Returns
Promise<CreateUserResponse>
Promise
createUserGroup
▸ createUserGroup(request, callback): void
Create new a user group
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateUserGroupRequest | CreateUserGroupRequest message or plain object |
callback | CreateUserGroupCallback | Node-style callback called with the error, if any, and CreateUserGroupResponse |
Returns
void
▸ createUserGroup(request): Promise<CreateUserGroupResponse>
Create new a user group
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateUserGroupRequest | CreateUserGroupRequest message or plain object |
Returns
Promise<CreateUserGroupResponse>
Promise
deleteApiKey
▸ deleteApiKey(request, callback): void
Delete an API key
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteApiKeyRequest | DeleteApiKeyRequest message or plain object |
callback | DeleteApiKeyCallback | Node-style callback called with the error, if any, and DeleteApiKeyResponse |
Returns
void
▸ deleteApiKey(request): Promise<DeleteApiKeyResponse>
Delete an API key
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteApiKeyRequest | DeleteApiKeyRequest message or plain object |
Returns
Promise<DeleteApiKeyResponse>
Promise
deleteNamespace
▸ deleteNamespace(request, callback): void
Delete a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteNamespaceRequest | DeleteNamespaceRequest message or plain object |
callback | DeleteNamespaceCallback | Node-style callback called with the error, if any, and DeleteNamespaceResponse |
Returns
void
▸ deleteNamespace(request): Promise<DeleteNamespaceResponse>
Delete a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteNamespaceRequest | DeleteNamespaceRequest message or plain object |
Returns
Promise<DeleteNamespaceResponse>
Promise
deleteServiceAccount
▸ deleteServiceAccount(request, callback): void
Delete a service account.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteServiceAccountRequest | DeleteServiceAccountRequest message or plain object |
callback | DeleteServiceAccountCallback | Node-style callback called with the error, if any, and DeleteServiceAccountResponse |
Returns
void
▸ deleteServiceAccount(request): Promise<DeleteServiceAccountResponse>
Delete a service account.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteServiceAccountRequest | DeleteServiceAccountRequest message or plain object |
Returns
Promise<DeleteServiceAccountResponse>
Promise
deleteUser
▸ deleteUser(request, callback): void
Delete a user
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteUserRequest | DeleteUserRequest message or plain object |
callback | DeleteUserCallback | Node-style callback called with the error, if any, and DeleteUserResponse |
Returns
void
▸ deleteUser(request): Promise<DeleteUserResponse>
Delete a user
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteUserRequest | DeleteUserRequest message or plain object |
Returns
Promise<DeleteUserResponse>
Promise
deleteUserGroup
▸ deleteUserGroup(request, callback): void
Delete a user group
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteUserGroupRequest | DeleteUserGroupRequest message or plain object |
callback | DeleteUserGroupCallback | Node-style callback called with the error, if any, and DeleteUserGroupResponse |
Returns
void
▸ deleteUserGroup(request): Promise<DeleteUserGroupResponse>
Delete a user group
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteUserGroupRequest | DeleteUserGroupRequest message or plain object |
Returns
Promise<DeleteUserGroupResponse>
Promise
emit
▸ emit(evt, ...args): this
Emits an event by calling its listeners with the specified arguments.
Parameters
| Name | Type | Description |
|---|---|---|
evt | string | Event name |
...args | any[] | Arguments |
Returns
this
this
Inherited from
$protobuf.rpc.Service.emit
end
▸ end(endedByRPC?): Service
Ends this service and emits the end event.
Parameters
| Name | Type | Description |
|---|---|---|
endedByRPC? | boolean | Whether the service has been ended by the RPC implementation. |
Returns
Service
this
Inherited from
$protobuf.rpc.Service.end
failoverNamespaceRegion
▸ failoverNamespaceRegion(request, callback): void
Failover a multi-region namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IFailoverNamespaceRegionRequest | FailoverNamespaceRegionRequest message or plain object |
callback | FailoverNamespaceRegionCallback | Node-style callback called with the error, if any, and FailoverNamespaceRegionResponse |
Returns
void
▸ failoverNamespaceRegion(request): Promise<FailoverNamespaceRegionResponse>
Failover a multi-region namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IFailoverNamespaceRegionRequest | FailoverNamespaceRegionRequest message or plain object |
Returns
Promise<FailoverNamespaceRegionResponse>
Promise
getApiKey
▸ getApiKey(request, callback): void
Get an API key
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetApiKeyRequest | GetApiKeyRequest message or plain object |
callback | GetApiKeyCallback | Node-style callback called with the error, if any, and GetApiKeyResponse |
Returns
void
▸ getApiKey(request): Promise<GetApiKeyResponse>
Get an API key
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetApiKeyRequest | GetApiKeyRequest message or plain object |
Returns
Promise<GetApiKeyResponse>
Promise
getApiKeys
▸ getApiKeys(request, callback): void
Get all known API keys
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetApiKeysRequest | GetApiKeysRequest message or plain object |
callback | GetApiKeysCallback | Node-style callback called with the error, if any, and GetApiKeysResponse |
Returns
void
▸ getApiKeys(request): Promise<GetApiKeysResponse>
Get all known API keys
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetApiKeysRequest | GetApiKeysRequest message or plain object |
Returns
Promise<GetApiKeysResponse>
Promise
getAsyncOperation
▸ getAsyncOperation(request, callback): void
Get the latest information on an async operation
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetAsyncOperationRequest | GetAsyncOperationRequest message or plain object |
callback | GetAsyncOperationCallback | Node-style callback called with the error, if any, and GetAsyncOperationResponse |
Returns
void
▸ getAsyncOperation(request): Promise<GetAsyncOperationResponse>
Get the latest information on an async operation
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetAsyncOperationRequest | GetAsyncOperationRequest message or plain object |
Returns
Promise<GetAsyncOperationResponse>
Promise
getNamespace
▸ getNamespace(request, callback): void
Get a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetNamespaceRequest | GetNamespaceRequest message or plain object |
callback | GetNamespaceCallback | Node-style callback called with the error, if any, and GetNamespaceResponse |
Returns
void
▸ getNamespace(request): Promise<GetNamespaceResponse>
Get a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetNamespaceRequest | GetNamespaceRequest message or plain object |
Returns
Promise<GetNamespaceResponse>
Promise
getNamespaces
▸ getNamespaces(request, callback): void
Get all namespaces
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetNamespacesRequest | GetNamespacesRequest message or plain object |
callback | GetNamespacesCallback | Node-style callback called with the error, if any, and GetNamespacesResponse |
Returns
void
▸ getNamespaces(request): Promise<GetNamespacesResponse>
Get all namespaces
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetNamespacesRequest | GetNamespacesRequest message or plain object |
Returns
Promise<GetNamespacesResponse>
Promise
getRegion
▸ getRegion(request, callback): void
Get a region
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetRegionRequest | GetRegionRequest message or plain object |
callback | GetRegionCallback | Node-style callback called with the error, if any, and GetRegionResponse |
Returns
void
▸ getRegion(request): Promise<GetRegionResponse>
Get a region
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetRegionRequest | GetRegionRequest message or plain object |
Returns
Promise<GetRegionResponse>
Promise
getRegions
▸ getRegions(request, callback): void
Get all regions
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetRegionsRequest | GetRegionsRequest message or plain object |
callback | GetRegionsCallback | Node-style callback called with the error, if any, and GetRegionsResponse |
Returns
void
▸ getRegions(request): Promise<GetRegionsResponse>
Get all regions
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetRegionsRequest | GetRegionsRequest message or plain object |
Returns
Promise<GetRegionsResponse>
Promise
getServiceAccount
▸ getServiceAccount(request, callback): void
Get a service account.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetServiceAccountRequest | GetServiceAccountRequest message or plain object |
callback | GetServiceAccountCallback | Node-style callback called with the error, if any, and GetServiceAccountResponse |
Returns
void
▸ getServiceAccount(request): Promise<GetServiceAccountResponse>
Get a service account.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetServiceAccountRequest | GetServiceAccountRequest message or plain object |
Returns
Promise<GetServiceAccountResponse>
Promise
getServiceAccounts
▸ getServiceAccounts(request, callback): void
Get service accounts.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetServiceAccountsRequest | GetServiceAccountsRequest message or plain object |
callback | GetServiceAccountsCallback | Node-style callback called with the error, if any, and GetServiceAccountsResponse |
Returns
void
▸ getServiceAccounts(request): Promise<GetServiceAccountsResponse>
Get service accounts.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetServiceAccountsRequest | GetServiceAccountsRequest message or plain object |
Returns
Promise<GetServiceAccountsResponse>
Promise
getUser
▸ getUser(request, callback): void
Get a user
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetUserRequest | GetUserRequest message or plain object |
callback | GetUserCallback | Node-style callback called with the error, if any, and GetUserResponse |
Returns
void
▸ getUser(request): Promise<GetUserResponse>
Get a user
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetUserRequest | GetUserRequest message or plain object |
Returns
Promise<GetUserResponse>
Promise
getUserGroup
▸ getUserGroup(request, callback): void
Get a user group
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetUserGroupRequest | GetUserGroupRequest message or plain object |
callback | GetUserGroupCallback | Node-style callback called with the error, if any, and GetUserGroupResponse |
Returns
void
▸ getUserGroup(request): Promise<GetUserGroupResponse>
Get a user group
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetUserGroupRequest | GetUserGroupRequest message or plain object |
Returns
Promise<GetUserGroupResponse>
Promise
getUserGroups
▸ getUserGroups(request, callback): void
Get all user groups
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetUserGroupsRequest | GetUserGroupsRequest message or plain object |
callback | GetUserGroupsCallback | Node-style callback called with the error, if any, and GetUserGroupsResponse |
Returns
void
▸ getUserGroups(request): Promise<GetUserGroupsResponse>
Get all user groups
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetUserGroupsRequest | GetUserGroupsRequest message or plain object |
Returns
Promise<GetUserGroupsResponse>
Promise
getUsers
▸ getUsers(request, callback): void
Gets all known users
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetUsersRequest | GetUsersRequest message or plain object |
callback | GetUsersCallback | Node-style callback called with the error, if any, and GetUsersResponse |
Returns
void
▸ getUsers(request): Promise<GetUsersResponse>
Gets all known users
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetUsersRequest | GetUsersRequest message or plain object |
Returns
Promise<GetUsersResponse>
Promise
off
▸ off(evt?, fn?): this
Removes an event listener or any matching listeners if arguments are omitted.
Parameters
| Name | Type | Description |
|---|---|---|
evt? | string | Event name. Removes all listeners if omitted. |
fn? | EventEmitterListener | Listener to remove. Removes all listeners of evt if omitted. |
Returns
this
this
Inherited from
$protobuf.rpc.Service.off
on
▸ on(evt, fn, ctx?): this
Registers an event listener.
Parameters
| Name | Type | Description |
|---|---|---|
evt | string | Event name |
fn | EventEmitterListener | Listener |
ctx? | any | Listener context |
Returns
this
this
Inherited from
$protobuf.rpc.Service.on
renameCustomSearchAttribute
▸ renameCustomSearchAttribute(request, callback): void
Rename an existing customer search attribute
Parameters
| Name | Type | Description |
|---|---|---|
request | IRenameCustomSearchAttributeRequest | RenameCustomSearchAttributeRequest message or plain object |
callback | RenameCustomSearchAttributeCallback | Node-style callback called with the error, if any, and RenameCustomSearchAttributeResponse |
Returns
void
▸ renameCustomSearchAttribute(request): Promise<RenameCustomSearchAttributeResponse>
Rename an existing customer search attribute
Parameters
| Name | Type | Description |
|---|---|---|
request | IRenameCustomSearchAttributeRequest | RenameCustomSearchAttributeRequest message or plain object |
Returns
Promise<RenameCustomSearchAttributeResponse>
Promise
rpcCall
▸ rpcCall<TReq, TRes>(method, requestCtor, responseCtor, request, callback): void
Calls a service method through rpcImpl.
Type parameters
| Name | Type |
|---|---|
TReq | extends Message<TReq> |
TRes | extends Message<TRes> |
Parameters
| Name | Type | Description |
|---|---|---|
method | Method | ServiceMethod<TReq, TRes> | Reflected or static method |
requestCtor | Constructor<TReq> | Request constructor |
responseCtor | Constructor<TRes> | Response constructor |
request | TReq | Properties<TReq> | Request message or plain object |
callback | ServiceMethodCallback<TRes> | Service callback |
Returns
void
Inherited from
$protobuf.rpc.Service.rpcCall
setUserGroupNamespaceAccess
▸ setUserGroupNamespaceAccess(request, callback): void
Set a user group's access to a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | ISetUserGroupNamespaceAccessRequest | SetUserGroupNamespaceAccessRequest message or plain object |
callback | SetUserGroupNamespaceAccessCallback | Node-style callback called with the error, if any, and SetUserGroupNamespaceAccessResponse |
Returns
void
▸ setUserGroupNamespaceAccess(request): Promise<SetUserGroupNamespaceAccessResponse>
Set a user group's access to a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | ISetUserGroupNamespaceAccessRequest | SetUserGroupNamespaceAccessRequest message or plain object |
Returns
Promise<SetUserGroupNamespaceAccessResponse>
Promise
setUserNamespaceAccess
▸ setUserNamespaceAccess(request, callback): void
Set a user's access to a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | ISetUserNamespaceAccessRequest | SetUserNamespaceAccessRequest message or plain object |
callback | SetUserNamespaceAccessCallback | Node-style callback called with the error, if any, and SetUserNamespaceAccessResponse |
Returns
void
▸ setUserNamespaceAccess(request): Promise<SetUserNamespaceAccessResponse>
Set a user's access to a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | ISetUserNamespaceAccessRequest | SetUserNamespaceAccessRequest message or plain object |
Returns
Promise<SetUserNamespaceAccessResponse>
Promise
updateApiKey
▸ updateApiKey(request, callback): void
Update an API key
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateApiKeyRequest | UpdateApiKeyRequest message or plain object |
callback | UpdateApiKeyCallback | Node-style callback called with the error, if any, and UpdateApiKeyResponse |
Returns
void
▸ updateApiKey(request): Promise<UpdateApiKeyResponse>
Update an API key
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateApiKeyRequest | UpdateApiKeyRequest message or plain object |
Returns
Promise<UpdateApiKeyResponse>
Promise
updateNamespace
▸ updateNamespace(request, callback): void
Update a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateNamespaceRequest | UpdateNamespaceRequest message or plain object |
callback | UpdateNamespaceCallback | Node-style callback called with the error, if any, and UpdateNamespaceResponse |
Returns
void
▸ updateNamespace(request): Promise<UpdateNamespaceResponse>
Update a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateNamespaceRequest | UpdateNamespaceRequest message or plain object |
Returns
Promise<UpdateNamespaceResponse>
Promise
updateServiceAccount
▸ updateServiceAccount(request, callback): void
Update a service account.
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateServiceAccountRequest | UpdateServiceAccountRequest message or plain object |
callback | UpdateServiceAccountCallback | Node-style callback called with the error, if any, and UpdateServiceAccountResponse |
Returns
void
▸ updateServiceAccount(request): Promise<UpdateServiceAccountResponse>
Update a service account.
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateServiceAccountRequest | UpdateServiceAccountRequest message or plain object |
Returns
Promise<UpdateServiceAccountResponse>
Promise
updateUser
▸ updateUser(request, callback): void
Update a user
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateUserRequest | UpdateUserRequest message or plain object |
callback | UpdateUserCallback | Node-style callback called with the error, if any, and UpdateUserResponse |
Returns
void
▸ updateUser(request): Promise<UpdateUserResponse>
Update a user
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateUserRequest | UpdateUserRequest message or plain object |
Returns
Promise<UpdateUserResponse>
Promise
updateUserGroup
▸ updateUserGroup(request, callback): void
Update a user group
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateUserGroupRequest | UpdateUserGroupRequest message or plain object |
callback | UpdateUserGroupCallback | Node-style callback called with the error, if any, and UpdateUserGroupResponse |
Returns
void
▸ updateUserGroup(request): Promise<UpdateUserGroupResponse>
Update a user group
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateUserGroupRequest | UpdateUserGroupRequest message or plain object |
Returns
Promise<UpdateUserGroupResponse>
Promise
create
▸ create(rpcImpl, requestDelimited?, responseDelimited?): CloudService
Creates new CloudService service using the specified rpc implementation.
Parameters
| Name | Type | Description |
|---|---|---|
rpcImpl | RPCImpl | RPC implementation |
requestDelimited? | boolean | Whether requests are length-delimited |
responseDelimited? | boolean | Whether responses are length-delimited |
Returns
RPC service. Useful where requests and/or responses are streamed.