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

Version latest

• 7.5.0 (latest)
• 7.4.0
• 7.3.0
• 7.2.0
• 7.1.0
• 7.0.0
• 6.16.0
• 6.15.0
• 6.14.0
• 6.13.0
• 6.12.0
• 6.11.0
• 6.10.1
• 5.15.2
• 5.14.0
• 5.13.1
• 5.12.0
• 5.11.1
• 5.10.0
• 5.9.3
• 5.8.1

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	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

createInstanceConfig(request, callback)

public createInstanceConfig(request: google.spanner.admin.instance.v1.ICreateInstanceConfigRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceConfigCallback): void;

Calls CreateInstanceConfig.

Parameters
Name	Description
request	ICreateInstanceConfigRequest CreateInstanceConfigRequest message or plain object
callback	CreateInstanceConfigCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createInstanceConfig(request)

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

Calls CreateInstanceConfig.

Parameter
Name	Description
request	ICreateInstanceConfigRequest CreateInstanceConfigRequest 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	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

deleteInstanceConfig(request, callback)

public deleteInstanceConfig(request: google.spanner.admin.instance.v1.IDeleteInstanceConfigRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstanceConfigCallback): void;

Calls DeleteInstanceConfig.

Parameters
Name	Description
request	IDeleteInstanceConfigRequest DeleteInstanceConfigRequest message or plain object
callback	DeleteInstanceConfigCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteInstanceConfig(request)

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

Calls DeleteInstanceConfig.

Parameter
Name	Description
request	IDeleteInstanceConfigRequest DeleteInstanceConfigRequest 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	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	IGetInstanceRequest GetInstanceRequest message or plain object
callback	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	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	IGetInstanceConfigRequest GetInstanceConfigRequest message or plain object
callback	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	IGetInstanceConfigRequest GetInstanceConfigRequest message or plain object

Returns
Type	Description
Promise<google.spanner.admin.instance.v1.InstanceConfig>	Promise

listInstanceConfigOperations(request, callback)

public listInstanceConfigOperations(request: google.spanner.admin.instance.v1.IListInstanceConfigOperationsRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperationsCallback): void;

Calls ListInstanceConfigOperations.

Parameters
Name	Description
request	IListInstanceConfigOperationsRequest ListInstanceConfigOperationsRequest message or plain object
callback	ListInstanceConfigOperationsCallback Node-style callback called with the error, if any, and ListInstanceConfigOperationsResponse

Returns
Type	Description
void

listInstanceConfigOperations(request)

public listInstanceConfigOperations(request: google.spanner.admin.instance.v1.IListInstanceConfigOperationsRequest): Promise<google.spanner.admin.instance.v1.ListInstanceConfigOperationsResponse>;

Calls ListInstanceConfigOperations.

Parameter
Name	Description
request	IListInstanceConfigOperationsRequest ListInstanceConfigOperationsRequest message or plain object

Returns
Type	Description
Promise<google.spanner.admin.instance.v1.ListInstanceConfigOperationsResponse>	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	IListInstanceConfigsRequest ListInstanceConfigsRequest message or plain object
callback	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	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	IListInstancesRequest ListInstancesRequest message or plain object
callback	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	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	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	ITestIamPermissionsRequest TestIamPermissionsRequest message or plain object
callback	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	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	IUpdateInstanceRequest UpdateInstanceRequest message or plain object
callback	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	IUpdateInstanceRequest UpdateInstanceRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateInstanceConfig(request, callback)

public updateInstanceConfig(request: google.spanner.admin.instance.v1.IUpdateInstanceConfigRequest, callback: google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceConfigCallback): void;

Calls UpdateInstanceConfig.

Parameters
Name	Description
request	IUpdateInstanceConfigRequest UpdateInstanceConfigRequest message or plain object
callback	UpdateInstanceConfigCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateInstanceConfig(request)

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

Calls UpdateInstanceConfig.

Parameter
Name	Description
request	IUpdateInstanceConfigRequest UpdateInstanceConfigRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise