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
addUserGroupMember
▸ addUserGroupMember(request, callback): void
Add a member to the group, can only be used with Cloud group types.
Parameters
| Name | Type | Description |
|---|---|---|
request | IAddUserGroupMemberRequest | AddUserGroupMemberRequest message or plain object |
callback | AddUserGroupMemberCallback | Node-style callback called with the error, if any, and AddUserGroupMemberResponse |
Returns
void
▸ addUserGroupMember(request): Promise<AddUserGroupMemberResponse>
Add a member to the group, can only be used with Cloud group types.
Parameters
| Name | Type | Description |
|---|---|---|
request | IAddUserGroupMemberRequest | AddUserGroupMemberRequest message or plain object |
Returns
Promise<AddUserGroupMemberResponse>
Promise
createAccountAuditLogSink
▸ createAccountAuditLogSink(request, callback): void
Create an audit log sink
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateAccountAuditLogSinkRequest | CreateAccountAuditLogSinkRequest message or plain object |
callback | CreateAccountAuditLogSinkCallback | Node-style callback called with the error, if any, and CreateAccountAuditLogSinkResponse |
Returns
void
▸ createAccountAuditLogSink(request): Promise<CreateAccountAuditLogSinkResponse>
Create an audit log sink
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateAccountAuditLogSinkRequest | CreateAccountAuditLogSinkRequest message or plain object |
Returns
Promise<CreateAccountAuditLogSinkResponse>
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
createBillingReport
▸ createBillingReport(request, callback): void
Create a billing report
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateBillingReportRequest | CreateBillingReportRequest message or plain object |
callback | CreateBillingReportCallback | Node-style callback called with the error, if any, and CreateBillingReportResponse |
Returns
void
▸ createBillingReport(request): Promise<CreateBillingReportResponse>
Create a billing report
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateBillingReportRequest | CreateBillingReportRequest message or plain object |
Returns
Promise<CreateBillingReportResponse>
Promise
createConnectivityRule
▸ createConnectivityRule(request, callback): void
Creates a connectivity rule
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateConnectivityRuleRequest | CreateConnectivityRuleRequest message or plain object |
callback | CreateConnectivityRuleCallback | Node-style callback called with the error, if any, and CreateConnectivityRuleResponse |
Returns
void
▸ createConnectivityRule(request): Promise<CreateConnectivityRuleResponse>
Creates a connectivity rule
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateConnectivityRuleRequest | CreateConnectivityRuleRequest message or plain object |
Returns
Promise<CreateConnectivityRuleResponse>
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
createNamespaceExportSink
▸ createNamespaceExportSink(request, callback): void
Create an export sink
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateNamespaceExportSinkRequest | CreateNamespaceExportSinkRequest message or plain object |
callback | CreateNamespaceExportSinkCallback | Node-style callback called with the error, if any, and CreateNamespaceExportSinkResponse |
Returns
void
▸ createNamespaceExportSink(request): Promise<CreateNamespaceExportSinkResponse>
Create an export sink
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateNamespaceExportSinkRequest | CreateNamespaceExportSinkRequest message or plain object |
Returns
Promise<CreateNamespaceExportSinkResponse>
Promise
createNexusEndpoint
▸ createNexusEndpoint(request, callback): void
Create a nexus endpoint
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateNexusEndpointRequest | CreateNexusEndpointRequest message or plain object |
callback | CreateNexusEndpointCallback | Node-style callback called with the error, if any, and CreateNexusEndpointResponse |
Returns
void
▸ createNexusEndpoint(request): Promise<CreateNexusEndpointResponse>
Create a nexus endpoint
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateNexusEndpointRequest | CreateNexusEndpointRequest message or plain object |
Returns
Promise<CreateNexusEndpointResponse>
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
deleteAccountAuditLogSink
▸ deleteAccountAuditLogSink(request, callback): void
Delete an audit log sink
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteAccountAuditLogSinkRequest | DeleteAccountAuditLogSinkRequest message or plain object |
callback | DeleteAccountAuditLogSinkCallback | Node-style callback called with the error, if any, and DeleteAccountAuditLogSinkResponse |
Returns
void
▸ deleteAccountAuditLogSink(request): Promise<DeleteAccountAuditLogSinkResponse>
Delete an audit log sink
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteAccountAuditLogSinkRequest | DeleteAccountAuditLogSinkRequest message or plain object |
Returns
Promise<DeleteAccountAuditLogSinkResponse>
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
deleteConnectivityRule
▸ deleteConnectivityRule(request, callback): void
Deletes a connectivity rule by id
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteConnectivityRuleRequest | DeleteConnectivityRuleRequest message or plain object |
callback | DeleteConnectivityRuleCallback | Node-style callback called with the error, if any, and DeleteConnectivityRuleResponse |
Returns
void
▸ deleteConnectivityRule(request): Promise<DeleteConnectivityRuleResponse>
Deletes a connectivity rule by id
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteConnectivityRuleRequest | DeleteConnectivityRuleRequest message or plain object |
Returns
Promise<DeleteConnectivityRuleResponse>
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
deleteNamespaceExportSink
▸ deleteNamespaceExportSink(request, callback): void
Delete an export sink
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteNamespaceExportSinkRequest | DeleteNamespaceExportSinkRequest message or plain object |
callback | DeleteNamespaceExportSinkCallback | Node-style callback called with the error, if any, and DeleteNamespaceExportSinkResponse |
Returns
void
▸ deleteNamespaceExportSink(request): Promise<DeleteNamespaceExportSinkResponse>
Delete an export sink
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteNamespaceExportSinkRequest | DeleteNamespaceExportSinkRequest message or plain object |
Returns
Promise<DeleteNamespaceExportSinkResponse>
Promise
deleteNamespaceRegion
▸ deleteNamespaceRegion(request, callback): void
Delete a region from a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteNamespaceRegionRequest | DeleteNamespaceRegionRequest message or plain object |
callback | DeleteNamespaceRegionCallback | Node-style callback called with the error, if any, and DeleteNamespaceRegionResponse |
Returns
void
▸ deleteNamespaceRegion(request): Promise<DeleteNamespaceRegionResponse>
Delete a region from a namespace
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteNamespaceRegionRequest | DeleteNamespaceRegionRequest message or plain object |
Returns
Promise<DeleteNamespaceRegionResponse>
Promise
deleteNexusEndpoint
▸ deleteNexusEndpoint(request, callback): void
Delete a nexus endpoint
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteNexusEndpointRequest | DeleteNexusEndpointRequest message or plain object |
callback | DeleteNexusEndpointCallback | Node-style callback called with the error, if any, and DeleteNexusEndpointResponse |
Returns
void
▸ deleteNexusEndpoint(request): Promise<DeleteNexusEndpointResponse>
Delete a nexus endpoint
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteNexusEndpointRequest | DeleteNexusEndpointRequest message or plain object |
Returns
Promise<DeleteNexusEndpointResponse>
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
getAccount
▸ getAccount(request, callback): void
Get account information.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetAccountRequest | GetAccountRequest message or plain object |
callback | GetAccountCallback | Node-style callback called with the error, if any, and GetAccountResponse |
Returns
void
▸ getAccount(request): Promise<GetAccountResponse>
Get account information.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetAccountRequest | GetAccountRequest message or plain object |
Returns
Promise<GetAccountResponse>
Promise
getAccountAuditLogSink
▸ getAccountAuditLogSink(request, callback): void
Get an audit log sink
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetAccountAuditLogSinkRequest | GetAccountAuditLogSinkRequest message or plain object |
callback | GetAccountAuditLogSinkCallback | Node-style callback called with the error, if any, and GetAccountAuditLogSinkResponse |
Returns
void
▸ getAccountAuditLogSink(request): Promise<GetAccountAuditLogSinkResponse>
Get an audit log sink
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetAccountAuditLogSinkRequest | GetAccountAuditLogSinkRequest message or plain object |
Returns
Promise<GetAccountAuditLogSinkResponse>
Promise
getAccountAuditLogSinks
▸ getAccountAuditLogSinks(request, callback): void
Get audit log sinks
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetAccountAuditLogSinksRequest | GetAccountAuditLogSinksRequest message or plain object |
callback | GetAccountAuditLogSinksCallback | Node-style callback called with the error, if any, and GetAccountAuditLogSinksResponse |
Returns
void
▸ getAccountAuditLogSinks(request): Promise<GetAccountAuditLogSinksResponse>
Get audit log sinks
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetAccountAuditLogSinksRequest | GetAccountAuditLogSinksRequest message or plain object |
Returns
Promise<GetAccountAuditLogSinksResponse>
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
getAuditLogs
▸ getAuditLogs(request, callback): void
Get audit logs
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetAuditLogsRequest | GetAuditLogsRequest message or plain object |
callback | GetAuditLogsCallback | Node-style callback called with the error, if any, and GetAuditLogsResponse |
Returns
void
▸ getAuditLogs(request): Promise<GetAuditLogsResponse>
Get audit logs
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetAuditLogsRequest | GetAuditLogsRequest message or plain object |
Returns
Promise<GetAuditLogsResponse>
Promise
getBillingReport
▸ getBillingReport(request, callback): void
Get a billing report
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetBillingReportRequest | GetBillingReportRequest message or plain object |
callback | GetBillingReportCallback | Node-style callback called with the error, if any, and GetBillingReportResponse |
Returns
void
▸ getBillingReport(request): Promise<GetBillingReportResponse>
Get a billing report
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetBillingReportRequest | GetBillingReportRequest message or plain object |
Returns
Promise<GetBillingReportResponse>
Promise
getConnectivityRule
▸ getConnectivityRule(request, callback): void
Gets a connectivity rule by id
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetConnectivityRuleRequest | GetConnectivityRuleRequest message or plain object |
callback | GetConnectivityRuleCallback | Node-style callback called with the error, if any, and GetConnectivityRuleResponse |
Returns
void
▸ getConnectivityRule(request): Promise<GetConnectivityRuleResponse>
Gets a connectivity rule by id