Class Instance (2.17.0)

public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder

A Memorystore for Redis instance.

Protobuf type google.cloud.redis.v1.Instance

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Instance

Implements

InstanceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALTERNATIVE_LOCATION_ID_FIELD_NUMBER

public static final int ALTERNATIVE_LOCATION_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

AUTHORIZED_NETWORK_FIELD_NUMBER

public static final int AUTHORIZED_NETWORK_FIELD_NUMBER

Field Value
Type	Description
`int`

AUTH_ENABLED_FIELD_NUMBER

public static final int AUTH_ENABLED_FIELD_NUMBER

Field Value
Type	Description
`int`

CONNECT_MODE_FIELD_NUMBER

public static final int CONNECT_MODE_FIELD_NUMBER

Field Value
Type	Description
`int`

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

CURRENT_LOCATION_ID_FIELD_NUMBER

public static final int CURRENT_LOCATION_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

HOST_FIELD_NUMBER

public static final int HOST_FIELD_NUMBER

Field Value
Type	Description
`int`

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value
Type	Description
`int`

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

MAINTENANCE_POLICY_FIELD_NUMBER

public static final int MAINTENANCE_POLICY_FIELD_NUMBER

Field Value
Type	Description
`int`

MAINTENANCE_SCHEDULE_FIELD_NUMBER

public static final int MAINTENANCE_SCHEDULE_FIELD_NUMBER

Field Value
Type	Description
`int`

MEMORY_SIZE_GB_FIELD_NUMBER

public static final int MEMORY_SIZE_GB_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

NODES_FIELD_NUMBER

public static final int NODES_FIELD_NUMBER

Field Value
Type	Description
`int`

PERSISTENCE_IAM_IDENTITY_FIELD_NUMBER

public static final int PERSISTENCE_IAM_IDENTITY_FIELD_NUMBER

Field Value
Type	Description
`int`

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER

Field Value
Type	Description
`int`

READ_ENDPOINT_FIELD_NUMBER

public static final int READ_ENDPOINT_FIELD_NUMBER

Field Value
Type	Description
`int`

READ_ENDPOINT_PORT_FIELD_NUMBER

public static final int READ_ENDPOINT_PORT_FIELD_NUMBER

Field Value
Type	Description
`int`

READ_REPLICAS_MODE_FIELD_NUMBER

public static final int READ_REPLICAS_MODE_FIELD_NUMBER

Field Value
Type	Description
`int`

REDIS_CONFIGS_FIELD_NUMBER

public static final int REDIS_CONFIGS_FIELD_NUMBER

Field Value
Type	Description
`int`

REDIS_VERSION_FIELD_NUMBER

public static final int REDIS_VERSION_FIELD_NUMBER

Field Value
Type	Description
`int`

REPLICA_COUNT_FIELD_NUMBER

public static final int REPLICA_COUNT_FIELD_NUMBER

Field Value
Type	Description
`int`

RESERVED_IP_RANGE_FIELD_NUMBER

public static final int RESERVED_IP_RANGE_FIELD_NUMBER

Field Value
Type	Description
`int`

SECONDARY_IP_RANGE_FIELD_NUMBER

public static final int SECONDARY_IP_RANGE_FIELD_NUMBER

Field Value
Type	Description
`int`

SERVER_CA_CERTS_FIELD_NUMBER

public static final int SERVER_CA_CERTS_FIELD_NUMBER

Field Value
Type	Description
`int`

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
`int`

STATUS_MESSAGE_FIELD_NUMBER

public static final int STATUS_MESSAGE_FIELD_NUMBER

Field Value
Type	Description
`int`

TIER_FIELD_NUMBER

public static final int TIER_FIELD_NUMBER

Field Value
Type	Description
`int`

TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER

public static final int TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Instance getDefaultInstance()

Returns
Type	Description
`Instance`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Instance.Builder newBuilder()

Returns
Type	Description
`Instance.Builder`

newBuilder(Instance prototype)

public static Instance.Builder newBuilder(Instance prototype)

Parameter
Name	Description
`prototype`	`Instance`

Returns
Type	Description
`Instance.Builder`

parseDelimitedFrom(InputStream input)

public static Instance parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Instance parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Instance parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Instance parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Instance parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Instance parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Instance> parser()

Returns
Type	Description
`Parser<Instance>`

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Resource labels to represent user provided metadata

map<string, string> labels = 3;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

containsRedisConfigs(String key)

public boolean containsRedisConfigs(String key)

Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer:

