Class Instance (2.6.0)

public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder

Protobuf type google.cloud.memcache.v1.Instance

Implements

InstanceOrBuilder

Static Fields

AUTHORIZED_NETWORK_FIELD_NUMBER

public static final int AUTHORIZED_NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DISCOVERY_ENDPOINT_FIELD_NUMBER

public static final int DISCOVERY_ENDPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_MESSAGES_FIELD_NUMBER

public static final int INSTANCE_MESSAGES_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MEMCACHE_FULL_VERSION_FIELD_NUMBER

public static final int MEMCACHE_FULL_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

MEMCACHE_NODES_FIELD_NUMBER

public static final int MEMCACHE_NODES_FIELD_NUMBER
Field Value
TypeDescription
int

MEMCACHE_VERSION_FIELD_NUMBER

public static final int MEMCACHE_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NODE_CONFIG_FIELD_NUMBER

public static final int NODE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

NODE_COUNT_FIELD_NUMBER

public static final int NODE_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ZONES_FIELD_NUMBER

public static final int ZONES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Instance getDefaultInstance()
Returns
TypeDescription
Instance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Instance.Builder newBuilder()
Returns
TypeDescription
Instance.Builder

newBuilder(Instance prototype)

public static Instance.Builder newBuilder(Instance prototype)
Parameter
NameDescription
prototypeInstance
Returns
TypeDescription
Instance.Builder

parseDelimitedFrom(InputStream input)

public static Instance parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Instance parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Instance parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Instance parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Instance parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Instance parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Instance> parser()
Returns
TypeDescription
Parser<Instance>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAuthorizedNetwork()

public String getAuthorizedNetwork()

The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.

string authorized_network = 4;

Returns
TypeDescription
String

The authorizedNetwork.

getAuthorizedNetworkBytes()

public ByteString getAuthorizedNetworkBytes()

The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.

string authorized_network = 4;

Returns
TypeDescription
ByteString

The bytes for authorizedNetwork.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time the instance was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the instance was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
TypeDescription
Instance

getDiscoveryEndpoint()

public String getDiscoveryEndpoint()

Output only. Endpoint for Discovery API

string discovery_endpoint = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The discoveryEndpoint.

getDiscoveryEndpointBytes()

public ByteString getDiscoveryEndpointBytes()

Output only. Endpoint for Discovery API

string discovery_endpoint = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for discoveryEndpoint.

getDisplayName()

public String getDisplayName()

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

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getInstanceMessages(int index)

public Instance.InstanceMessage getInstanceMessages(int index)

List of messages that describe current statuses of memcached instance.

repeated .google.cloud.memcache.v1.Instance.InstanceMessage instance_messages = 19;

Parameter
NameDescription
indexint
Returns
TypeDescription
Instance.InstanceMessage

getInstanceMessagesCount()

public int getInstanceMessagesCount()

List of messages that describe current statuses of memcached instance.

repeated .google.cloud.memcache.v1.Instance.InstanceMessage instance_messages = 19;

Returns
TypeDescription
int

getInstanceMessagesList()

public List<Instance.InstanceMessage> getInstanceMessagesList()

List of messages that describe current statuses of memcached instance.

repeated .google.cloud.memcache.v1.Instance.InstanceMessage instance_messages = 19;

Returns
TypeDescription
List<InstanceMessage>

getInstanceMessagesOrBuilder(int index)

public Instance.InstanceMessageOrBuilder getInstanceMessagesOrBuilder(int index)

List of messages that describe current statuses of memcached instance.

repeated .google.cloud.memcache.v1.Instance.InstanceMessage instance_messages = 19;

Parameter
NameDescription
indexint
Returns
TypeDescription
Instance.InstanceMessageOrBuilder

getInstanceMessagesOrBuilderList()

public List<? extends Instance.InstanceMessageOrBuilder> getInstanceMessagesOrBuilderList()

List of messages that describe current statuses of memcached instance.

repeated .google.cloud.memcache.v1.Instance.InstanceMessage instance_messages = 19;

Returns
TypeDescription
List<? extends com.google.cloud.memcache.v1.Instance.InstanceMessageOrBuilder>

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 3;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 3;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 3;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMemcacheFullVersion()

public String getMemcacheFullVersion()

Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".

string memcache_full_version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The memcacheFullVersion.

getMemcacheFullVersionBytes()

public ByteString getMemcacheFullVersionBytes()

Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".

string memcache_full_version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for memcacheFullVersion.

getMemcacheNodes(int index)

public Instance.Node getMemcacheNodes(int index)

Output only. List of Memcached nodes. Refer to [Node] message for more details.

