Interface InstanceOrBuilder (2.5.0)

public interface InstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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

Name	Description
key	`String`

Returns

Type	Description
boolean

getAuthorizedNetwork()

public abstract 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

Type	Description
String	The authorizedNetwork.

getAuthorizedNetworkBytes()

public abstract 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

Type	Description
ByteString	The bytes for authorizedNetwork.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time the instance was created.

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

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the instance was created.

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

Returns

Type	Description
TimestampOrBuilder

getDiscoveryEndpoint()

public abstract String getDiscoveryEndpoint()

Output only. Endpoint for Discovery API

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

Returns

Type	Description
String	The discoveryEndpoint.

getDiscoveryEndpointBytes()

public abstract ByteString getDiscoveryEndpointBytes()

Output only. Endpoint for Discovery API

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

Returns

Type	Description
ByteString	The bytes for discoveryEndpoint.

getDisplayName()

public abstract String getDisplayName()

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

string display_name = 2;

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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

string display_name = 2;

Returns

Type	Description
ByteString	The bytes for displayName.

getInstanceMessages(int index)

public abstract 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

Name	Description
index	`int`

Returns

Type	Description
Instance.InstanceMessage

getInstanceMessagesCount()

public abstract int getInstanceMessagesCount()

List of messages that describe current statuses of memcached instance.

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

Returns

Type	Description
int

getInstanceMessagesList()

public abstract 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

Type	Description
List<InstanceMessage>

getInstanceMessagesOrBuilder(int index)

public abstract 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

Name	Description
index	`int`

Returns

Type	Description
Instance.InstanceMessageOrBuilder

getInstanceMessagesOrBuilderList()

public abstract 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

Type	Description
List<? extends com.google.cloud.memcache.v1.Instance.InstanceMessageOrBuilder>

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public abstract 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

Type	Description
int

getLabelsMap()

public abstract 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

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract 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

Name	Description
key	`String`
defaultValue	`String`

Returns

Type	Description
String

getLabelsOrThrow(String key)

public abstract 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

Name	Description
key	`String`

Returns

Type	Description
String

getMemcacheFullVersion()

public abstract 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

Type	Description
String	The memcacheFullVersion.

getMemcacheFullVersionBytes()

public abstract ByteString getMemcacheFullVersionBytes()

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

Returns

Type	Description
ByteString	The bytes for memcacheFullVersion.

getMemcacheNodes(int index)

public abstract 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

Name	Description
index	`int`

Returns

Type	Description
Instance.Node

getMemcacheNodesCount()

public abstract 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

Type	Description
int

getMemcacheNodesList()

public abstract 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

Type	Description
List<Node>

getMemcacheNodesOrBuilder(int index)

public abstract 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

Name	Description
index	`int`

Returns

Type	Description
Instance.NodeOrBuilder

getMemcacheNodesOrBuilderList()

public abstract 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

Type	Description
List<? extends com.google.cloud.memcache.v1.Instance.NodeOrBuilder>

getMemcacheVersion()

public abstract 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

Type	Description
MemcacheVersion	The memcacheVersion.

getMemcacheVersionValue()

public abstract int getMemcacheVersionValue()

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

Returns

Type	Description
int	The enum numeric value on the wire for memcacheVersion.

getName()

public abstract 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

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

Returns

Type	Description
ByteString	The bytes for name.

getNodeConfig()

public abstract Instance.NodeConfig getNodeConfig()

Required. Configuration for Memcached nodes.

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

Returns

Type	Description
Instance.NodeConfig	The nodeConfig.

getNodeConfigOrBuilder()

public abstract Instance.NodeConfigOrBuilder getNodeConfigOrBuilder()

Required. Configuration for Memcached nodes.

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

Returns

Type	Description
Instance.NodeConfigOrBuilder

getNodeCount()

public abstract int getNodeCount()

Required. Number of nodes in the Memcached instance.

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

Returns

Type	Description
int	The nodeCount.

getParameters()

public abstract MemcacheParameters getParameters()

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

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

Returns

Type	Description
MemcacheParameters	The parameters.

getParametersOrBuilder()

public abstract MemcacheParametersOrBuilder getParametersOrBuilder()

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

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

Returns

Type	Description
MemcacheParametersOrBuilder

getState()

public abstract 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

Type	Description
Instance.State	The state.

getStateValue()

public abstract 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

Type	Description
int	The enum numeric value on the wire for state.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time the instance was updated.

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

Returns

Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the instance was updated.

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

Returns

Type	Description
TimestampOrBuilder

getZones(int index)

public abstract 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

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The zones at the given index.

getZonesBytes(int index)

public abstract ByteString getZonesBytes(int index)

repeated string zones = 5;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the zones at the given index.

getZonesCount()

public abstract int getZonesCount()

repeated string zones = 5;

Returns

Type	Description
int	The count of zones.

getZonesList()

public abstract List<String> getZonesList()

repeated string zones = 5;

Returns

Type	Description
List<String>	A list containing the zones.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time the instance was created.

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

Returns

Type	Description
boolean	Whether the createTime field is set.

hasNodeConfig()

public abstract boolean hasNodeConfig()

Required. Configuration for Memcached nodes.

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

Returns

Type	Description
boolean	Whether the nodeConfig field is set.

hasParameters()

public abstract boolean hasParameters()

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

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

Returns

Type	Description
boolean	Whether the parameters field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time the instance was updated.

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

Returns

Type	Description
boolean	Whether the updateTime field is set.