Class Instance (2.81.0)

publicfinalclass InstanceextendsGeneratedMessageV3implementsInstanceOrBuilder

A Memorystore for Redis instance.

Protobuf type google.cloud.redis.v1beta1.Instance

Implements

InstanceOrBuilder

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

ALTERNATIVE_LOCATION_ID_FIELD_NUMBER

publicstaticfinalintALTERNATIVE_LOCATION_ID_FIELD_NUMBER
Field Value
Type Description
int

AUTHORIZED_NETWORK_FIELD_NUMBER

publicstaticfinalintAUTHORIZED_NETWORK_FIELD_NUMBER
Field Value
Type Description
int

AUTH_ENABLED_FIELD_NUMBER

publicstaticfinalintAUTH_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

CONNECT_MODE_FIELD_NUMBER

publicstaticfinalintCONNECT_MODE_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

publicstaticfinalintCREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CURRENT_LOCATION_ID_FIELD_NUMBER

publicstaticfinalintCURRENT_LOCATION_ID_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

publicstaticfinalintDISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

HOST_FIELD_NUMBER

publicstaticfinalintHOST_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

publicstaticfinalintLABELS_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_ID_FIELD_NUMBER

publicstaticfinalintLOCATION_ID_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_POLICY_FIELD_NUMBER

publicstaticfinalintMAINTENANCE_POLICY_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_SCHEDULE_FIELD_NUMBER

publicstaticfinalintMAINTENANCE_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

MEMORY_SIZE_GB_FIELD_NUMBER

publicstaticfinalintMEMORY_SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER
Field Value
Type Description
int

NODES_FIELD_NUMBER

publicstaticfinalintNODES_FIELD_NUMBER
Field Value
Type Description
int

PERSISTENCE_CONFIG_FIELD_NUMBER

publicstaticfinalintPERSISTENCE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PERSISTENCE_IAM_IDENTITY_FIELD_NUMBER

publicstaticfinalintPERSISTENCE_IAM_IDENTITY_FIELD_NUMBER
Field Value
Type Description
int

PORT_FIELD_NUMBER

publicstaticfinalintPORT_FIELD_NUMBER
Field Value
Type Description
int

READ_ENDPOINT_FIELD_NUMBER

publicstaticfinalintREAD_ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

READ_ENDPOINT_PORT_FIELD_NUMBER

publicstaticfinalintREAD_ENDPOINT_PORT_FIELD_NUMBER
Field Value
Type Description
int

READ_REPLICAS_MODE_FIELD_NUMBER

publicstaticfinalintREAD_REPLICAS_MODE_FIELD_NUMBER
Field Value
Type Description
int

REDIS_CONFIGS_FIELD_NUMBER

publicstaticfinalintREDIS_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

REDIS_VERSION_FIELD_NUMBER

publicstaticfinalintREDIS_VERSION_FIELD_NUMBER
Field Value
Type Description
int

REPLICA_COUNT_FIELD_NUMBER

publicstaticfinalintREPLICA_COUNT_FIELD_NUMBER
Field Value
Type Description
int

RESERVED_IP_RANGE_FIELD_NUMBER

publicstaticfinalintRESERVED_IP_RANGE_FIELD_NUMBER
Field Value
Type Description
int

SECONDARY_IP_RANGE_FIELD_NUMBER

publicstaticfinalintSECONDARY_IP_RANGE_FIELD_NUMBER
Field Value
Type Description
int

SERVER_CA_CERTS_FIELD_NUMBER

publicstaticfinalintSERVER_CA_CERTS_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

publicstaticfinalintSTATE_FIELD_NUMBER
Field Value
Type Description
int

STATUS_MESSAGE_FIELD_NUMBER

publicstaticfinalintSTATUS_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

TIER_FIELD_NUMBER

publicstaticfinalintTIER_FIELD_NUMBER
Field Value
Type Description
int

TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER

publicstaticfinalintTRANSIT_ENCRYPTION_MODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticInstancegetDefaultInstance()
Returns
Type Description
Instance

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticInstance.BuildernewBuilder()
Returns
Type Description
Instance.Builder

newBuilder(Instance prototype)

publicstaticInstance.BuildernewBuilder(Instanceprototype)
Parameter
Name Description
prototype Instance
Returns
Type Description
Instance.Builder

parseDelimitedFrom(InputStream input)

publicstaticInstanceparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticInstanceparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticInstanceparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticInstanceparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticInstanceparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticInstanceparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<Instance>parser()
Returns
Type Description
Parser<Instance>

Methods

containsLabels(String key)

