public interface InstancePartitionOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getComputeCapacityCase()
public abstract InstancePartition.ComputeCapacityCase getComputeCapacityCase()| Returns | |
|---|---|
| Type | Description |
InstancePartition.ComputeCapacityCase |
|
getConfig()
public abstract String 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()
public abstract ByteString getConfigBytes() 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()
public abstract Timestamp getCreateTime()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()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()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 |
TimestampOrBuilder |
|
getDisplayName()
public abstract String getDisplayName()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()
public abstract ByteString getDisplayNameBytes()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()
public abstract String 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()
public abstract ByteString getEtagBytes()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()
public abstract String 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()
public abstract ByteString getNameBytes() 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()
public abstract int 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. |
getProcessingUnits()
public abstract int getProcessingUnits()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.
int32 processing_units = 6;
| Returns | |
|---|---|
| Type | Description |
int |
The processingUnits. |
getReferencingBackups(int index)
public abstract String getReferencingBackups(int index)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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The referencingBackups at the given index. |
getReferencingBackupsBytes(int index)
public abstract ByteString getReferencingBackupsBytes(int index)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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the referencingBackups at the given index. |
getReferencingBackupsCount()
public abstract int getReferencingBackupsCount()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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The count of referencingBackups. |
getReferencingBackupsList()
public abstract List<String> getReferencingBackupsList()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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the referencingBackups. |
getReferencingDatabases(int index)
public abstract String getReferencingDatabases(int index)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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The referencingDatabases at the given index. |
getReferencingDatabasesBytes(int index)
public abstract ByteString getReferencingDatabasesBytes(int index)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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the referencingDatabases at the given index. |
getReferencingDatabasesCount()
public abstract int getReferencingDatabasesCount()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()
public abstract List<String> getReferencingDatabasesList()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 |
List<String> |
A list containing the referencingDatabases. |
getState()
public abstract InstancePartition.State getState()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 |
InstancePartition.State |
The state. |
getStateValue()
public abstract int 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()
public abstract Timestamp getUpdateTime()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()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()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 |
TimestampOrBuilder |
|
hasCreateTime()
public abstract boolean hasCreateTime()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()
public abstract boolean hasNodeCount()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()
public abstract boolean hasProcessingUnits()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.
int32 processing_units = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the processingUnits field is set. |
hasUpdateTime()
public abstract boolean hasUpdateTime()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. |