maxmemory-policy
notify-keyspace-events Redis version 4.0 and newer:
activedefrag
lfu-decay-time
lfu-log-factor
maxmemory-gb Redis version 5.0 and newer:
stream-node-max-bytes
stream-node-max-entries

map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAlternativeLocationId()

public String getAlternativeLocationId()

Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service.

string alternative_location_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The alternativeLocationId.

getAlternativeLocationIdBytes()

public ByteString getAlternativeLocationIdBytes()

string alternative_location_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for alternativeLocationId.

getAuthEnabled()

public boolean getAuthEnabled()

Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.

bool auth_enabled = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The authEnabled.

getAuthorizedNetwork()

public String getAuthorizedNetwork()

Optional. 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 = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The authorizedNetwork.

getAuthorizedNetworkBytes()

public ByteString getAuthorizedNetworkBytes()

Optional. 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 = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for authorizedNetwork.

getConnectMode()

public Instance.ConnectMode getConnectMode()

Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.

.google.cloud.redis.v1.Instance.ConnectMode connect_mode = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Instance.ConnectMode`	The connectMode.

getConnectModeValue()

public int getConnectModeValue()

Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.

.google.cloud.redis.v1.Instance.ConnectMode connect_mode = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for connectMode.

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
Type	Description
`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
Type	Description
`TimestampOrBuilder`

getCurrentLocationId()

public String getCurrentLocationId()

Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance.

string current_location_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The currentLocationId.

getCurrentLocationIdBytes()

public ByteString getCurrentLocationIdBytes()

string current_location_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for currentLocationId.

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()

Returns
Type	Description
`Instance`

getDisplayName()

public String getDisplayName()

An arbitrary and optional user-provided name for the instance.

string display_name = 2;

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

An arbitrary and optional user-provided name for the instance.

string display_name = 2;

Returns
Type	Description
`ByteString`	The bytes for displayName.

getHost()

public String getHost()

Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

string host = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The host.

getHostBytes()

public ByteString getHostBytes()

Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

string host = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for host.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public int getLabelsCount()

Resource labels to represent user provided metadata

map<string, string> labels = 3;

Returns
Type	Description
`int`

getLabelsMap()

public Map<String,String> getLabelsMap()

Resource labels to represent user provided metadata

map<string, string> labels = 3;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Resource labels to represent user provided metadata

map<string, string> labels = 3;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Resource labels to represent user provided metadata

map<string, string> labels = 3;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getLocationId()

public String getLocationId()

Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.

string location_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

string location_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for locationId.

getMaintenancePolicy()

public MaintenancePolicy getMaintenancePolicy()

Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.

.google.cloud.redis.v1.MaintenancePolicy maintenance_policy = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`MaintenancePolicy`	The maintenancePolicy.

getMaintenancePolicyOrBuilder()

public MaintenancePolicyOrBuilder getMaintenancePolicyOrBuilder()

Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.

.google.cloud.redis.v1.MaintenancePolicy maintenance_policy = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`MaintenancePolicyOrBuilder`

getMaintenanceSchedule()

public MaintenanceSchedule getMaintenanceSchedule()

Output only. Date and time of upcoming maintenance events which have been scheduled.

.google.cloud.redis.v1.MaintenanceSchedule maintenance_schedule = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`MaintenanceSchedule`	The maintenanceSchedule.

getMaintenanceScheduleOrBuilder()

public MaintenanceScheduleOrBuilder getMaintenanceScheduleOrBuilder()

Output only. Date and time of upcoming maintenance events which have been scheduled.

.google.cloud.redis.v1.MaintenanceSchedule maintenance_schedule = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`MaintenanceScheduleOrBuilder`

getMemorySizeGb()

public int getMemorySizeGb()

Required. Redis memory size in GiB.

int32 memory_size_gb = 18 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The memorySizeGb.

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: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.

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

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

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

Returns
Type	Description
`ByteString`	The bytes for name.

getNodes(int index)

public NodeInfo getNodes(int index)

Output only. Info per node.

repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`NodeInfo`

getNodesCount()

public int getNodesCount()

Output only. Info per node.

repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

getNodesList()

public List<NodeInfo> getNodesList()

Output only. Info per node.

repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<NodeInfo>`

getNodesOrBuilder(int index)

public NodeInfoOrBuilder getNodesOrBuilder(int index)

Output only. Info per node.

repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`NodeInfoOrBuilder`

getNodesOrBuilderList()

public List<? extends NodeInfoOrBuilder> getNodesOrBuilderList()

Output only. Info per node.

repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<? extends com.google.cloud.redis.v1.NodeInfoOrBuilder>`