publicbooleancontainsLabels(Stringkey)

Resource labels to represent user provided metadata

map<string, string> labels = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsRedisConfigs(String key)

publicbooleancontainsRedisConfigs(Stringkey)

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)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAlternativeLocationId()

publicStringgetAlternativeLocationId()

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

publicByteStringgetAlternativeLocationIdBytes()

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
ByteString

The bytes for alternativeLocationId.

getAuthEnabled()

publicbooleangetAuthEnabled()

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

publicStringgetAuthorizedNetwork()

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

publicByteStringgetAuthorizedNetworkBytes()

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

publicInstance.ConnectModegetConnectMode()

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

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

Returns
Type Description
Instance.ConnectMode

The connectMode.

getConnectModeValue()

publicintgetConnectModeValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for connectMode.

getCreateTime()

publicTimestampgetCreateTime()

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

publicTimestampOrBuildergetCreateTimeOrBuilder()

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

publicStringgetCurrentLocationId()

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

publicByteStringgetCurrentLocationIdBytes()

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
ByteString

The bytes for currentLocationId.

getDefaultInstanceForType()

publicInstancegetDefaultInstanceForType()
Returns
Type Description
Instance

getDisplayName()

publicStringgetDisplayName()

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

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

publicByteStringgetDisplayNameBytes()

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

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getHost()

publicStringgetHost()

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

publicByteStringgetHostBytes()

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

publicMap<String,String>getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

publicintgetLabelsCount()

Resource labels to represent user provided metadata

map<string, string> labels = 3;

Returns
Type Description
int

getLabelsMap()

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

publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

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)

publicStringgetLabelsOrThrow(Stringkey)

Resource labels to represent user provided metadata

map<string, string> labels = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getLocationId()

publicStringgetLocationId()

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

publicByteStringgetLocationIdBytes()

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
ByteString

The bytes for locationId.

getMaintenancePolicy()

publicMaintenancePolicygetMaintenancePolicy()

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

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

Returns
Type Description
MaintenancePolicy

The maintenancePolicy.

getMaintenancePolicyOrBuilder()

publicMaintenancePolicyOrBuildergetMaintenancePolicyOrBuilder()

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

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

Returns
Type Description
MaintenancePolicyOrBuilder

getMaintenanceSchedule()

publicMaintenanceSchedulegetMaintenanceSchedule()

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

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

Returns
Type Description
MaintenanceSchedule

The maintenanceSchedule.

getMaintenanceScheduleOrBuilder()

publicMaintenanceScheduleOrBuildergetMaintenanceScheduleOrBuilder()

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

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

Returns
Type Description
MaintenanceScheduleOrBuilder

getMemorySizeGb()

publicintgetMemorySizeGb()

Required. Redis memory size in GiB.

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

Returns
Type Description
int

The memorySizeGb.

getName()

publicStringgetName()

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

publicByteStringgetNameBytes()

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
ByteString

The bytes for name.

getNodes(int index)

publicNodeInfogetNodes(intindex)

Output only. Info per node.

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

Parameter
Name Description
index int
Returns
Type Description
NodeInfo

getNodesCount()

publicintgetNodesCount()

Output only. Info per node.

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

Returns
Type Description
int

getNodesList()

publicList<NodeInfo>getNodesList()

Output only. Info per node.

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

Returns
Type Description
List<NodeInfo>

getNodesOrBuilder(int index)

publicNodeInfoOrBuildergetNodesOrBuilder(intindex)

Output only. Info per node.

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

Parameter
Name Description
index int
Returns
Type Description
NodeInfoOrBuilder

getNodesOrBuilderList()

publicList<?extendsNodeInfoOrBuilder>getNodesOrBuilderList()

Output only. Info per node.

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

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

getParserForType()

publicParser<Instance>getParserForType()
Returns
Type Description
Parser<Instance>
Overrides

getPersistenceConfig()

publicPersistenceConfiggetPersistenceConfig()

Optional. Persistence configuration parameters

.google.cloud.redis.v1beta1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PersistenceConfig

The persistenceConfig.

getPersistenceConfigOrBuilder()

publicPersistenceConfigOrBuildergetPersistenceConfigOrBuilder()

Optional. Persistence configuration parameters

.google.cloud.redis.v1beta1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PersistenceConfigOrBuilder

getPersistenceIamIdentity()

publicStringgetPersistenceIamIdentity()

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

publicByteStringgetPersistenceIamIdentityBytes()

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
ByteString

The bytes for persistenceIamIdentity.

getPort()

publicintgetPort()

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

publicStringgetReadEndpoint()

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

publicByteStringgetReadEndpointBytes()

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
ByteString

