Instance (proto-google-cloud-memcache-v1 2.10.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.memcache.v1.Instance

All Implemented Interfaces:

InstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class Instance
extends com.google.protobuf.GeneratedMessageV3
implements InstanceOrBuilder
```
```
 A Memorystore for Memcached instance
 
```
Protobuf type google.cloud.memcache.v1.Instance
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Instance.Builder` A Memorystore for Memcached instance
`static class`	`Instance.InstanceMessage` Protobuf type `google.cloud.memcache.v1.Instance.InstanceMessage`
`static interface`	`Instance.InstanceMessageOrBuilder`
`static class`	`Instance.Node` Protobuf type `google.cloud.memcache.v1.Instance.Node`
`static class`	`Instance.NodeConfig` Configuration for a Memcached Node.
`static interface`	`Instance.NodeConfigOrBuilder`
`static interface`	`Instance.NodeOrBuilder`
`static class`	`Instance.State` Different states of a Memcached instance.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AUTHORIZED_NETWORK_FIELD_NUMBER`
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`DISCOVERY_ENDPOINT_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`INSTANCE_MESSAGES_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`MAINTENANCE_POLICY_FIELD_NUMBER`
`static int`	`MAINTENANCE_SCHEDULE_FIELD_NUMBER`
`static int`	`MEMCACHE_FULL_VERSION_FIELD_NUMBER`
`static int`	`MEMCACHE_NODES_FIELD_NUMBER`
`static int`	`MEMCACHE_VERSION_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`NODE_CONFIG_FIELD_NUMBER`
`static int`	`NODE_COUNT_FIELD_NUMBER`
`static int`	`PARAMETERS_FIELD_NUMBER`
`static int`	`STATE_FIELD_NUMBER`
`static int`	`UPDATE_TIME_FIELD_NUMBER`
`static int`	`ZONES_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` Resource labels to represent user-provided metadata.
`boolean`	`equals(Object obj)`
`String`	`getAuthorizedNetwork()` The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
`com.google.protobuf.ByteString`	`getAuthorizedNetworkBytes()` The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`static Instance`	`getDefaultInstance()`
`Instance`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDiscoveryEndpoint()` Output only.
`com.google.protobuf.ByteString`	`getDiscoveryEndpointBytes()` Output only.
`String`	`getDisplayName()` User provided name for the instance, which is only used for display purposes.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` User provided name for the instance, which is only used for display purposes.
`Instance.InstanceMessage`	`getInstanceMessages(int index)` List of messages that describe the current state of the Memcached instance.
`int`	`getInstanceMessagesCount()` List of messages that describe the current state of the Memcached instance.
`List<Instance.InstanceMessage>`	`getInstanceMessagesList()` List of messages that describe the current state of the Memcached instance.
`Instance.InstanceMessageOrBuilder`	`getInstanceMessagesOrBuilder(int index)` List of messages that describe the current state of the Memcached instance.
`List<? extends Instance.InstanceMessageOrBuilder>`	`getInstanceMessagesOrBuilderList()` List of messages that describe the current state of the Memcached instance.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Resource labels to represent user-provided metadata.
`Map<String,String>`	`getLabelsMap()` Resource labels to represent user-provided metadata.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Resource labels to represent user-provided metadata.
`String`	`getLabelsOrThrow(String key)` Resource labels to represent user-provided metadata.
`MaintenancePolicy`	`getMaintenancePolicy()` The maintenance policy for the instance.
`MaintenancePolicyOrBuilder`	`getMaintenancePolicyOrBuilder()` The maintenance policy for the instance.
`MaintenanceSchedule`	`getMaintenanceSchedule()` Output only.
`MaintenanceScheduleOrBuilder`	`getMaintenanceScheduleOrBuilder()` Output only.
`String`	`getMemcacheFullVersion()` Output only.
`com.google.protobuf.ByteString`	`getMemcacheFullVersionBytes()` Output only.
`Instance.Node`	`getMemcacheNodes(int index)` Output only.
`int`	`getMemcacheNodesCount()` Output only.
`List<Instance.Node>`	`getMemcacheNodesList()` Output only.
`Instance.NodeOrBuilder`	`getMemcacheNodesOrBuilder(int index)` Output only.
`List<? extends Instance.NodeOrBuilder>`	`getMemcacheNodesOrBuilderList()` Output only.
`MemcacheVersion`	`getMemcacheVersion()` The major version of Memcached software.
`int`	`getMemcacheVersionValue()` The major version of Memcached software.
`String`	`getName()` Required.
`com.google.protobuf.ByteString`	`getNameBytes()` Required.
`Instance.NodeConfig`	`getNodeConfig()` Required.
`Instance.NodeConfigOrBuilder`	`getNodeConfigOrBuilder()` Required.
`int`	`getNodeCount()` Required.
`MemcacheParameters`	`getParameters()` User defined parameters to apply to the memcached process on each node.
`MemcacheParametersOrBuilder`	`getParametersOrBuilder()` User defined parameters to apply to the memcached process on each node.
`com.google.protobuf.Parser<Instance>`	`getParserForType()`
`int`	`getSerializedSize()`
`Instance.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`String`	`getZones(int index)` Zones in which Memcached nodes should be provisioned.
`com.google.protobuf.ByteString`	`getZonesBytes(int index)` Zones in which Memcached nodes should be provisioned.
`int`	`getZonesCount()` Zones in which Memcached nodes should be provisioned.
`com.google.protobuf.ProtocolStringList`	`getZonesList()` Zones in which Memcached nodes should be provisioned.
`boolean`	`hasCreateTime()` Output only.
`int`	`hashCode()`
`boolean`	`hasMaintenancePolicy()` The maintenance policy for the instance.
`boolean`	`hasMaintenanceSchedule()` Output only.
`boolean`	`hasNodeConfig()` Required.
`boolean`	`hasParameters()` User defined parameters to apply to the memcached process on each node.
`boolean`	`hasUpdateTime()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static Instance.Builder`	`newBuilder()`
`static Instance.Builder`	`newBuilder(Instance prototype)`
`Instance.Builder`	`newBuilderForType()`
`protected Instance.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Instance`	`parseDelimitedFrom(InputStream input)`
`static Instance`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Instance`	`parseFrom(byte[] data)`
`static Instance`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Instance`	`parseFrom(ByteBuffer data)`
`static Instance`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Instance`	`parseFrom(com.google.protobuf.ByteString data)`
`static Instance`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Instance`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Instance`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Instance`	`parseFrom(InputStream input)`
`static Instance`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Instance>`	`parser()`
`Instance.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- AUTHORIZED_NETWORK_FIELD_NUMBER
```
public static final int AUTHORIZED_NETWORK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ZONES_FIELD_NUMBER
```
public static final int ZONES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NODE_COUNT_FIELD_NUMBER
```
public static final int NODE_COUNT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NODE_CONFIG_FIELD_NUMBER
```
public static final int NODE_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MEMCACHE_VERSION_FIELD_NUMBER
```
public static final int MEMCACHE_VERSION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARAMETERS_FIELD_NUMBER
```
public static final int PARAMETERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MEMCACHE_NODES_FIELD_NUMBER
```
public static final int MEMCACHE_NODES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATE_FIELD_NUMBER
```
public static final int STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MEMCACHE_FULL_VERSION_FIELD_NUMBER
```
public static final int MEMCACHE_FULL_VERSION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INSTANCE_MESSAGES_FIELD_NUMBER
```
public static final int INSTANCE_MESSAGES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISCOVERY_ENDPOINT_FIELD_NUMBER
```
public static final int DISCOVERY_ENDPOINT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MAINTENANCE_POLICY_FIELD_NUMBER
```
public static final int MAINTENANCE_POLICY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MAINTENANCE_SCHEDULE_FIELD_NUMBER
```
public static final int MAINTENANCE_SCHEDULE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Required. Unique name of the resource in this scope including project and
 location using the form:
     `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
 Note: Memcached instances are managed and addressed at the regional level
 so `location_id` here refers to a Google Cloud region; however, users may
 choose which zones Memcached nodes should be provisioned in within an
 instance. Refer to [zones][google.cloud.memcache.v1.Instance.zones] field for more details.

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

Specified by:: getName in interface InstanceOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Required. Unique name of the resource in this scope including project and
 location using the form:
     `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
 Note: Memcached instances are managed and addressed at the regional level
 so `location_id` here refers to a Google Cloud region; however, users may
 choose which zones Memcached nodes should be provisioned in within an
 instance. Refer to [zones][google.cloud.memcache.v1.Instance.zones] field for more details.

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

Specified by:: getNameBytes in interface InstanceOrBuilder
Returns:: The bytes for name.

getDisplayName

public String getDisplayName()

 User provided name for the instance, which is only used for display
 purposes. Cannot be more than 80 characters.

string display_name = 2;

Specified by:: getDisplayName in interface InstanceOrBuilder
Returns:: The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 User provided name for the instance, which is only used for display
 purposes. Cannot be more than 80 characters.

string display_name = 2;

Specified by:: getDisplayNameBytes in interface InstanceOrBuilder
Returns:: The bytes for displayName.