Interface InstanceConfigOrBuilder (6.83.0) 

public interface InstanceConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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{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;

Parameter
Name Description
key String
Returns
Type Description
boolean

getBaseConfig()

public abstract 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
Type Description
String

The baseConfig.

getBaseConfigBytes()

public abstract 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
Type Description
ByteString

The bytes for baseConfig.

getConfigType()

public abstract InstanceConfig.Type getConfigType()

Output only. Whether this instance configuration is a Google-managed or user-managed configuration.

.google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InstanceConfig.Type

The configType.

getConfigTypeValue()

public abstract int getConfigTypeValue()

Output only. Whether this instance configuration is a Google-managed or user-managed configuration.

.google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for configType.

getDisplayName()

public abstract String getDisplayName()

The name of this instance configuration as it appears in UIs.

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The name of this instance configuration as it appears in UIs.

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public abstract String getEtag()

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

string etag = 9;

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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

string etag = 9;

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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{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;

Returns
Type Description
int

getLabelsMap()

public abstract 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{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;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract 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{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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract 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{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;

Parameter
Name Description
key String
Returns
Type Description
String

getLeaderOptions(int index)

public abstract 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;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The leaderOptions at the given index.

getLeaderOptionsBytes(int index)

public abstract 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;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the leaderOptions at the given index.

getLeaderOptionsCount()

public abstract 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
Type Description
int

The count of leaderOptions.

getLeaderOptionsList()

public abstract 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
Type Description
List<String>

A list containing the leaderOptions.

getName()

public abstract String getName()

A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/a-z*.

User instance configuration must start with custom-.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/a-z*.

User instance configuration must start with custom-.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOptionalReplicas(int index)

public abstract 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];

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfo

getOptionalReplicasCount()

public abstract 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];

Returns
Type Description
int

getOptionalReplicasList()

public abstract 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];

Returns
Type Description
List<ReplicaInfo>

getOptionalReplicasOrBuilder(int index)

public abstract 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];

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfoOrBuilder

getOptionalReplicasOrBuilderList()

public abstract 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];

Returns
Type Description
List<? extends com.google.spanner.admin.instance.v1.ReplicaInfoOrBuilder>

getReconciling()

public abstract boolean getReconciling()

Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration.

bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The reconciling.

getReplicas(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfo

getReplicasCount()

public abstract int getReplicasCount()

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Returns
Type Description
int

getReplicasList()

public abstract 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;

Returns
Type Description
List<ReplicaInfo>

getReplicasOrBuilder(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfoOrBuilder

getReplicasOrBuilderList()

public abstract 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;

Returns
Type Description
List<? extends com.google.spanner.admin.instance.v1.ReplicaInfoOrBuilder>

getState()

public abstract InstanceConfig.State getState()

Output only. The current instance configuration state. Applicable only for USER_MANAGED configurations.

.google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InstanceConfig.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The current instance configuration state. Applicable only for USER_MANAGED configurations.

.google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.