public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder
An isolated set of Cloud Spanner resources on which databases can be hosted.
Protobuf type google.spanner.admin.instance.v1.Instance
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AUTOSCALING_CONFIG_FIELD_NUMBER
public static final int AUTOSCALING_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONFIG_FIELD_NUMBER
public static final int CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENDPOINT_URIS_FIELD_NUMBER
public static final int ENDPOINT_URIS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NODE_COUNT_FIELD_NUMBER
public static final int NODE_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROCESSING_UNITS_FIELD_NUMBER
public static final int PROCESSING_UNITS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Instance getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Instance.Builder newBuilder()
newBuilder(Instance prototype)
public static Instance.Builder newBuilder(Instance prototype)
| Parameter |
|---|
| Name | Description |
prototype | Instance
|
public static Instance parseDelimitedFrom(InputStream input)
public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Instance parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Instance parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(CodedInputStream input)
public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(InputStream input)
public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Instance parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Instance> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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];
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];
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.
|
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];
getDefaultInstanceForType()
public Instance getDefaultInstanceForType()
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.
|
getEndpointUris(int index)
public 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 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 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;
getLabels()
public Map<String,String> getLabels()
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;
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;
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
|
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.
This may be zero in API responses for instances that are not yet in state
READY.
See the
documentation
for more information about nodes and processing units.
int32 node_count = 5;
| Returns |
|---|
| Type | Description |
int | The nodeCount.
|
getParserForType()
public Parser<Instance> getParserForType()
Overrides
getProcessingUnits()
public int getProcessingUnits()
The number of processing units allocated to this instance. At most one of
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.
This may be zero in API responses for instances that are not yet in state
READY.
See the
documentation
for more information about nodes and processing units.
int32 processing_units = 9;
| Returns |
|---|
| Type | Description |
int | The processingUnits.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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];
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.
|
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];
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.
|
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
| Returns |
|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Instance.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Instance.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
