Interface InstanceOrBuilder (6.83.0)

public interface InstanceOrBuilder 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. 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;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getAutoscalingConfig()

public abstract 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
Type	Description
`AutoscalingConfig`	The autoscalingConfig.

getAutoscalingConfigOrBuilder()

public abstract AutoscalingConfigOrBuilder getAutoscalingConfigOrBuilder()

.google.spanner.admin.instance.v1.AutoscalingConfig autoscaling_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`AutoscalingConfigOrBuilder`

getConfig()

public abstract String getConfig()

Required. The name of the instance'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'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 was created.

.google.protobuf.Timestamp create_time = 11 [(.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 was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getDefaultBackupScheduleType()

public abstract Instance.DefaultBackupScheduleType getDefaultBackupScheduleType()

Optional. Controls the default backup behavior for new databases within the instance.

Note that AUTOMATIC is not permitted for free instances, as backups and backup schedules are not allowed for free instances.

In the GetInstance or ListInstances response, if the value of default_backup_schedule_type is unset or NONE, no default backup schedule will be created for new databases within the instance.

.google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType default_backup_schedule_type = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Instance.DefaultBackupScheduleType`	The defaultBackupScheduleType.

getDefaultBackupScheduleTypeValue()

public abstract int getDefaultBackupScheduleTypeValue()

Optional. Controls the default backup behavior for new databases within the instance.

Note that AUTOMATIC is not permitted for free instances, as backups and backup schedules are not allowed for free instances.

In the GetInstance or ListInstances response, if the value of default_backup_schedule_type is unset or NONE, no default backup schedule will be created for new databases within the instance.

.google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType default_backup_schedule_type = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for defaultBackupScheduleType.

getDisplayName()

public abstract 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
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for displayName.

getEdition()

public abstract 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
Type	Description
`Instance.Edition`	The edition.

getEditionValue()

public abstract int getEditionValue()

Optional. The Edition of the current instance.

.google.spanner.admin.instance.v1.Instance.Edition edition = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for edition.

getEndpointUris(int index)

public abstract String getEndpointUris(int index)

Deprecated. This field is not populated.

repeated string endpoint_uris = 8;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The endpointUris at the given index.

getEndpointUrisBytes(int index)

public abstract ByteString getEndpointUrisBytes(int index)

Deprecated. This field is not populated.

repeated string endpoint_uris = 8;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the endpointUris at the given index.

getEndpointUrisCount()

public abstract int getEndpointUrisCount()

Deprecated. This field is not populated.

repeated string endpoint_uris = 8;

Returns
Type	Description
`int`	The count of endpointUris.

getEndpointUrisList()

public abstract List<String> getEndpointUrisList()

Deprecated. This field is not populated.

repeated string endpoint_uris = 8;

Returns
Type	Description
`List<String>`	A list containing the endpointUris.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract int getLabelsCount()

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. 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;

Returns
Type	Description
`int`

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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. 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;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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. 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;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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. 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;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getName()

public abstract 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]. The final segment of the name must be between 2 and 64 characters in length.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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. 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.

If the instance has varying node count across replicas (achieved by setting asymmetric_autoscaling_options in autoscaling config), the node_count here is the maximum node count across all replicas.

For more information, see Compute capacity, nodes, and processing units.

int32 node_count = 5;

Returns
Type	Description
`int`	The nodeCount.

getProcessingUnits()

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

If the instance has varying processing units per replica (achieved by setting asymmetric_autoscaling_options in autoscaling config), the processing_units here is the maximum processing units across all replicas.

For more information, see Compute capacity, nodes and processing units.

int32 processing_units = 9;

Returns
Type	Description
`int`	The processingUnits.

getReplicaComputeCapacity(int index)

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