The bytes for readEndpoint.

getReadEndpointPort()

publicintgetReadEndpointPort()

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

publicInstance.ReadReplicasModegetReadReplicasMode()

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

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

Returns
Type Description
Instance.ReadReplicasMode

The readReplicasMode.

getReadReplicasModeValue()

publicintgetReadReplicasModeValue()

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

.google.cloud.redis.v1beta1.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() (deprecated)

publicMap<String,String>getRedisConfigs()

Use #getRedisConfigsMap() instead.

Returns
Type Description
Map<String,String>

getRedisConfigsCount()

publicintgetRedisConfigsCount()

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

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

publicStringgetRedisConfigsOrDefault(Stringkey,StringdefaultValue)

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)

publicStringgetRedisConfigsOrThrow(Stringkey)

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

publicStringgetRedisVersion()

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

publicByteStringgetRedisVersionBytes()

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

publicintgetReplicaCount()

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

publicStringgetReservedIpRange()

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

publicByteStringgetReservedIpRangeBytes()

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
ByteString

The bytes for reservedIpRange.

getSecondaryIpRange()

publicStringgetSecondaryIpRange()

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

publicByteStringgetSecondaryIpRangeBytes()

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
ByteString

The bytes for secondaryIpRange.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getServerCaCerts(int index)

publicTlsCertificategetServerCaCerts(intindex)

Output only. List of server CA certificates for the instance.

repeated .google.cloud.redis.v1beta1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
TlsCertificate

getServerCaCertsCount()

publicintgetServerCaCertsCount()

Output only. List of server CA certificates for the instance.

repeated .google.cloud.redis.v1beta1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getServerCaCertsList()

publicList<TlsCertificate>getServerCaCertsList()

Output only. List of server CA certificates for the instance.

repeated .google.cloud.redis.v1beta1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<TlsCertificate>

getServerCaCertsOrBuilder(int index)

publicTlsCertificateOrBuildergetServerCaCertsOrBuilder(intindex)

Output only. List of server CA certificates for the instance.

repeated .google.cloud.redis.v1beta1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
TlsCertificateOrBuilder

getServerCaCertsOrBuilderList()

publicList<?extendsTlsCertificateOrBuilder>getServerCaCertsOrBuilderList()

Output only. List of server CA certificates for the instance.

repeated .google.cloud.redis.v1beta1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.redis.v1beta1.TlsCertificateOrBuilder>

getState()

publicInstance.StategetState()

Output only. The current state of this instance.

.google.cloud.redis.v1beta1.Instance.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.State

The state.

getStateValue()

publicintgetStateValue()

Output only. The current state of this instance.

.google.cloud.redis.v1beta1.Instance.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getStatusMessage()

publicStringgetStatusMessage()

Output only. Additional information about the current status of this instance, if available.

string status_message = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The statusMessage.

getStatusMessageBytes()

publicByteStringgetStatusMessageBytes()

Output only. Additional information about the current status of this instance, if available.

string status_message = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for statusMessage.

getTier()

publicInstance.TiergetTier()

Required. The service tier of the instance.

.google.cloud.redis.v1beta1.Instance.Tier tier = 17 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Instance.Tier

The tier.

getTierValue()

publicintgetTierValue()

Required. The service tier of the instance.

.google.cloud.redis.v1beta1.Instance.Tier tier = 17 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for tier.

getTransitEncryptionMode()

publicInstance.TransitEncryptionModegetTransitEncryptionMode()

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

.google.cloud.redis.v1beta1.Instance.TransitEncryptionMode transit_encryption_mode = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.TransitEncryptionMode

The transitEncryptionMode.

getTransitEncryptionModeValue()

publicintgetTransitEncryptionModeValue()

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

.google.cloud.redis.v1beta1.Instance.TransitEncryptionMode transit_encryption_mode = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for transitEncryptionMode.

hasCreateTime()

publicbooleanhasCreateTime()

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

publicbooleanhasMaintenancePolicy()

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

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

Returns
Type Description
boolean

Whether the maintenancePolicy field is set.

hasMaintenanceSchedule()

publicbooleanhasMaintenanceSchedule()

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

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

Returns
Type Description
boolean

Whether the maintenanceSchedule field is set.

hasPersistenceConfig()

publicbooleanhasPersistenceConfig()

Optional. Persistence configuration parameters

.google.cloud.redis.v1beta1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the persistenceConfig field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicInstance.BuildernewBuilderForType()
Returns
Type Description
Instance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedInstance.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Instance.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicInstance.BuildertoBuilder()
Returns
Type Description
Instance.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.