Interface InstanceOrBuilder (2.27.0)

Version 2.27.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.6
• 2.2.1
• 2.1.11

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 the 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 the 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, which is 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, which is 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 the current state of the 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 the current state of the 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 the current state of the 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 the current state of the 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 the current state of the 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

getMaintenancePolicy()

public abstract MaintenancePolicy getMaintenancePolicy()

The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.

.google.cloud.memcache.v1.MaintenancePolicy maintenance_policy = 21;

Returns
Type	Description
MaintenancePolicy	The maintenancePolicy.

getMaintenancePolicyOrBuilder()

public abstract MaintenancePolicyOrBuilder getMaintenancePolicyOrBuilder()

The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.

.google.cloud.memcache.v1.MaintenancePolicy maintenance_policy = 21;

Returns
Type	Description
MaintenancePolicyOrBuilder

getMaintenanceSchedule()

public abstract MaintenanceSchedule getMaintenanceSchedule()

Output only. Published maintenance schedule.

.google.cloud.memcache.v1.MaintenanceSchedule maintenance_schedule = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
MaintenanceSchedule	The maintenanceSchedule.

getMaintenanceScheduleOrBuilder()

public abstract MaintenanceScheduleOrBuilder getMaintenanceScheduleOrBuilder()

Output only. Published maintenance schedule.

.google.cloud.memcache.v1.MaintenanceSchedule maintenance_schedule = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
MaintenanceScheduleOrBuilder

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()

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
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()

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
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 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 field for more details.

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

Returns
Type	Description
String	The name.

getNameBytes()

public abstract 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 field for more details.

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()

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()

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 in which Memcached nodes should be provisioned. 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)

Zones in which Memcached nodes should be provisioned. 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 value to return.

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

getZonesCount()

public abstract int getZonesCount()

Zones in which Memcached nodes should be provisioned. 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
Type	Description
int	The count of zones.

getZonesList()

public abstract List<String> getZonesList()

Zones in which Memcached nodes should be provisioned. 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
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.

hasMaintenancePolicy()

public abstract boolean hasMaintenancePolicy()

The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.

.google.cloud.memcache.v1.MaintenancePolicy maintenance_policy = 21;

Returns
Type	Description
boolean	Whether the maintenancePolicy field is set.

hasMaintenanceSchedule()

public abstract boolean hasMaintenanceSchedule()

Output only. Published maintenance schedule.

.google.cloud.memcache.v1.MaintenanceSchedule maintenance_schedule = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the maintenanceSchedule 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()

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.