Class ProjectsResource.InstancesResource.InstancePartitionsResource

The "instancePartitions" collection of methods.

Inheritance

object

ProjectsResource.InstancesResource.InstancePartitionsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Spanner.v1

Assembly: Google.Apis.Spanner.v1.dll

Syntax

public class ProjectsResource.InstancesResource.InstancePartitionsResource

Constructors

InstancePartitionsResource(IClientService)

Constructs a new resource.

Declaration

public InstancePartitionsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.InstancesResource.InstancePartitionsResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.InstancesResource.InstancePartitionsResource.OperationsResource

Methods

Create(CreateInstancePartitionRequest, string)

Creates an instance partition and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance partition. The instance partition name is assigned by the caller. If the named instance partition already exists, CreateInstancePartition returns ALREADY_EXISTS. Immediately upon completion of this request: * The instance partition 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 partition immediately unreadable via the API. * The instance partition can be deleted. * All other attempts to modify the instance partition 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 start using this instance partition. * The instance partition's allocated resource levels are readable via the API. * The instance partition's state becomes READY. The returned long-running operation will have a name of the format /operations/ and can be used to track creation of the instance partition. The metadata field type is CreateInstancePartitionMetadata. The response field type is InstancePartition, if successful.

Declaration

public virtual ProjectsResource.InstancesResource.InstancePartitionsResource.CreateRequest Create(CreateInstancePartitionRequest body, string parent)

Parameters

Type	Name	Description
CreateInstancePartitionRequest	body	The body of the request.
string	parent	Required. The name of the instance in which to create the instance partition. Values are of the form projects//instances/.

Returns

Type	Description
ProjectsResource.InstancesResource.InstancePartitionsResource.CreateRequest

Delete(string)

Deletes an existing instance partition. Requires that the instance partition is not used by any database or backup and is not the default instance partition of an instance. Authorization requires spanner.instancePartitions.delete permission on the resource name.

Declaration

public virtual ProjectsResource.InstancesResource.InstancePartitionsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the instance partition to be deleted. Values are of the form projects/{project}/instances/{instance}/instancePartitions/{instance_partition}

Returns

Type	Description
ProjectsResource.InstancesResource.InstancePartitionsResource.DeleteRequest

Get(string)

Gets information about a particular instance partition.

Declaration

public virtual ProjectsResource.InstancesResource.InstancePartitionsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the requested instance partition. Values are of the form projects/{project}/instances/{instance}/instancePartitions/{instance_partition}.

Returns

Type	Description
ProjectsResource.InstancesResource.InstancePartitionsResource.GetRequest

List(string)

Lists all instance partitions for the given instance.

Declaration

public virtual ProjectsResource.InstancesResource.InstancePartitionsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The instance whose instance partitions should be listed. Values are of the form projects//instances/. Use {instance} = '-' to list instance partitions for all Instances in a project, e.g., projects/myproject/instances/-.

Returns

Type	Description
ProjectsResource.InstancesResource.InstancePartitionsResource.ListRequest

Patch(UpdateInstancePartitionRequest, string)

Updates an instance partition, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance partition. If the named instance partition does not exist, returns NOT_FOUND. Immediately upon completion of this request: * For resource types for which a decrease in the instance partition'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, 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 partition are rejected. * Reading the instance partition 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 partition's tables. * The instance partition's new resource levels are readable via the API. The returned long-running operation will have a name of the format /operations/ and can be used to track the instance partition modification. The metadata field type is UpdateInstancePartitionMetadata. The response field type is InstancePartition, if successful. Authorization requires spanner.instancePartitions.update permission on the resource name.

Declaration

public virtual ProjectsResource.InstancesResource.InstancePartitionsResource.PatchRequest Patch(UpdateInstancePartitionRequest body, string name)

Parameters

Type	Name	Description
UpdateInstancePartitionRequest	body	The body of the request.
string	name	Required. A unique identifier for the instance partition. Values are of the form projects//instances//instancePartitions/a-z*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created.

Returns

Type	Description
ProjectsResource.InstancesResource.InstancePartitionsResource.PatchRequest