publicfinalclassInstancePartitionextendsGeneratedMessageV3implementsInstancePartitionOrBuilder
An isolated set of Cloud Spanner resources that databases can define placements on.
Protobuf type google.spanner.admin.instance.v1.InstancePartition
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONFIG_FIELD_NUMBER
publicstaticfinalintCONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
publicstaticfinalintCREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
publicstaticfinalintDISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
publicstaticfinalintETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NODE_COUNT_FIELD_NUMBER
publicstaticfinalintNODE_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROCESSING_UNITS_FIELD_NUMBER
publicstaticfinalintPROCESSING_UNITS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REFERENCING_BACKUPS_FIELD_NUMBER
publicstaticfinalintREFERENCING_BACKUPS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REFERENCING_DATABASES_FIELD_NUMBER
publicstaticfinalintREFERENCING_DATABASES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
publicstaticfinalintSTATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
publicstaticfinalintUPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
publicstaticInstancePartitiongetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticInstancePartition.BuildernewBuilder()
newBuilder(InstancePartition prototype)
publicstaticInstancePartition.BuildernewBuilder(InstancePartitionprototype)
publicstaticInstancePartitionparseDelimitedFrom(InputStreaminput)
publicstaticInstancePartitionparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticInstancePartitionparseFrom(byte[]data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticInstancePartitionparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticInstancePartitionparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticInstancePartitionparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticInstancePartitionparseFrom(CodedInputStreaminput)
publicstaticInstancePartitionparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticInstancePartitionparseFrom(InputStreaminput)
publicstaticInstancePartitionparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticInstancePartitionparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticInstancePartitionparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<InstancePartition>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
OverridesgetComputeCapacityCase()
publicInstancePartition.ComputeCapacityCasegetComputeCapacityCase()
getConfig()
Required. The name of the instance partition's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also InstanceConfig and ListInstanceConfigs.
string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The config. |
getConfigBytes()
publicByteStringgetConfigBytes()
Required. The name of the instance partition's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also InstanceConfig and ListInstanceConfigs.
string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for config. |
getCreateTime()
publicTimestampgetCreateTime()
Output only. The time at which the instance partition was created.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime. |
getCreateTimeOrBuilder()
publicTimestampOrBuildergetCreateTimeOrBuilder()
Output only. The time at which the instance partition was created.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
publicInstancePartitiongetDefaultInstanceForType()
getDisplayName()
publicStringgetDisplayName()
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.
string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The displayName. |
getDisplayNameBytes()
publicByteStringgetDisplayNameBytes()
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.
string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName. |
getEtag()
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.
string etag = 12;
| Returns |
|---|
| Type | Description |
String | The etag. |
getEtagBytes()
publicByteStringgetEtagBytes()
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.
string etag = 12;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for etag. |
getName()
Required. A unique identifier for the instance partition. Values are of the form projects/<project>/instances/<instance>/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.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The name. |
getNameBytes()
publicByteStringgetNameBytes()
Required. A unique identifier for the instance partition. Values are of the form projects/<project>/instances/<instance>/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.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name. |
getNodeCount()
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.
int32 node_count = 5;
| Returns |
|---|
| Type | Description |
int | The nodeCount. |
getParserForType()
publicParser<InstancePartition>getParserForType()
getProcessingUnits()
publicintgetProcessingUnits()
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 might be zero in API responses for instance partitions that are not yet in the READY state.
int32 processing_units = 6;
| Returns |
|---|
| Type | Description |
int | The processingUnits. |
getReferencingBackups(int index) (deprecated)
publicStringgetReferencingBackups(intindex)
Deprecated.google.spanner.admin.instance.v1.InstancePartition.referencing_backups is deprecated. See google/spanner/admin/instance/v1/spanner_instance_admin.proto;l=1781
Output only. Deprecated: This field is not populated. 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.
repeated string referencing_backups = 11 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return. |
| Returns |
|---|
| Type | Description |
String | The referencingBackups at the given index. |
getReferencingBackupsBytes(int index) (deprecated)
publicByteStringgetReferencingBackupsBytes(intindex)
Deprecated.google.spanner.admin.instance.v1.InstancePartition.referencing_backups is deprecated. See google/spanner/admin/instance/v1/spanner_instance_admin.proto;l=1781
Output only. Deprecated: This field is not populated. 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.
repeated string referencing_backups = 11 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return. |
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the referencingBackups at the given index. |
getReferencingBackupsCount() (deprecated)
publicintgetReferencingBackupsCount()
Deprecated.google.spanner.admin.instance.v1.InstancePartition.referencing_backups is deprecated. See google/spanner/admin/instance/v1/spanner_instance_admin.proto;l=1781
Output only. Deprecated: This field is not populated. 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.
repeated string referencing_backups = 11 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The count of referencingBackups. |
getReferencingBackupsList() (deprecated)
publicProtocolStringListgetReferencingBackupsList()
Deprecated.google.spanner.admin.instance.v1.InstancePartition.referencing_backups is deprecated. See google/spanner/admin/instance/v1/spanner_instance_admin.proto;l=1781
Output only. Deprecated: This field is not populated. 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.
repeated string referencing_backups = 11 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
getReferencingDatabases(int index)
publicStringgetReferencingDatabases(intindex)
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.
repeated string referencing_databases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return. |
| Returns |
|---|
| Type | Description |
String | The referencingDatabases at the given index. |
getReferencingDatabasesBytes(int index)
publicByteStringgetReferencingDatabasesBytes(intindex)
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.
repeated string referencing_databases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return. |
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the referencingDatabases at the given index. |
getReferencingDatabasesCount()
publicintgetReferencingDatabasesCount()
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.
repeated string referencing_databases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The count of referencingDatabases. |
getReferencingDatabasesList()
publicProtocolStringListgetReferencingDatabasesList()
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.
repeated string referencing_databases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSerializedSize()
publicintgetSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
OverridesgetState()
publicInstancePartition.StategetState()
Output only. The current instance partition state.
.google.spanner.admin.instance.v1.InstancePartition.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
Output only. The current instance partition state.
.google.spanner.admin.instance.v1.InstancePartition.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state. |
getUpdateTime()
publicTimestampgetUpdateTime()
Output only. The time at which the instance partition was most recently updated.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime. |
getUpdateTimeOrBuilder()
publicTimestampOrBuildergetUpdateTimeOrBuilder()
Output only. The time at which the instance partition was most recently updated.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
publicbooleanhasCreateTime()
Output only. The time at which the instance partition was created.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set. |
hasNodeCount()
publicbooleanhasNodeCount()
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.
int32 node_count = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the nodeCount field is set. |
hasProcessingUnits()
publicbooleanhasProcessingUnits()
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 might be zero in API responses for instance partitions that are not yet in the READY state.
int32 processing_units = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the processingUnits field is set. |
hasUpdateTime()
publicbooleanhasUpdateTime()
Output only. The time at which the instance partition was most recently updated.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set. |
hashCode()
| Returns |
|---|
| Type | Description |
int | |
OverridesinternalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
isInitialized()
publicfinalbooleanisInitialized()
newBuilderForType()
publicInstancePartition.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedInstancePartition.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
toBuilder()
publicInstancePartition.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
