Google Cloud Spanner Instance Administration v1 API - Class InstancePartition (5.0.0-beta04)

public sealed class InstancePartition : IMessage<InstancePartition>, IEquatable<InstancePartition>, IDeepCloneable<InstancePartition>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Spanner Instance Administration v1 API class InstancePartition.

An isolated set of Cloud Spanner resources that databases can define placements on.

Inheritance

object > InstancePartition

Namespace

Google.Cloud.Spanner.Admin.Instance.V1

Assembly

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

Constructors

InstancePartition()

public InstancePartition()

InstancePartition(InstancePartition)

public InstancePartition(InstancePartition other)
Parameter
Name Description
other InstancePartition

Properties

ComputeCapacityCase

public InstancePartition.ComputeCapacityOneofCase ComputeCapacityCase { get; }
Property Value
Type Description
InstancePartitionComputeCapacityOneofCase

Config

public string Config { get; set; }

Required. The name of the instance partition's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].

Property Value
Type Description
string

ConfigAsInstanceConfigName

public InstanceConfigName ConfigAsInstanceConfigName { get; set; }

InstanceConfigName-typed view over the Config resource name property.

Property Value
Type Description
InstanceConfigName

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time at which the instance partition was created.

Property Value
Type Description
Timestamp

DisplayName

public string DisplayName { get; set; }

Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

Property Value
Type Description
string

Etag

public string Etag { get; set; }

Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly.

Property Value
Type Description
string

HasNodeCount

public bool HasNodeCount { get; }

Gets whether the "node_count" field is set

Property Value
Type Description
bool

HasProcessingUnits

public bool HasProcessingUnits { get; }

Gets whether the "processing_units" field is set

Property Value
Type Description
bool

InstancePartitionName

public InstancePartitionName InstancePartitionName { get; set; }

InstancePartitionName-typed view over the Name resource name property.

Property Value
Type Description
InstancePartitionName

Name

public string Name { get; set; }

Required. A unique identifier for the instance partition. Values are of the form projects/<project>/instances/<instance>/instancePartitions/[a-z][-a-z0-9]*[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.

Property Value
Type Description
string

NodeCount

public int NodeCount { get; set; }

The number of nodes allocated to this instance partition.

Users can set the node_count field to specify the target number of nodes allocated to the instance partition.

This may be zero in API responses for instance partitions that are not yet in state READY.

Property Value
Type Description
int

ProcessingUnits

public int ProcessingUnits { get; set; }

The number of processing units allocated to this instance partition.

Users can set the processing_units field to specify the target number of processing units allocated to the instance partition.

This may be zero in API responses for instance partitions that are not yet in state READY.

Property Value
Type Description
int

ReferencingBackups

public RepeatedField<string> ReferencingBackups { get; }

Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted.

Property Value
Type Description
RepeatedFieldstring

ReferencingDatabases

public RepeatedField<string> ReferencingDatabases { get; }

Output only. The names of the databases that reference this instance partition. Referencing databases should share the parent instance. The existence of any referencing database prevents the instance partition from being deleted.

Property Value
Type Description
RepeatedFieldstring

State

public InstancePartition.Types.State State { get; set; }

Output only. The current instance partition state.

Property Value
Type Description
InstancePartitionTypesState

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The time at which the instance partition was most recently updated.

Property Value
Type Description
Timestamp