getParserForType()

public Parser<Instance> getParserForType()

Returns
Type	Description
`Parser<Instance>`

Overrides

GeneratedMessageV3.getParserForType()

getPersistenceIamIdentity()

public String getPersistenceIamIdentity()

Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation.

string persistence_iam_identity = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The persistenceIamIdentity.

getPersistenceIamIdentityBytes()

public ByteString getPersistenceIamIdentityBytes()

string persistence_iam_identity = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for persistenceIamIdentity.

getPort()

public int getPort()

Output only. The port number of the exposed Redis endpoint.

int32 port = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The port.

getReadEndpoint()

public String getReadEndpoint()

Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.

string read_endpoint = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The readEndpoint.

getReadEndpointBytes()

public ByteString getReadEndpointBytes()

string read_endpoint = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for readEndpoint.

getReadEndpointPort()

public int getReadEndpointPort()

Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.

int32 read_endpoint_port = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The readEndpointPort.

getReadReplicasMode()

public Instance.ReadReplicasMode getReadReplicasMode()

Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.

.google.cloud.redis.v1.Instance.ReadReplicasMode read_replicas_mode = 35 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Instance.ReadReplicasMode`	The readReplicasMode.

getReadReplicasModeValue()

public int getReadReplicasModeValue()

Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.

.google.cloud.redis.v1.Instance.ReadReplicasMode read_replicas_mode = 35 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for readReplicasMode.

getRedisConfigs()

public Map<String,String> getRedisConfigs()

Use #getRedisConfigsMap() instead.

Returns
Type	Description
`Map<String,String>`

getRedisConfigsCount()

public int getRedisConfigsCount()

Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer:

maxmemory-policy
notify-keyspace-events Redis version 4.0 and newer:
activedefrag
lfu-decay-time
lfu-log-factor
maxmemory-gb Redis version 5.0 and newer:
stream-node-max-bytes
stream-node-max-entries

map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getRedisConfigsMap()

public Map<String,String> getRedisConfigsMap()

Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer:

maxmemory-policy
notify-keyspace-events Redis version 4.0 and newer:
activedefrag
lfu-decay-time
lfu-log-factor
maxmemory-gb Redis version 5.0 and newer:
stream-node-max-bytes
stream-node-max-entries

map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Map<String,String>`

getRedisConfigsOrDefault(String key, String defaultValue)

public String getRedisConfigsOrDefault(String key, String defaultValue)

Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer:

maxmemory-policy
notify-keyspace-events Redis version 4.0 and newer:
activedefrag
lfu-decay-time
lfu-log-factor
maxmemory-gb Redis version 5.0 and newer:
stream-node-max-bytes
stream-node-max-entries

map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getRedisConfigsOrThrow(String key)

public String getRedisConfigsOrThrow(String key)

Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer:

maxmemory-policy
notify-keyspace-events Redis version 4.0 and newer:
activedefrag
lfu-decay-time
lfu-log-factor
maxmemory-gb Redis version 5.0 and newer:
stream-node-max-bytes
stream-node-max-entries

map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getRedisVersion()

public String getRedisVersion()

Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are:

REDIS_3_2 for Redis 3.2 compatibility
REDIS_4_0 for Redis 4.0 compatibility (default)
REDIS_5_0 for Redis 5.0 compatibility
REDIS_6_X for Redis 6.x compatibility

string redis_version = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The redisVersion.

getRedisVersionBytes()

public ByteString getRedisVersionBytes()

Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are:

REDIS_3_2 for Redis 3.2 compatibility
REDIS_4_0 for Redis 4.0 compatibility (default)
REDIS_5_0 for Redis 5.0 compatibility
REDIS_6_X for Redis 6.x compatibility

string redis_version = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for redisVersion.

getReplicaCount()

public int getReplicaCount()

Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.

int32 replica_count = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The replicaCount.

getReservedIpRange()

public String getReservedIpRange()

Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.

string reserved_ip_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The reservedIpRange.

getReservedIpRangeBytes()

public ByteString getReservedIpRangeBytes()

string reserved_ip_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for reservedIpRange.

getSecondaryIpRange()

public String getSecondaryIpRange()

Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".

string secondary_ip_range = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The secondaryIpRange.

getSecondaryIpRangeBytes()

public ByteString getSecondaryIpRangeBytes()

string secondary_ip_range = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for secondaryIpRange.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()