Class InstanceAdmin.InstanceAdminBase (3.15.1)

Version 3.15.1

• 5.0.0-beta05 (latest)
• 5.0.0-beta04
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.15.1
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0

[BindServiceMethod(typeof(InstanceAdmin), "BindService")]
public abstract class InstanceAdminBase

Base class for server-side implementations of InstanceAdmin

Inheritance

Object > InstanceAdmin.InstanceAdminBase

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Spanner.Admin.Instance.V1

Assembly

Google.Cloud.Spanner.Admin.Instance.V1.dll

Methods

CreateInstance(CreateInstanceRequest, ServerCallContext)

public virtual Task<Operation> CreateInstance(CreateInstanceRequest request, ServerCallContext context)

Creates an instance and begins preparing it to begin serving. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, CreateInstance returns ALREADY_EXISTS.

Immediately upon completion of this request:

• The instance is readable via the API, with all requested attributes but no allocated resources. Its state is CREATING.

Until completion of the returned operation:

• Cancelling the operation renders the instance immediately unreadable via the API.
• The instance can be deleted.
• All other attempts to modify the instance are rejected.

Upon completion of the returned operation:

• Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
• Databases can be created in the instance.
• The instance's allocated resource levels are readable via the API.
• The instance's state becomes READY.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format <instance_name>/operations/<operation_id> and can be used to track creation of the instance. The [metadata][google.longrunning.Operation.metadata] field type is [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is [Instance][google.spanner.admin.instance.v1.Instance], if successful.

Parameters
Name	Description
request	CreateInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<Operation>	The response to send back to the client (wrapped by a task).

DeleteInstance(DeleteInstanceRequest, ServerCallContext)

public virtual Task<Empty> DeleteInstance(DeleteInstanceRequest request, ServerCallContext context)

Deletes an instance.

Immediately upon completion of the request:

• Billing ceases for all of the instance's reserved resources.

Soon afterward:

• The instance and all of its databases immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.

Parameters
Name	Description
request	DeleteInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)

Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.

Authorization requires spanner.instances.getIamPolicy on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
Name	Description
request	GetIamPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<Policy>	The response to send back to the client (wrapped by a task).

GetInstance(GetInstanceRequest, ServerCallContext)

public virtual Task<Instance> GetInstance(GetInstanceRequest request, ServerCallContext context)

Gets information about a particular instance.

Parameters
Name	Description
request	GetInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<Instance>	The response to send back to the client (wrapped by a task).

GetInstanceConfig(GetInstanceConfigRequest, ServerCallContext)

public virtual Task<InstanceConfig> GetInstanceConfig(GetInstanceConfigRequest request, ServerCallContext context)

Gets information about a particular instance configuration.

Parameters
Name	Description
request	GetInstanceConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<InstanceConfig>	The response to send back to the client (wrapped by a task).

ListInstanceConfigs(ListInstanceConfigsRequest, ServerCallContext)

public virtual Task<ListInstanceConfigsResponse> ListInstanceConfigs(ListInstanceConfigsRequest request, ServerCallContext context)

Lists the supported instance configurations for a given project.

Parameters
Name	Description
request	ListInstanceConfigsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<ListInstanceConfigsResponse>	The response to send back to the client (wrapped by a task).

ListInstances(ListInstancesRequest, ServerCallContext)

public virtual Task<ListInstancesResponse> ListInstances(ListInstancesRequest request, ServerCallContext context)

Lists all instances in the given project.

Parameters
Name	Description
request	ListInstancesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<ListInstancesResponse>	The response to send back to the client (wrapped by a task).

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)

Sets the access control policy on an instance resource. Replaces any existing policy.

Authorization requires spanner.instances.setIamPolicy on [resource][google.iam.v1.SetIamPolicyRequest.resource].

Parameters
Name	Description
request	SetIamPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<Policy>	The response to send back to the client (wrapped by a task).

TestIamPermissions(TestIamPermissionsRequest, ServerCallContext)

public virtual Task<TestIamPermissionsResponse> TestIamPermissions(TestIamPermissionsRequest request, ServerCallContext context)

Returns permissions that the caller has on the specified instance resource.

Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has spanner.instances.list permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.

Parameters
Name	Description
request	TestIamPermissionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<TestIamPermissionsResponse>	The response to send back to the client (wrapped by a task).

UpdateInstance(UpdateInstanceRequest, ServerCallContext)

public virtual Task<Operation> UpdateInstance(UpdateInstanceRequest request, ServerCallContext context)

Updates an instance, and begins allocating or releasing resources as requested. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the instance. If the named instance does not exist, returns NOT_FOUND.

Immediately upon completion of this request:

• For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level.

Until completion of the returned operation:

• Cancelling the operation sets its metadata's [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a CANCELLED status.
• All other attempts to modify the instance are rejected.
• Reading the instance via the API continues to give the pre-request resource levels.

Upon completion of the returned operation:

• Billing begins for all successfully-allocated resources (some types may have lower than the requested levels).
• All newly-reserved resources are available for serving the instance's tables.
• The instance's new resource levels are readable via the API.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format <instance_name>/operations/<operation_id> and can be used to track the instance modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is [Instance][google.spanner.admin.instance.v1.Instance], if successful.

Authorization requires spanner.instances.update permission on resource [name][google.spanner.admin.instance.v1.Instance.name].

Parameters
Name	Description
request	UpdateInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<Operation>	The response to send back to the client (wrapped by a task).