InstanceAdmin

google .spanner .admin .instance .v1. InstanceAdmin

Represents an InstanceAdmin

Constructor

new InstanceAdmin(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new InstanceAdmin service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {InstanceAdmin}

Creates new InstanceAdmin service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

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

createInstance(request, callback) → {undefined}

Calls CreateInstance.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.instance.v1.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
undefined

createInstance(request) → {Promise.<google.longrunning.Operation>}

Calls CreateInstance.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.instance.v1.ICreateInstanceRequest	CreateInstanceRequest message or plain object

Returns:

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

deleteInstance(request, callback) → {undefined}

Calls DeleteInstance.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.instance.v1.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
undefined

deleteInstance(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteInstance.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.instance.v1.IDeleteInstanceRequest	DeleteInstanceRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.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
undefined

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.IGetIamPolicyRequest	GetIamPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.Policy>	Promise

getInstance(request, callback) → {undefined}

Calls GetInstance.

Parameters:

Name	Type	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
undefined

getInstance(request) → {Promise.<google.spanner.admin.instance.v1.Instance>}

Calls GetInstance.

Parameters:

Name	Type	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) → {undefined}

Calls GetInstanceConfig.

Parameters:

Name	Type	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
undefined

getInstanceConfig(request) → {Promise.<google.spanner.admin.instance.v1.InstanceConfig>}

Calls GetInstanceConfig.

Parameters:

Name	Type	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) → {undefined}

Calls ListInstanceConfigs.

Parameters:

Name	Type	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
undefined

listInstanceConfigs(request) → {Promise.<google.spanner.admin.instance.v1.ListInstanceConfigsResponse>}

Calls ListInstanceConfigs.

Parameters:

Name	Type	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) → {undefined}

Calls ListInstances.

Parameters:

Name	Type	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
undefined

listInstances(request) → {Promise.<google.spanner.admin.instance.v1.ListInstancesResponse>}

Calls ListInstances.

Parameters:

Name	Type	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) → {undefined}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.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
undefined

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ISetIamPolicyRequest	SetIamPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.Policy>	Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:

Name	Type	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
undefined

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ITestIamPermissionsRequest	TestIamPermissionsRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.TestIamPermissionsResponse>	Promise

updateInstance(request, callback) → {undefined}

Calls UpdateInstance.

Parameters:

Name	Type	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
undefined

updateInstance(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateInstance.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.instance.v1.IUpdateInstanceRequest	UpdateInstanceRequest message or plain object

Returns:

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

Type Definitions

CreateInstanceCallback(error, responseopt)

Callback as used by google.spanner.admin.instance.v1.InstanceAdmin#createInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteInstanceCallback(error, responseopt)

Callback as used by google.spanner.admin.instance.v1.InstanceAdmin#deleteInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

GetIamPolicyCallback(error, responseopt)

Callback as used by google.spanner.admin.instance.v1.InstanceAdmin#getIamPolicy.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.iam.v1.Policy	<optional>	Policy

GetInstanceCallback(error, responseopt)

Callback as used by google.spanner.admin.instance.v1.InstanceAdmin#getInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.spanner.admin.instance.v1.Instance	<optional>	Instance

GetInstanceConfigCallback(error, responseopt)

Callback as used by google.spanner.admin.instance.v1.InstanceAdmin#getInstanceConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.spanner.admin.instance.v1.InstanceConfig	<optional>	InstanceConfig

ListInstanceConfigsCallback(error, responseopt)

Callback as used by google.spanner.admin.instance.v1.InstanceAdmin#listInstanceConfigs.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.spanner.admin.instance.v1.ListInstanceConfigsResponse	<optional>	ListInstanceConfigsResponse

ListInstancesCallback(error, responseopt)

Callback as used by google.spanner.admin.instance.v1.InstanceAdmin#listInstances.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.spanner.admin.instance.v1.ListInstancesResponse	<optional>	ListInstancesResponse

SetIamPolicyCallback(error, responseopt)

Callback as used by google.spanner.admin.instance.v1.InstanceAdmin#setIamPolicy.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.iam.v1.Policy	<optional>	Policy

TestIamPermissionsCallback(error, responseopt)

Callback as used by google.spanner.admin.instance.v1.InstanceAdmin#testIamPermissions.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.iam.v1.TestIamPermissionsResponse	<optional>	TestIamPermissionsResponse

UpdateInstanceCallback(error, responseopt)

Callback as used by google.spanner.admin.instance.v1.InstanceAdmin#updateInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation