Package com.google.spanner.admin.instance.v1

Interface InstancePartitionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
InstancePartition, InstancePartition.Builder
public interface InstancePartitionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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]*[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:
      The name.

    • getNameBytes

      com.google.protobuf.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]*[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:
      The bytes for name.

    • getConfig

      String getConfig()
       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].
      string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The config.

    • getConfigBytes

      com.google.protobuf.ByteString getConfigBytes()
       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].
      string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for config.

    • getDisplayName

      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:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.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:
      The bytes for displayName.

    • hasNodeCount

      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:
      Whether the nodeCount field is set.

    • getNodeCount

      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:
      The nodeCount.

    • hasProcessingUnits

      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 might be zero in API responses for instance partitions that are not
 yet in the `READY` state.
      int32 processing_units = 6;
      Returns:
      Whether the processingUnits field is set.

    • getProcessingUnits

      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 might be zero in API responses for instance partitions that are not
 yet in the `READY` state.
      int32 processing_units = 6;
      Returns:
      The processingUnits.

    • getStateValue

      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:
      The enum numeric value on the wire for state.

    • getState

      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:
      The state.

    • hasCreateTime

      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:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.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:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.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];

    • hasUpdateTime

      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:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.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:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.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];

    • getReferencingDatabasesList

      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:
      A list containing the referencingDatabases.

    • getReferencingDatabasesCount

      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:
      The count of referencingDatabases.

    • getReferencingDatabases

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The referencingDatabases at the given index.

    • getReferencingDatabasesBytes

      com.google.protobuf.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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the referencingDatabases at the given index.

    • getReferencingBackupsList

      @Deprecated List<String> getReferencingBackupsList()
      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:
      A list containing the referencingBackups.

    • getReferencingBackupsCount

      @Deprecated int getReferencingBackupsCount()
      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:
      The count of referencingBackups.

    • getReferencingBackups

      @Deprecated String getReferencingBackups(int index)
      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The referencingBackups at the given index.

    • getReferencingBackupsBytes

      @Deprecated com.google.protobuf.ByteString getReferencingBackupsBytes(int index)
      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the referencingBackups at the given index.

    • getEtag

      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:
      The etag.

    • getEtagBytes

      com.google.protobuf.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:
      The bytes for etag.

    • getComputeCapacityCase

      InstancePartition.ComputeCapacityCase getComputeCapacityCase()