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

Interface InstanceConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    InstanceConfig, InstanceConfig.Builder
    public interface InstanceConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         A unique identifier for the instance configuration.  Values
 are of the form
 `projects/<project>/instanceConfigs/[a-z][-a-z0-9]*`.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         A unique identifier for the instance configuration.  Values
 are of the form
 `projects/<project>/instanceConfigs/[a-z][-a-z0-9]*`.
        string name = 1;
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         The name of this instance configuration as it appears in UIs.
        string display_name = 2;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         The name of this instance configuration as it appears in UIs.
        string display_name = 2;
        Returns:
        The bytes for displayName.

      • getConfigTypeValue

        int getConfigTypeValue()
         Output only. Whether this instance config is a Google or User Managed
 Configuration.
        .google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for configType.

      • getConfigType

        InstanceConfig.Type getConfigType()
         Output only. Whether this instance config is a Google or User Managed
 Configuration.
        .google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The configType.

      • getReplicasList

        List<ReplicaInfo> getReplicasList()
         The geographic placement of nodes in this instance configuration and their
 replication properties.
        repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

      • getReplicas

        ReplicaInfo getReplicas​(int index)
         The geographic placement of nodes in this instance configuration and their
 replication properties.
        repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

      • getReplicasCount

        int getReplicasCount()
         The geographic placement of nodes in this instance configuration and their
 replication properties.
        repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

      • getReplicasOrBuilderList

        List<? extends ReplicaInfoOrBuilder> getReplicasOrBuilderList()
         The geographic placement of nodes in this instance configuration and their
 replication properties.
        repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

      • getReplicasOrBuilder

        ReplicaInfoOrBuilder getReplicasOrBuilder​(int index)
         The geographic placement of nodes in this instance configuration and their
 replication properties.
        repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

      • getOptionalReplicasList

        List<ReplicaInfo> getOptionalReplicasList()
         Output only. The available optional replicas to choose from for user
 managed configurations. Populated for Google managed configurations.
        repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getOptionalReplicas

        ReplicaInfo getOptionalReplicas​(int index)
         Output only. The available optional replicas to choose from for user
 managed configurations. Populated for Google managed configurations.
        repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getOptionalReplicasCount

        int getOptionalReplicasCount()
         Output only. The available optional replicas to choose from for user
 managed configurations. Populated for Google managed configurations.
        repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getOptionalReplicasOrBuilderList

        List<? extends ReplicaInfoOrBuilder> getOptionalReplicasOrBuilderList()
         Output only. The available optional replicas to choose from for user
 managed configurations. Populated for Google managed configurations.
        repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getOptionalReplicasOrBuilder

        ReplicaInfoOrBuilder getOptionalReplicasOrBuilder​(int index)
         Output only. The available optional replicas to choose from for user
 managed configurations. Populated for Google managed configurations.
        repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getBaseConfig

        String getBaseConfig()
         Base configuration name, e.g. projects/<project_name>/instanceConfigs/nam3,
 based on which this configuration is created. Only set for user managed
 configurations. `base_config` must refer to a configuration of type
 GOOGLE_MANAGED in the same project as this configuration.
        string base_config = 7 [(.google.api.resource_reference) = { ... }
        Returns:
        The baseConfig.

      • getBaseConfigBytes

        com.google.protobuf.ByteString getBaseConfigBytes()
         Base configuration name, e.g. projects/<project_name>/instanceConfigs/nam3,
 based on which this configuration is created. Only set for user managed
 configurations. `base_config` must refer to a configuration of type
 GOOGLE_MANAGED in the same project as this configuration.
        string base_config = 7 [(.google.api.resource_reference) = { ... }
        Returns:
        The bytes for baseConfig.

      • 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. Therefore, 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 = 8;

      • 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. Therefore, 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 = 8;

      • 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. Therefore, 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 = 8;

      • 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. Therefore, 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 = 8;

      • 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. Therefore, 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 = 8;

      • getEtag

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

      • getEtagBytes

        com.google.protobuf.ByteString getEtagBytes()
         etag is used for optimistic concurrency control as a way
 to help prevent simultaneous updates of a instance config from overwriting
 each other. It is strongly suggested that systems make use of the etag in
 the read-modify-write cycle to perform instance config updates in order to
 avoid race conditions: An etag is returned in the response which contains
 instance configs, and systems are expected to put that etag in the request
 to update instance config to ensure that their change will be applied to
 the same version of the instance config.
 If no etag is provided in the call to update instance config, then the
 existing instance config is overwritten blindly.
        string etag = 9;
        Returns:
        The bytes for etag.

      • getLeaderOptionsList

        List<String> getLeaderOptionsList()
         Allowed values of the "default_leader" schema option for databases in
 instances that use this instance configuration.
        repeated string leader_options = 4;
        Returns:
        A list containing the leaderOptions.

      • getLeaderOptionsCount

        int getLeaderOptionsCount()
         Allowed values of the "default_leader" schema option for databases in
 instances that use this instance configuration.
        repeated string leader_options = 4;
        Returns:
        The count of leaderOptions.

      • getLeaderOptions

        String getLeaderOptions​(int index)
         Allowed values of the "default_leader" schema option for databases in
 instances that use this instance configuration.
        repeated string leader_options = 4;
        Parameters:
        index - The index of the element to return.
        Returns:
        The leaderOptions at the given index.

      • getLeaderOptionsBytes

        com.google.protobuf.ByteString getLeaderOptionsBytes​(int index)
         Allowed values of the "default_leader" schema option for databases in
 instances that use this instance configuration.
        repeated string leader_options = 4;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the leaderOptions at the given index.

      • getReconciling

        boolean getReconciling()
         Output only. If true, the instance config is being created or updated. If
 false, there are no ongoing operations for the instance config.
        bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The reconciling.

      • getStateValue

        int getStateValue()
         Output only. The current instance config state.
        .google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for state.

      • getState

        InstanceConfig.State getState()
         Output only. The current instance config state.
        .google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.