Class protos.google.spanner.admin.instance.v1.InstanceAdmin (5.15.2)

Represents an InstanceAdmin

Inheritance

$protobuf.rpc.Service > protos.google.spanner.admin.instance.v1.InstanceAdmin

Package

@google-cloud/spanner

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new InstanceAdmin service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): InstanceAdmin;

Creates new InstanceAdmin service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
InstanceAdmin

RPC service. Useful where requests and/or responses are streamed.

createInstance(request, callback)

public createInstance(request: google.spanner.admin.instance.v1.ICreateInstanceRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceCallback): void;

Calls CreateInstance.

Parameters
Name Description
request ICreateInstanceRequest

CreateInstanceRequest message or plain object
callback google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createInstance(request)

public createInstance(request: google.spanner.admin.instance.v1.ICreateInstanceRequest): Promise<google.longrunning.Operation>;

Calls CreateInstance.

Parameter
Name Description
request ICreateInstanceRequest

CreateInstanceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteInstance(request, callback)

public deleteInstance(request: google.spanner.admin.instance.v1.IDeleteInstanceRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstanceCallback): void;

Calls DeleteInstance.

Parameters
Name Description
request IDeleteInstanceRequest

DeleteInstanceRequest message or plain object
callback google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstanceCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteInstance(request)

public deleteInstance(request: google.spanner.admin.instance.v1.IDeleteInstanceRequest): Promise<google.protobuf.Empty>;

Calls DeleteInstance.

Parameter
Name Description
request IDeleteInstanceRequest

DeleteInstanceRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters
Name Description
request IGetIamPolicyRequest

GetIamPolicyRequest message or plain object
callback google.spanner.admin.instance.v1.InstanceAdmin.GetIamPolicyCallback

Node-style callback called with the error, if any, and Policy
Returns
Type Description
void

getIamPolicy(request)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls GetIamPolicy.

Parameter
Name Description
request IGetIamPolicyRequest

GetIamPolicyRequest message or plain object
Returns
Type Description
Promise<google.iam.v1.Policy>

Promise

getInstance(request, callback)

public getInstance(request: google.spanner.admin.instance.v1.IGetInstanceRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceCallback): void;

Calls GetInstance.

Parameters
Name Description
request google.spanner.admin.instance.v1.IGetInstanceRequest

GetInstanceRequest message or plain object
callback google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceCallback

Node-style callback called with the error, if any, and Instance
Returns
Type Description
void

getInstance(request)

public getInstance(request: google.spanner.admin.instance.v1.IGetInstanceRequest): Promise<google.spanner.admin.instance.v1.Instance>;

Calls GetInstance.

Parameter
Name Description
request google.spanner.admin.instance.v1.IGetInstanceRequest

GetInstanceRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.instance.v1.Instance>

Promise

getInstanceConfig(request, callback)

public getInstanceConfig(request: google.spanner.admin.instance.v1.IGetInstanceConfigRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfigCallback): void;

Calls GetInstanceConfig.

Parameters
Name Description
request google.spanner.admin.instance.v1.IGetInstanceConfigRequest

GetInstanceConfigRequest message or plain object
callback google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfigCallback

Node-style callback called with the error, if any, and InstanceConfig
Returns
Type Description
void

getInstanceConfig(request)

public getInstanceConfig(request: google.spanner.admin.instance.v1.IGetInstanceConfigRequest): Promise<google.spanner.admin.instance.v1.InstanceConfig>;

Calls GetInstanceConfig.

Parameter
Name Description
request google.spanner.admin.instance.v1.IGetInstanceConfigRequest

GetInstanceConfigRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.instance.v1.InstanceConfig>

Promise

listInstanceConfigs(request, callback)

public listInstanceConfigs(request: google.spanner.admin.instance.v1.IListInstanceConfigsRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigsCallback): void;

Calls ListInstanceConfigs.

Parameters
Name Description
request google.spanner.admin.instance.v1.IListInstanceConfigsRequest

ListInstanceConfigsRequest message or plain object
callback google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigsCallback

Node-style callback called with the error, if any, and ListInstanceConfigsResponse
Returns
Type Description
void

listInstanceConfigs(request)

public listInstanceConfigs(request: google.spanner.admin.instance.v1.IListInstanceConfigsRequest): Promise<google.spanner.admin.instance.v1.ListInstanceConfigsResponse>;

Calls ListInstanceConfigs.

Parameter
Name Description
request google.spanner.admin.instance.v1.IListInstanceConfigsRequest

ListInstanceConfigsRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.instance.v1.ListInstanceConfigsResponse>

Promise

listInstances(request, callback)

public listInstances(request: google.spanner.admin.instance.v1.IListInstancesRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.ListInstancesCallback): void;

Calls ListInstances.

Parameters
Name Description
request google.spanner.admin.instance.v1.IListInstancesRequest

ListInstancesRequest message or plain object
callback google.spanner.admin.instance.v1.InstanceAdmin.ListInstancesCallback

Node-style callback called with the error, if any, and ListInstancesResponse
Returns
Type Description
void

listInstances(request)

public listInstances(request: google.spanner.admin.instance.v1.IListInstancesRequest): Promise<google.spanner.admin.instance.v1.ListInstancesResponse>;

Calls ListInstances.

Parameter
Name Description
request google.spanner.admin.instance.v1.IListInstancesRequest

ListInstancesRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.instance.v1.ListInstancesResponse>

Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters
Name Description
request ISetIamPolicyRequest

SetIamPolicyRequest message or plain object
callback google.spanner.admin.instance.v1.InstanceAdmin.SetIamPolicyCallback

Node-style callback called with the error, if any, and Policy
Returns
Type Description
void

setIamPolicy(request)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls SetIamPolicy.

Parameter
Name Description
request ISetIamPolicyRequest

SetIamPolicyRequest message or plain object
Returns
Type Description
Promise<google.iam.v1.Policy>

Promise

testIamPermissions(request, callback)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters
Name Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object
callback google.spanner.admin.instance.v1.InstanceAdmin.TestIamPermissionsCallback

Node-style callback called with the error, if any, and TestIamPermissionsResponse
Returns
Type Description
void

testIamPermissions(request)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;

Calls TestIamPermissions.

Parameter
Name Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object
Returns
Type Description
Promise<google.iam.v1.TestIamPermissionsResponse>

Promise

updateInstance(request, callback)

public updateInstance(request: google.spanner.admin.instance.v1.IUpdateInstanceRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceCallback): void;

Calls UpdateInstance.

Parameters
Name Description
request google.spanner.admin.instance.v1.IUpdateInstanceRequest

UpdateInstanceRequest message or plain object
callback google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateInstance(request)

public updateInstance(request: google.spanner.admin.instance.v1.IUpdateInstanceRequest): Promise<google.longrunning.Operation>;

Calls UpdateInstance.

Parameter
Name Description
request google.spanner.admin.instance.v1.IUpdateInstanceRequest

UpdateInstanceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise