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

Interface InstanceOrBuilder

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

  • Method Details

    • getName

      String getName()
       Required. A unique identifier for the instance, which cannot be changed
 after the instance is created. Values are of the form
 `projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final
 segment of the name must be between 2 and 64 characters in length.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. A unique identifier for the instance, which cannot be changed
 after the instance is created. Values are of the form
 `projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final
 segment of the name must be between 2 and 64 characters in length.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for name.

    • getConfig

      String getConfig()
       Required. The name of the instance'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'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 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 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.

    • getNodeCount

      int getNodeCount()
       The number of nodes allocated to this instance. At most, one of either
 `node_count` or `processing_units` should be present in the message.

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

 If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY`
 field and reflects the current number of nodes allocated to the instance.

 This might be zero in API responses for instances that are not yet in the
 `READY` state.


 For more information, see
 [Compute capacity, nodes, and processing
 units](https://cloud.google.com/spanner/docs/compute-capacity).
      int32 node_count = 5;
      Returns:
      The nodeCount.

    • getProcessingUnits

      int getProcessingUnits()
       The number of processing units allocated to this instance. At most, one of
 either `processing_units` or `node_count` should be present in the message.

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

 If autoscaling is enabled, `processing_units` is treated as an
 `OUTPUT_ONLY` field and reflects the current number of processing units
 allocated to the instance.

 This might be zero in API responses for instances that are not yet in the
 `READY` state.


 For more information, see
 [Compute capacity, nodes and processing
 units](https://cloud.google.com/spanner/docs/compute-capacity).
      int32 processing_units = 9;
      Returns:
      The processingUnits.

    • getReplicaComputeCapacityList

      List<ReplicaComputeCapacity> getReplicaComputeCapacityList()
       Output only. Lists the compute capacity per ReplicaSelection. A replica
 selection identifies a set of replicas with common properties. Replicas
 identified by a ReplicaSelection are scaled with the same compute capacity.
      repeated .google.spanner.admin.instance.v1.ReplicaComputeCapacity replica_compute_capacity = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getReplicaComputeCapacity

      ReplicaComputeCapacity getReplicaComputeCapacity(int index)
       Output only. Lists the compute capacity per ReplicaSelection. A replica
 selection identifies a set of replicas with common properties. Replicas
 identified by a ReplicaSelection are scaled with the same compute capacity.
      repeated .google.spanner.admin.instance.v1.ReplicaComputeCapacity replica_compute_capacity = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getReplicaComputeCapacityCount

      int getReplicaComputeCapacityCount()
       Output only. Lists the compute capacity per ReplicaSelection. A replica
 selection identifies a set of replicas with common properties. Replicas
 identified by a ReplicaSelection are scaled with the same compute capacity.
      repeated .google.spanner.admin.instance.v1.ReplicaComputeCapacity replica_compute_capacity = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getReplicaComputeCapacityOrBuilderList

      List<? extends ReplicaComputeCapacityOrBuilder> getReplicaComputeCapacityOrBuilderList()
       Output only. Lists the compute capacity per ReplicaSelection. A replica
 selection identifies a set of replicas with common properties. Replicas
 identified by a ReplicaSelection are scaled with the same compute capacity.
      repeated .google.spanner.admin.instance.v1.ReplicaComputeCapacity replica_compute_capacity = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getReplicaComputeCapacityOrBuilder

      ReplicaComputeCapacityOrBuilder getReplicaComputeCapacityOrBuilder(int index)
       Output only. Lists the compute capacity per ReplicaSelection. A replica
 selection identifies a set of replicas with common properties. Replicas
 identified by a ReplicaSelection are scaled with the same compute capacity.
      repeated .google.spanner.admin.instance.v1.ReplicaComputeCapacity replica_compute_capacity = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasAutoscalingConfig

      boolean hasAutoscalingConfig()
       Optional. The autoscaling configuration. Autoscaling is enabled if this
 field is set. When autoscaling is enabled, node_count and processing_units
 are treated as OUTPUT_ONLY fields and reflect the current compute capacity
 allocated to the instance.
      .google.spanner.admin.instance.v1.AutoscalingConfig autoscaling_config = 17 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the autoscalingConfig field is set.

    • getAutoscalingConfig

      AutoscalingConfig getAutoscalingConfig()
       Optional. The autoscaling configuration. Autoscaling is enabled if this
 field is set. When autoscaling is enabled, node_count and processing_units
 are treated as OUTPUT_ONLY fields and reflect the current compute capacity
 allocated to the instance.
      .google.spanner.admin.instance.v1.AutoscalingConfig autoscaling_config = 17 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The autoscalingConfig.

    • getAutoscalingConfigOrBuilder

      AutoscalingConfigOrBuilder getAutoscalingConfigOrBuilder()
       Optional. The autoscaling configuration. Autoscaling is enabled if this
 field is set. When autoscaling is enabled, node_count and processing_units
 are treated as OUTPUT_ONLY fields and reflect the current compute capacity
 allocated to the instance.
      .google.spanner.admin.instance.v1.AutoscalingConfig autoscaling_config = 17 [(.google.api.field_behavior) = OPTIONAL];

    • getStateValue

      int getStateValue()
       Output only. The current instance state. For
 [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance],
 the state must be either omitted or set to `CREATING`. For
 [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance],
 the state must be either omitted or set to `READY`.
      .google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Instance.State getState()
       Output only. The current instance state. For
 [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance],
 the state must be either omitted or set to `CREATING`. For
 [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance],
 the state must be either omitted or set to `READY`.
      .google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • getLabelsCount

      int getLabelsCount()
       Cloud Labels are a flexible and lightweight mechanism for organizing cloud
 resources into groups that reflect a customer's organizational needs and
 deployment strategies. Cloud Labels can be used to filter collections of
 resources. They can be used to control how resource metrics are aggregated.
 And they can be used as arguments to policy management rules (e.g. route,
 firewall, load balancing, etc.).

  * Label keys must be between 1 and 63 characters long and must conform to
    the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
  * Label values must be between 0 and 63 characters long and must conform
    to the regular expression `[a-z0-9_-]{0,63}`.
  * No more than 64 labels can be associated with a given resource.

 See https://goo.gl/xmQnxf for more information on and examples of labels.

 If you plan to use labels in your own code, please note that additional
 characters may be allowed in the future. And so you are advised to use an
 internal label representation, such as JSON, which doesn't rely upon
 specific characters being disallowed.  For example, representing labels
 as the string:  name + "_" + value  would prove problematic if we were to
 allow "_" in a future release.
      map<string, string> labels = 7;

    • containsLabels

      boolean containsLabels(String key)
       Cloud Labels are a flexible and lightweight mechanism for organizing cloud
 resources into groups that reflect a customer's organizational needs and
 deployment strategies. Cloud Labels can be used to filter collections of
 resources. They can be used to control how resource metrics are aggregated.
 And they can be used as arguments to policy management rules (e.g. route,
 firewall, load balancing, etc.).

  * Label keys must be between 1 and 63 characters long and must conform to
    the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
  * Label values must be between 0 and 63 characters long and must conform
    to the regular expression `[a-z0-9_-]{0,63}`.
  * No more than 64 labels can be associated with a given resource.

 See https://goo.gl/xmQnxf for more information on and examples of labels.

 If you plan to use labels in your own code, please note that additional
 characters may be allowed in the future. And so you are advised to use an
 internal label representation, such as JSON, which doesn't rely upon
 specific characters being disallowed.  For example, representing labels
 as the string:  name + "_" + value  would prove problematic if we were to
 allow "_" in a future release.
      map<string, string> labels = 7;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Cloud Labels are a flexible and lightweight mechanism for organizing cloud
 resources into groups that reflect a customer's organizational needs and
 deployment strategies. Cloud Labels can be used to filter collections of
 resources. They can be used to control how resource metrics are aggregated.
 And they can be used as arguments to policy management rules (e.g. route,
 firewall, load balancing, etc.).

  * Label keys must be between 1 and 63 characters long and must conform to
    the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
  * Label values must be between 0 and 63 characters long and must conform
    to the regular expression `[a-z0-9_-]{0,63}`.
  * No more than 64 labels can be associated with a given resource.

 See https://goo.gl/xmQnxf for more information on and examples of labels.

 If you plan to use labels in your own code, please note that additional
 characters may be allowed in the future. And so you are advised to use an
 internal label representation, such as JSON, which doesn't rely upon
 specific characters being disallowed.  For example, representing labels
 as the string:  name + "_" + value  would prove problematic if we were to
 allow "_" in a future release.
      map<string, string> labels = 7;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Cloud Labels are a flexible and lightweight mechanism for organizing cloud
 resources into groups that reflect a customer's organizational needs and
 deployment strategies. Cloud Labels can be used to filter collections of
 resources. They can be used to control how resource metrics are aggregated.
 And they can be used as arguments to policy management rules (e.g. route,
 firewall, load balancing, etc.).

  * Label keys must be between 1 and 63 characters long and must conform to
    the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
  * Label values must be between 0 and 63 characters long and must conform
    to the regular expression `[a-z0-9_-]{0,63}`.
  * No more than 64 labels can be associated with a given resource.

 See https://goo.gl/xmQnxf for more information on and examples of labels.

 If you plan to use labels in your own code, please note that additional
 characters may be allowed in the future. And so you are advised to use an
 internal label representation, such as JSON, which doesn't rely upon
 specific characters being disallowed.  For example, representing labels
 as the string:  name + "_" + value  would prove problematic if we were to
 allow "_" in a future release.
      map<string, string> labels = 7;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Cloud Labels are a flexible and lightweight mechanism for organizing cloud
 resources into groups that reflect a customer's organizational needs and
 deployment strategies. Cloud Labels can be used to filter collections of
 resources. They can be used to control how resource metrics are aggregated.
 And they can be used as arguments to policy management rules (e.g. route,
 firewall, load balancing, etc.).

  * Label keys must be between 1 and 63 characters long and must conform to
    the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
  * Label values must be between 0 and 63 characters long and must conform
    to the regular expression `[a-z0-9_-]{0,63}`.
  * No more than 64 labels can be associated with a given resource.

 See https://goo.gl/xmQnxf for more information on and examples of labels.

 If you plan to use labels in your own code, please note that additional
 characters may be allowed in the future. And so you are advised to use an
 internal label representation, such as JSON, which doesn't rely upon
 specific characters being disallowed.  For example, representing labels
 as the string:  name + "_" + value  would prove problematic if we were to
 allow "_" in a future release.
      map<string, string> labels = 7;

    • getInstanceTypeValue

      int getInstanceTypeValue()
       The `InstanceType` of the current instance.
      .google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10;
      Returns:
      The enum numeric value on the wire for instanceType.

    • getInstanceType

      Instance.InstanceType getInstanceType()
       The `InstanceType` of the current instance.
      .google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10;
      Returns:
      The instanceType.

    • getEndpointUrisList

      List<String> getEndpointUrisList()
       Deprecated. This field is not populated.
      repeated string endpoint_uris = 8;
      Returns:
      A list containing the endpointUris.

    • getEndpointUrisCount

      int getEndpointUrisCount()
       Deprecated. This field is not populated.
      repeated string endpoint_uris = 8;
      Returns:
      The count of endpointUris.

    • getEndpointUris

      String getEndpointUris(int index)
       Deprecated. This field is not populated.
      repeated string endpoint_uris = 8;
      Parameters:
      index - The index of the element to return.
      Returns:
      The endpointUris at the given index.

    • getEndpointUrisBytes

      com.google.protobuf.ByteString getEndpointUrisBytes(int index)
       Deprecated. This field is not populated.
      repeated string endpoint_uris = 8;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the endpointUris at the given index.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time at which the instance was created.
      .google.protobuf.Timestamp create_time = 11 [(.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 was created.
      .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time at which the instance was created.
      .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The time at which the instance was most recently updated.
      .google.protobuf.Timestamp update_time = 12 [(.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 was most recently updated.
      .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time at which the instance was most recently updated.
      .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasFreeInstanceMetadata

      boolean hasFreeInstanceMetadata()
       Free instance metadata. Only populated for free instances.
      .google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;
      Returns:
      Whether the freeInstanceMetadata field is set.

    • getFreeInstanceMetadata

      FreeInstanceMetadata getFreeInstanceMetadata()
       Free instance metadata. Only populated for free instances.
      .google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;
      Returns:
      The freeInstanceMetadata.

    • getFreeInstanceMetadataOrBuilder

      FreeInstanceMetadataOrBuilder getFreeInstanceMetadataOrBuilder()
       Free instance metadata. Only populated for free instances.
      .google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;

    • getEditionValue

      int getEditionValue()
       Optional. The `Edition` of the current instance.
      .google.spanner.admin.instance.v1.Instance.Edition edition = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for edition.

    • getEdition

      Instance.Edition getEdition()
       Optional. The `Edition` of the current instance.
      .google.spanner.admin.instance.v1.Instance.Edition edition = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The edition.

    • getDefaultBackupScheduleTypeValue

      int getDefaultBackupScheduleTypeValue()
       Optional. Controls the default backup schedule behavior for new databases
 within the instance. By default, a backup schedule is created automatically
 when a new database is created in a new instance.

 Note that the `AUTOMATIC` value isn't permitted for free instances,
 as backups and backup schedules aren't supported for free instances.

 In the `GetInstance` or `ListInstances` response, if the value of
 `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't
 create a default backup schedule for new databases in the instance.
      .google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType default_backup_schedule_type = 23 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for defaultBackupScheduleType.

    • getDefaultBackupScheduleType

      Instance.DefaultBackupScheduleType getDefaultBackupScheduleType()
       Optional. Controls the default backup schedule behavior for new databases
 within the instance. By default, a backup schedule is created automatically
 when a new database is created in a new instance.

 Note that the `AUTOMATIC` value isn't permitted for free instances,
 as backups and backup schedules aren't supported for free instances.

 In the `GetInstance` or `ListInstances` response, if the value of
 `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't
 create a default backup schedule for new databases in the instance.
      .google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType default_backup_schedule_type = 23 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The defaultBackupScheduleType.