repeated .google.cloud.memcache.v1.Instance.Node memcache_nodes = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Instance.Node

getMemcacheNodesCount()

public int getMemcacheNodesCount()

Output only. List of Memcached nodes. Refer to [Node] message for more details.

repeated .google.cloud.memcache.v1.Instance.Node memcache_nodes = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getMemcacheNodesList()

public List<Instance.Node> getMemcacheNodesList()

Output only. List of Memcached nodes. Refer to [Node] message for more details.

repeated .google.cloud.memcache.v1.Instance.Node memcache_nodes = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Node>

getMemcacheNodesOrBuilder(int index)

public Instance.NodeOrBuilder getMemcacheNodesOrBuilder(int index)

Output only. List of Memcached nodes. Refer to [Node] message for more details.

repeated .google.cloud.memcache.v1.Instance.Node memcache_nodes = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Instance.NodeOrBuilder

getMemcacheNodesOrBuilderList()

public List<? extends Instance.NodeOrBuilder> getMemcacheNodesOrBuilderList()

Output only. List of Memcached nodes. Refer to [Node] message for more details.

repeated .google.cloud.memcache.v1.Instance.Node memcache_nodes = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.memcache.v1.Instance.NodeOrBuilder>

getMemcacheVersion()

public MemcacheVersion getMemcacheVersion()

The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.

.google.cloud.memcache.v1.MemcacheVersion memcache_version = 9;

Returns
TypeDescription
MemcacheVersion

The memcacheVersion.

getMemcacheVersionValue()

public int getMemcacheVersionValue()

The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.

.google.cloud.memcache.v1.MemcacheVersion memcache_version = 9;

Returns
TypeDescription
int

The enum numeric value on the wire for memcacheVersion.

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 regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public 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 regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.

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

Returns
TypeDescription
ByteString

The bytes for name.

getNodeConfig()

public Instance.NodeConfig getNodeConfig()

Required. Configuration for Memcached nodes.

.google.cloud.memcache.v1.Instance.NodeConfig node_config = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Instance.NodeConfig

The nodeConfig.

getNodeConfigOrBuilder()

public Instance.NodeConfigOrBuilder getNodeConfigOrBuilder()

Required. Configuration for Memcached nodes.

.google.cloud.memcache.v1.Instance.NodeConfig node_config = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Instance.NodeConfigOrBuilder

getNodeCount()

public int getNodeCount()

Required. Number of nodes in the Memcached instance.

int32 node_count = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The nodeCount.

getParameters()

public MemcacheParameters getParameters()

Optional: User defined parameters to apply to the memcached process on each node.

.google.cloud.memcache.v1.MemcacheParameters parameters = 11;

Returns
TypeDescription
MemcacheParameters

The parameters.

getParametersOrBuilder()

public MemcacheParametersOrBuilder getParametersOrBuilder()

Optional: User defined parameters to apply to the memcached process on each node.

.google.cloud.memcache.v1.MemcacheParameters parameters = 11;

Returns
TypeDescription
MemcacheParametersOrBuilder

getParserForType()

public Parser<Instance> getParserForType()
Returns
TypeDescription
Parser<Instance>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public Instance.State getState()

Output only. The state of this Memcached instance.

.google.cloud.memcache.v1.Instance.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Instance.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of this Memcached instance.

.google.cloud.memcache.v1.Instance.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time the instance was updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the instance was updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getZones(int index)

public String getZones(int index)

Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.

repeated string zones = 5;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The zones at the given index.

getZonesBytes(int index)

public ByteString getZonesBytes(int index)

Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.

repeated string zones = 5;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the zones at the given index.

getZonesCount()

public int getZonesCount()

Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.

repeated string zones = 5;

Returns
TypeDescription
int

The count of zones.

getZonesList()

public ProtocolStringList getZonesList()

Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.

repeated string zones = 5;

Returns
TypeDescription
ProtocolStringList

A list containing the zones.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time the instance was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasNodeConfig()

public boolean hasNodeConfig()

Required. Configuration for Memcached nodes.

.google.cloud.memcache.v1.Instance.NodeConfig node_config = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the nodeConfig field is set.

hasParameters()

public boolean hasParameters()

Optional: User defined parameters to apply to the memcached process on each node.

.google.cloud.memcache.v1.MemcacheParameters parameters = 11;

Returns
TypeDescription
boolean

Whether the parameters field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time the instance was updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Instance.Builder newBuilderForType()
Returns
TypeDescription
Instance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Instance.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Instance.Builder toBuilder()
Returns
TypeDescription
Instance.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException