public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder
A Memorystore for Memcached instance
Protobuf type google.cloud.memcache.v1.Instance
Static Fields
AUTHORIZED_NETWORK_FIELD_NUMBER
public static final int AUTHORIZED_NETWORK_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DISCOVERY_ENDPOINT_FIELD_NUMBER
public static final int DISCOVERY_ENDPOINT_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
INSTANCE_MESSAGES_FIELD_NUMBER
public static final int INSTANCE_MESSAGES_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
MAINTENANCE_POLICY_FIELD_NUMBER
public static final int MAINTENANCE_POLICY_FIELD_NUMBER
Field Value
MAINTENANCE_SCHEDULE_FIELD_NUMBER
public static final int MAINTENANCE_SCHEDULE_FIELD_NUMBER
Field Value
MEMCACHE_FULL_VERSION_FIELD_NUMBER
public static final int MEMCACHE_FULL_VERSION_FIELD_NUMBER
Field Value
MEMCACHE_NODES_FIELD_NUMBER
public static final int MEMCACHE_NODES_FIELD_NUMBER
Field Value
MEMCACHE_VERSION_FIELD_NUMBER
public static final int MEMCACHE_VERSION_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
NODE_CONFIG_FIELD_NUMBER
public static final int NODE_CONFIG_FIELD_NUMBER
Field Value
NODE_COUNT_FIELD_NUMBER
public static final int NODE_COUNT_FIELD_NUMBER
Field Value
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
ZONES_FIELD_NUMBER
public static final int ZONES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Instance getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Instance.Builder newBuilder()
Returns
newBuilder(Instance prototype)
public static Instance.Builder newBuilder(Instance prototype)
Parameter
Returns
public static Instance parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Instance parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Instance parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Instance parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Instance parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Instance parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Instance> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Parameter
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
| Type | Description |
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;
| Type | Description |
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];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time the instance was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Instance getDefaultInstanceForType()
Returns
getDiscoveryEndpoint()
public String getDiscoveryEndpoint()
Output only. Endpoint for the Discovery API.
string discovery_endpoint = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
String | The discoveryEndpoint.
|
getDiscoveryEndpointBytes()
public ByteString getDiscoveryEndpointBytes()
Output only. Endpoint for the Discovery API.
string discovery_endpoint = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
ByteString | The bytes for discoveryEndpoint.
|
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;
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public 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;
| Type | Description |
ByteString | The bytes for displayName.
|
getInstanceMessages(int index)
public 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;
getInstanceMessagesCount()
public int getInstanceMessagesCount()
List of messages that describe the current state of the Memcached instance.
repeated .google.cloud.memcache.v1.Instance.InstanceMessage instance_messages = 19;
getInstanceMessagesList()
public 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;
getInstanceMessagesOrBuilder(int index)
public 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;
getInstanceMessagesOrBuilderList()
public 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;
| Type | Description |
List<? extends com.google.cloud.memcache.v1.Instance.InstanceMessageOrBuilder> | |
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Returns
getLabelsMap()
public Map<String,String> getLabelsMap()
Returns
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Parameters
Returns
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Parameter
Returns
getMaintenancePolicy()
public 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;
getMaintenancePolicyOrBuilder()
public 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;
getMaintenanceSchedule()
public MaintenanceSchedule getMaintenanceSchedule()
Output only. Published maintenance schedule.
.google.cloud.memcache.v1.MaintenanceSchedule maintenance_schedule = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
getMaintenanceScheduleOrBuilder()
public MaintenanceScheduleOrBuilder getMaintenanceScheduleOrBuilder()
Output only. Published maintenance schedule.
.google.cloud.memcache.v1.MaintenanceSchedule maintenance_schedule = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
| Type | Description |
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];
| Type | Description |
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];
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];
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];
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];
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];
| Type | Description |
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;
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;
| Type | Description |
int | The enum numeric value on the wire for memcacheVersion.
|
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];
| Type | Description |
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 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];
getNodeConfig()
public Instance.NodeConfig getNodeConfig()
Required. Configuration for Memcached nodes.
.google.cloud.memcache.v1.Instance.NodeConfig node_config = 7 [(.google.api.field_behavior) = REQUIRED];
getNodeConfigOrBuilder()
public Instance.NodeConfigOrBuilder getNodeConfigOrBuilder()
Required. Configuration for Memcached nodes.
.google.cloud.memcache.v1.Instance.NodeConfig node_config = 7 [(.google.api.field_behavior) = REQUIRED];
getNodeCount()
public int getNodeCount()
Required. Number of nodes in the Memcached instance.
int32 node_count = 6 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
int | The nodeCount.
|
getParameters()
public MemcacheParameters getParameters()
User defined parameters to apply to the memcached process
on each node.
.google.cloud.memcache.v1.MemcacheParameters parameters = 11;
getParametersOrBuilder()
public MemcacheParametersOrBuilder getParametersOrBuilder()
User defined parameters to apply to the memcached process
on each node.
.google.cloud.memcache.v1.MemcacheParameters parameters = 11;
getParserForType()
public Parser<Instance> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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];
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];
| Type | Description |
int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time the instance was updated.
.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getZones(int index)
public 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;
| 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 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;
| 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 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;
| Type | Description |
int | The count of zones.
|
getZonesList()
public ProtocolStringList 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;
hasCreateTime()
public boolean hasCreateTime()
Output only. The time the instance was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
boolean | Whether the createTime field is set.
|
hasMaintenancePolicy()
public 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;
| Type | Description |
boolean | Whether the maintenancePolicy field is set.
|
hasMaintenanceSchedule()
public boolean hasMaintenanceSchedule()
Output only. Published maintenance schedule.
.google.cloud.memcache.v1.MaintenanceSchedule maintenance_schedule = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
boolean | Whether the maintenanceSchedule 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];
| Type | Description |
boolean | Whether the nodeConfig field is set.
|
hasParameters()
public boolean hasParameters()
User defined parameters to apply to the memcached process
on each node.
.google.cloud.memcache.v1.MemcacheParameters parameters = 11;
| Type | Description |
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];
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Instance.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Instance.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
