public interface InstanceOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
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()
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 |
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()
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.