public static final class Instance.Builder extends GeneratedMessageV3.Builder<Instance.Builder> implements InstanceOrBuilderAn isolated set of Cloud Spanner resources on which databases can be hosted.
Protobuf type google.spanner.admin.instance.v1.Instance
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Instance.BuilderImplements
InstanceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllEndpointUris(Iterable<String> values)
public Instance.Builder addAllEndpointUris(Iterable<String> values)Deprecated. This field is not populated.
repeated string endpoint_uris = 8;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<String>The endpointUris to add. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
addAllReplicaComputeCapacity(Iterable<? extends ReplicaComputeCapacity> values)
public Instance.Builder addAllReplicaComputeCapacity(Iterable<? extends ReplicaComputeCapacity> values)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];
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.spanner.admin.instance.v1.ReplicaComputeCapacity> |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
addEndpointUris(String value)
public Instance.Builder addEndpointUris(String value)Deprecated. This field is not populated.
repeated string endpoint_uris = 8;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe endpointUris to add. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
addEndpointUrisBytes(ByteString value)
public Instance.Builder addEndpointUrisBytes(ByteString value)Deprecated. This field is not populated.
repeated string endpoint_uris = 8;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the endpointUris to add. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Instance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
addReplicaComputeCapacity(ReplicaComputeCapacity value)
public Instance.Builder addReplicaComputeCapacity(ReplicaComputeCapacity value)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];
| Parameter | |
|---|---|
| Name | Description |
value | ReplicaComputeCapacity |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
addReplicaComputeCapacity(ReplicaComputeCapacity.Builder builderForValue)
public Instance.Builder addReplicaComputeCapacity(ReplicaComputeCapacity.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ReplicaComputeCapacity.Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
addReplicaComputeCapacity(int index, ReplicaComputeCapacity value)
public Instance.Builder addReplicaComputeCapacity(int index, ReplicaComputeCapacity value)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];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | ReplicaComputeCapacity |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
addReplicaComputeCapacity(int index, ReplicaComputeCapacity.Builder builderForValue)
public Instance.Builder addReplicaComputeCapacity(int index, ReplicaComputeCapacity.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | ReplicaComputeCapacity.Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
addReplicaComputeCapacityBuilder()
public ReplicaComputeCapacity.Builder addReplicaComputeCapacityBuilder()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];
| Returns | |
|---|---|
| Type | Description |
ReplicaComputeCapacity.Builder | |
addReplicaComputeCapacityBuilder(int index)
public ReplicaComputeCapacity.Builder addReplicaComputeCapacityBuilder(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];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ReplicaComputeCapacity.Builder | |
build()
public Instance build()| Returns | |
|---|---|
| Type | Description |
Instance | |
buildPartial()
public Instance buildPartial()| Returns | |
|---|---|
| Type | Description |
Instance | |
clear()
public Instance.Builder clear()| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearAutoscalingConfig()
public Instance.Builder clearAutoscalingConfig()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 |
Instance.Builder | |
clearConfig()
public Instance.Builder clearConfig()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 |
Instance.Builder | This builder for chaining. |
clearCreateTime()
public Instance.Builder clearCreateTime()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 |
Instance.Builder | |
clearDefaultBackupScheduleType()
public Instance.Builder clearDefaultBackupScheduleType()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 | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearDisplayName()
public Instance.Builder clearDisplayName()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 |
Instance.Builder | This builder for chaining. |
clearEdition()
public Instance.Builder clearEdition()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.Builder | This builder for chaining. |
clearEndpointUris()
public Instance.Builder clearEndpointUris()Deprecated. This field is not populated.
repeated string endpoint_uris = 8;
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Instance.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearFreeInstanceMetadata()
public Instance.Builder clearFreeInstanceMetadata()Free instance metadata. Only populated for free instances.
.google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearInstanceType()
public Instance.Builder clearInstanceType()The InstanceType of the current instance.
.google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10;
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearLabels()
public Instance.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearName()
public Instance.Builder clearName()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 |
Instance.Builder | This builder for chaining. |
clearNodeCount()
public Instance.Builder clearNodeCount()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.
int32 node_count = 5;
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Instance.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearProcessingUnits()
public Instance.Builder clearProcessingUnits()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.
int32 processing_units = 9;
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearReplicaComputeCapacity()
public Instance.Builder clearReplicaComputeCapacity()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];
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearState()
public Instance.Builder clearState()Output only. The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For 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 | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearUpdateTime()
public Instance.Builder clearUpdateTime()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 | |
|---|---|
| Type | Description |
Instance.Builder | |
clone()
public Instance.Builder clone()| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
containsLabels(String key)
public 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 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. |
getAutoscalingConfigBuilder()
public AutoscalingConfig.Builder getAutoscalingConfigBuilder()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.Builder | |
getAutoscalingConfigOrBuilder()
public 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 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 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 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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()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 |
Builder | |
getCreateTimeOrBuilder()
public 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 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 | |
|---|---|
| Type | Description |
Instance.DefaultBackupScheduleType | The defaultBackupScheduleType. |
getDefaultBackupScheduleTypeValue()
public 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 | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for defaultBackupScheduleType. |
getDefaultInstanceForType()
public Instance getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Instance | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDisplayName()
public 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 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 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 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 String getEndpointUris(int index)Deprecated. This field is not populated.
repeated string endpoint_uris = 8;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The endpointUris at the given index. |
getEndpointUrisBytes(int index)
public ByteString getEndpointUrisBytes(int index)Deprecated. This field is not populated.
repeated string endpoint_uris = 8;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the endpointUris at the given index. |
getEndpointUrisCount()
public int getEndpointUrisCount()Deprecated. This field is not populated.
repeated string endpoint_uris = 8;
| Returns | |
|---|---|
| Type | Description |
int | The count of endpointUris. |
getEndpointUrisList()
public ProtocolStringList getEndpointUrisList()Deprecated. This field is not populated.
repeated string endpoint_uris = 8;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList | A list containing the endpointUris. |
getFreeInstanceMetadata()
public FreeInstanceMetadata getFreeInstanceMetadata()Free instance metadata. Only populated for free instances.
.google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;
| Returns | |
|---|---|
| Type | Description |
FreeInstanceMetadata | The freeInstanceMetadata. |
getFreeInstanceMetadataBuilder()
public FreeInstanceMetadata.Builder getFreeInstanceMetadataBuilder()Free instance metadata. Only populated for free instances.
.google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;
| Returns | |
|---|---|
| Type | Description |
FreeInstanceMetadata.Builder | |
getFreeInstanceMetadataOrBuilder()
public FreeInstanceMetadataOrBuilder getFreeInstanceMetadataOrBuilder()Free instance metadata. Only populated for free instances.
.google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;
| Returns | |
|---|---|
| Type | Description |
FreeInstanceMetadataOrBuilder | |
getInstanceType()
public Instance.InstanceType getInstanceType()The InstanceType of the current instance.
.google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10;
| Returns | |
|---|---|
| Type | Description |
Instance.InstanceType | The instanceType. |
getInstanceTypeValue()
public int getInstanceTypeValue()The InstanceType of the current instance.
.google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for instanceType. |
getLabels() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public 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.
map<string, string> labels = 7;
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public 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. 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 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. 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 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. 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 | |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getName()
public 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 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]. 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 |
ByteString | The bytes for name. |
getNodeCount()
public 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.
int32 node_count = 5;
| Returns | |
|---|---|
| Type | Description |
int | The nodeCount. |
getProcessingUnits()
public 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.
int32 processing_units = 9;
| Returns | |
|---|---|
| Type | Description |
int | The processingUnits. |
getReplicaComputeCapacity(int index)
public 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];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ReplicaComputeCapacity | |
getReplicaComputeCapacityBuilder(int index)
public ReplicaComputeCapacity.Builder getReplicaComputeCapacityBuilder(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];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ReplicaComputeCapacity.Builder | |
getReplicaComputeCapacityBuilderList()
public List<ReplicaComputeCapacity.Builder> getReplicaComputeCapacityBuilderList()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];
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getReplicaComputeCapacityCount()
public 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];
| Returns | |
|---|---|
| Type | Description |
int | |
getReplicaComputeCapacityList()
public 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];
| Returns | |
|---|---|
| Type | Description |
List<ReplicaComputeCapacity> | |
getReplicaComputeCapacityOrBuilder(int index)
public 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];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ReplicaComputeCapacityOrBuilder | |
getReplicaComputeCapacityOrBuilderList()
public 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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.spanner.admin.instance.v1.ReplicaComputeCapacityOrBuilder> | |
getState()
public Instance.State getState()Output only. The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For 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 | |
|---|---|
| Type | Description |
Instance.State | The state. |
getStateValue()
public int getStateValue()Output only. The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For 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 | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for state. |
getUpdateTime()
public 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 | |
|---|---|
| Type | Description |
Timestamp | The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()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 | |
|---|---|
| Type | Description |
Builder | |
getUpdateTimeOrBuilder()
public 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
hasAutoscalingConfig()
public 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 | |
|---|---|
| Type | Description |
boolean | Whether the autoscalingConfig field is set. |
hasCreateTime()
public 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 | |
|---|---|
| Type | Description |
boolean | Whether the createTime field is set. |
hasFreeInstanceMetadata()
public boolean hasFreeInstanceMetadata()Free instance metadata. Only populated for free instances.
.google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the freeInstanceMetadata field is set. |
hasUpdateTime()
public 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 | |
|---|---|
| Type | Description |
boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeAutoscalingConfig(AutoscalingConfig value)
public Instance.Builder mergeAutoscalingConfig(AutoscalingConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value | AutoscalingConfig |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeCreateTime(Timestamp value)
public Instance.Builder mergeCreateTime(Timestamp value)Output only. The time at which the instance was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeFreeInstanceMetadata(FreeInstanceMetadata value)
public Instance.Builder mergeFreeInstanceMetadata(FreeInstanceMetadata value)Free instance metadata. Only populated for free instances.
.google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;
| Parameter | |
|---|---|
| Name | Description |
value | FreeInstanceMetadata |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Instance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Instance.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeFrom(Instance other)
public Instance.Builder mergeFrom(Instance other)| Parameter | |
|---|---|
| Name | Description |
other | Instance |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Instance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeUpdateTime(Timestamp value)
public Instance.Builder mergeUpdateTime(Timestamp value)Output only. The time at which the instance was most recently updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
putAllLabels(Map<String,String> values)
public Instance.Builder putAllLabels(Map<String,String> values)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 |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
putLabels(String key, String value)
public Instance.Builder putLabels(String key, String value)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;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
removeLabels(String key)
public Instance.Builder removeLabels(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 |
Instance.Builder | |
removeReplicaComputeCapacity(int index)
public Instance.Builder removeReplicaComputeCapacity(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];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setAutoscalingConfig(AutoscalingConfig value)
public Instance.Builder setAutoscalingConfig(AutoscalingConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value | AutoscalingConfig |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setAutoscalingConfig(AutoscalingConfig.Builder builderForValue)
public Instance.Builder setAutoscalingConfig(AutoscalingConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | AutoscalingConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setConfig(String value)
public Instance.Builder setConfig(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe config to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setConfigBytes(ByteString value)
public Instance.Builder setConfigBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for config to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setCreateTime(Timestamp value)
public Instance.Builder setCreateTime(Timestamp value)Output only. The time at which the instance was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setCreateTime(Timestamp.Builder builderForValue)
public Instance.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The time at which the instance was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setDefaultBackupScheduleType(Instance.DefaultBackupScheduleType value)
public Instance.Builder setDefaultBackupScheduleType(Instance.DefaultBackupScheduleType value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Instance.DefaultBackupScheduleTypeThe defaultBackupScheduleType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setDefaultBackupScheduleTypeValue(int value)
public Instance.Builder setDefaultBackupScheduleTypeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for defaultBackupScheduleType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setDisplayName(String value)
public Instance.Builder setDisplayName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Instance.Builder setDisplayNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setEdition(Instance.Edition value)
public Instance.Builder setEdition(Instance.Edition value)Optional. The Edition of the current instance.
.google.spanner.admin.instance.v1.Instance.Edition edition = 20 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | Instance.EditionThe edition to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setEditionValue(int value)
public Instance.Builder setEditionValue(int value)Optional. The Edition of the current instance.
.google.spanner.admin.instance.v1.Instance.Edition edition = 20 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for edition to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setEndpointUris(int index, String value)
public Instance.Builder setEndpointUris(int index, String value)Deprecated. This field is not populated.
repeated string endpoint_uris = 8;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe endpointUris to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Instance.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setFreeInstanceMetadata(FreeInstanceMetadata value)
public Instance.Builder setFreeInstanceMetadata(FreeInstanceMetadata value)Free instance metadata. Only populated for free instances.
.google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;
| Parameter | |
|---|---|
| Name | Description |
value | FreeInstanceMetadata |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setFreeInstanceMetadata(FreeInstanceMetadata.Builder builderForValue)
public Instance.Builder setFreeInstanceMetadata(FreeInstanceMetadata.Builder builderForValue)Free instance metadata. Only populated for free instances.
.google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | FreeInstanceMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setInstanceType(Instance.InstanceType value)
public Instance.Builder setInstanceType(Instance.InstanceType value)The InstanceType of the current instance.
.google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10;
| Parameter | |
|---|---|
| Name | Description |
value | Instance.InstanceTypeThe instanceType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setInstanceTypeValue(int value)
public Instance.Builder setInstanceTypeValue(int value)The InstanceType of the current instance.
.google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for instanceType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setName(String value)
public Instance.Builder setName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Instance.Builder setNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setNodeCount(int value)
public Instance.Builder setNodeCount(int value)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.
int32 node_count = 5;
| Parameter | |
|---|---|
| Name | Description |
value | intThe nodeCount to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setProcessingUnits(int value)
public Instance.Builder setProcessingUnits(int value)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.
int32 processing_units = 9;
| Parameter | |
|---|---|
| Name | Description |
value | intThe processingUnits to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Instance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setReplicaComputeCapacity(int index, ReplicaComputeCapacity value)
public Instance.Builder setReplicaComputeCapacity(int index, ReplicaComputeCapacity value)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];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | ReplicaComputeCapacity |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setReplicaComputeCapacity(int index, ReplicaComputeCapacity.Builder builderForValue)
public Instance.Builder setReplicaComputeCapacity(int index, ReplicaComputeCapacity.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | ReplicaComputeCapacity.Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setState(Instance.State value)
public Instance.Builder setState(Instance.State value)Output only. The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For 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];
| Parameter | |
|---|---|
| Name | Description |
value | Instance.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setStateValue(int value)
public Instance.Builder setStateValue(int value)Output only. The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For 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];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Instance.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setUpdateTime(Timestamp value)
public Instance.Builder setUpdateTime(Timestamp value)Output only. The time at which the instance was most recently updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setUpdateTime(Timestamp.Builder builderForValue)
public Instance.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. The time at which the instance was most recently updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |