Class Instance.Builder (2.45.0) 

public static final class Instance.Builder extends GeneratedMessageV3.Builder<Instance.Builder> implements InstanceOrBuilder

A Memorystore for Redis instance.

Protobuf type google.cloud.redis.v1.Instance

Inheritance

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

Implements

InstanceOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAvailableMaintenanceVersions(Iterable<String> values)

public Instance.Builder addAllAvailableMaintenanceVersions(Iterable<String> values)

Optional. The available maintenance versions that an instance could update to.

repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The availableMaintenanceVersions to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addAllNodes(Iterable<? extends NodeInfo> values)

public Instance.Builder addAllNodes(Iterable<? extends NodeInfo> values)

Output only. Info per node.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.redis.v1.NodeInfo>
Returns
Type Description
Instance.Builder

addAllServerCaCerts(Iterable<? extends TlsCertificate> values)

public Instance.Builder addAllServerCaCerts(Iterable<? extends TlsCertificate> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.redis.v1.TlsCertificate>
Returns
Type Description
Instance.Builder

addAllSuspensionReasons(Iterable<? extends Instance.SuspensionReason> values)

public Instance.Builder addAllSuspensionReasons(Iterable<? extends Instance.SuspensionReason> values)

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.redis.v1.Instance.SuspensionReason>

The suspensionReasons to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addAllSuspensionReasonsValue(Iterable<Integer> values)

public Instance.Builder addAllSuspensionReasonsValue(Iterable<Integer> values)

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for suspensionReasons to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addAvailableMaintenanceVersions(String value)

public Instance.Builder addAvailableMaintenanceVersions(String value)

Optional. The available maintenance versions that an instance could update to.

repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The availableMaintenanceVersions to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addAvailableMaintenanceVersionsBytes(ByteString value)

public Instance.Builder addAvailableMaintenanceVersionsBytes(ByteString value)

Optional. The available maintenance versions that an instance could update to.

repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the availableMaintenanceVersions to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addNodes(NodeInfo value)

public Instance.Builder addNodes(NodeInfo value)

Output only. Info per node.

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

Parameter
Name Description
value NodeInfo
Returns
Type Description
Instance.Builder

addNodes(NodeInfo.Builder builderForValue)

public Instance.Builder addNodes(NodeInfo.Builder builderForValue)

Output only. Info per node.

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

Parameter
Name Description
builderForValue NodeInfo.Builder
Returns
Type Description
Instance.Builder

addNodes(int index, NodeInfo value)

public Instance.Builder addNodes(int index, NodeInfo value)

Output only. Info per node.

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

Parameters
Name Description
index int
value NodeInfo
Returns
Type Description
Instance.Builder

addNodes(int index, NodeInfo.Builder builderForValue)

public Instance.Builder addNodes(int index, NodeInfo.Builder builderForValue)

Output only. Info per node.

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

Parameters
Name Description
index int
builderForValue NodeInfo.Builder
Returns
Type Description
Instance.Builder

addNodesBuilder()

public NodeInfo.Builder addNodesBuilder()

Output only. Info per node.

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

Returns
Type Description
NodeInfo.Builder

addNodesBuilder(int index)

public NodeInfo.Builder addNodesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Instance.Builder
Overrides

addServerCaCerts(TlsCertificate value)

public Instance.Builder addServerCaCerts(TlsCertificate value)

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

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

Parameter
Name Description
value TlsCertificate
Returns
Type Description
Instance.Builder

addServerCaCerts(TlsCertificate.Builder builderForValue)

public Instance.Builder addServerCaCerts(TlsCertificate.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue TlsCertificate.Builder
Returns
Type Description
Instance.Builder

addServerCaCerts(int index, TlsCertificate value)

public Instance.Builder addServerCaCerts(int index, TlsCertificate value)

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

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

Parameters
Name Description
index int
value TlsCertificate
Returns
Type Description
Instance.Builder

addServerCaCerts(int index, TlsCertificate.Builder builderForValue)

public Instance.Builder addServerCaCerts(int index, TlsCertificate.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue TlsCertificate.Builder
Returns
Type Description
Instance.Builder

addServerCaCertsBuilder()

public TlsCertificate.Builder addServerCaCertsBuilder()

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

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

Returns
Type Description
TlsCertificate.Builder

addServerCaCertsBuilder(int index)

public TlsCertificate.Builder addServerCaCertsBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
TlsCertificate.Builder

addSuspensionReasons(Instance.SuspensionReason value)

public Instance.Builder addSuspensionReasons(Instance.SuspensionReason value)

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Instance.SuspensionReason

The suspensionReasons to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addSuspensionReasonsValue(int value)

public Instance.Builder addSuspensionReasonsValue(int value)

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for suspensionReasons to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

build()

public Instance build()
Returns
Type Description
Instance

buildPartial()

public Instance buildPartial()
Returns
Type Description
Instance

clear()

public Instance.Builder clear()
Returns
Type Description
Instance.Builder
Overrides

clearAlternativeLocationId()

public Instance.Builder clearAlternativeLocationId()

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
Instance.Builder

This builder for chaining.

clearAuthEnabled()

public Instance.Builder clearAuthEnabled()

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
Instance.Builder

This builder for chaining.

clearAuthorizedNetwork()

public Instance.Builder clearAuthorizedNetwork()

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
Instance.Builder

This builder for chaining.

clearAvailableMaintenanceVersions()

public Instance.Builder clearAvailableMaintenanceVersions()

Optional. The available maintenance versions that an instance could update to.

repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearConnectMode()

public Instance.Builder clearConnectMode()

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.Builder

This builder for chaining.

clearCreateTime()

public Instance.Builder clearCreateTime()

Output only. The time the instance was created.

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

Returns
Type Description
Instance.Builder

clearCurrentLocationId()

public Instance.Builder clearCurrentLocationId()

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
Instance.Builder

This builder for chaining.

clearCustomerManagedKey()

public Instance.Builder clearCustomerManagedKey()

Optional. The KMS key reference that the customer provides when trying to create the instance.

string customer_managed_key = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearDisplayName()

public Instance.Builder clearDisplayName()

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

string display_name = 2;

Returns
Type Description
Instance.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Instance.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Instance.Builder
Overrides

clearHost()

public Instance.Builder clearHost()

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
Instance.Builder

This builder for chaining.

clearLabels()

public Instance.Builder clearLabels()
Returns
Type Description
Instance.Builder

clearLocationId()

public Instance.Builder clearLocationId()

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
Instance.Builder

This builder for chaining.

clearMaintenancePolicy()

public Instance.Builder clearMaintenancePolicy()

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
Instance.Builder

clearMaintenanceSchedule()

public Instance.Builder clearMaintenanceSchedule()

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
Instance.Builder

clearMaintenanceVersion()

public Instance.Builder clearMaintenanceVersion()

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".

string maintenance_version = 39 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearMemorySizeGb()

public Instance.Builder clearMemorySizeGb()

Required. Redis memory size in GiB.

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

Returns
Type Description
Instance.Builder

This builder for chaining.

clearName()

public Instance.Builder clearName()

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
Instance.Builder

This builder for chaining.

clearNodes()

public Instance.Builder clearNodes()

Output only. Info per node.

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

Returns
Type Description
Instance.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Instance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Instance.Builder
Overrides

clearPersistenceConfig()

public Instance.Builder clearPersistenceConfig()

Optional. Persistence configuration parameters

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

Returns
Type Description
Instance.Builder

clearPersistenceIamIdentity()

public Instance.Builder clearPersistenceIamIdentity()

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
Instance.Builder

This builder for chaining.

clearPort()

public Instance.Builder clearPort()

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

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

Returns
Type Description
Instance.Builder

This builder for chaining.

clearReadEndpoint()

public Instance.Builder clearReadEndpoint()

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
Instance.Builder

This builder for chaining.

clearReadEndpointPort()

public Instance.Builder clearReadEndpointPort()

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
Instance.Builder

This builder for chaining.

clearReadReplicasMode()

public Instance.Builder clearReadReplicasMode()

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.Builder

This builder for chaining.

clearRedisConfigs()

public Instance.Builder clearRedisConfigs()
Returns
Type Description
Instance.Builder

clearRedisVersion()

public Instance.Builder clearRedisVersion()

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
Instance.Builder

This builder for chaining.

clearReplicaCount()

public Instance.Builder clearReplicaCount()

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
Instance.Builder

This builder for chaining.

clearReservedIpRange()

public Instance.Builder clearReservedIpRange()

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
Instance.Builder

This builder for chaining.

clearSecondaryIpRange()

public Instance.Builder clearSecondaryIpRange()

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
Instance.Builder

This builder for chaining.

clearServerCaCerts()

public Instance.Builder clearServerCaCerts()

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

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

Returns
Type Description
Instance.Builder

clearState()

public Instance.Builder clearState()

Output only. The current state of this instance.

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

Returns
Type Description
Instance.Builder

This builder for chaining.

clearStatusMessage()

public Instance.Builder clearStatusMessage()

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
Instance.Builder

This builder for chaining.

clearSuspensionReasons()

public Instance.Builder clearSuspensionReasons()

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearTier()

public Instance.Builder clearTier()

Required. The service tier of the instance.

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

Returns
Type Description
Instance.Builder

This builder for chaining.

clearTransitEncryptionMode()

public Instance.Builder clearTransitEncryptionMode()

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

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

Returns
Type Description
Instance.Builder

This builder for chaining.

clone()

public Instance.Builder clone()
Returns
Type Description
Instance.Builder
Overrides

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

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

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

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.

getAvailableMaintenanceVersions(int index)

public String getAvailableMaintenanceVersions(int index)

Optional. The available maintenance versions that an instance could update to.

repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The availableMaintenanceVersions at the given index.

getAvailableMaintenanceVersionsBytes(int index)

public ByteString getAvailableMaintenanceVersionsBytes(int index)

Optional. The available maintenance versions that an instance could update to.

repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the availableMaintenanceVersions at the given index.

getAvailableMaintenanceVersionsCount()

public int getAvailableMaintenanceVersionsCount()

Optional. The available maintenance versions that an instance could update to.

repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of availableMaintenanceVersions.

getAvailableMaintenanceVersionsList()

public ProtocolStringList getAvailableMaintenanceVersionsList()

Optional. The available maintenance versions that an instance could update to.

repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the availableMaintenanceVersions.

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time the instance was created.

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

Returns
Type Description
Builder

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

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.

getCustomerManagedKey()

public String getCustomerManagedKey()

Optional. The KMS key reference that the customer provides when trying to create the instance.

string customer_managed_key = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The customerManagedKey.

getCustomerManagedKeyBytes()

public ByteString getCustomerManagedKeyBytes()

Optional. The KMS key reference that the customer provides when trying to create the instance.

string customer_managed_key = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for customerManagedKey.

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
Type Description
Instance

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

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

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

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.

getMaintenancePolicyBuilder()

public MaintenancePolicy.Builder getMaintenancePolicyBuilder()

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.Builder

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.

getMaintenanceScheduleBuilder()

public MaintenanceSchedule.Builder getMaintenanceScheduleBuilder()

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.Builder

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

getMaintenanceVersion()

public String getMaintenanceVersion()

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".

string maintenance_version = 39 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The maintenanceVersion.

getMaintenanceVersionBytes()

public ByteString getMaintenanceVersionBytes()

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".

string maintenance_version = 39 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for maintenanceVersion.

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.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableRedisConfigs() (deprecated)

public Map<String,String> getMutableRedisConfigs()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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

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)

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

getNodesBuilder(int index)

public NodeInfo.Builder getNodesBuilder(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.Builder

getNodesBuilderList()

public List<NodeInfo.Builder> getNodesBuilderList()

Output only. Info per node.

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

Returns
Type Description
List<Builder>

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>

getPersistenceConfig()

public PersistenceConfig getPersistenceConfig()

Optional. Persistence configuration parameters

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

Returns
Type Description
PersistenceConfig

The persistenceConfig.

getPersistenceConfigBuilder()

public PersistenceConfig.Builder getPersistenceConfigBuilder()

Optional. Persistence configuration parameters

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

Returns
Type Description
PersistenceConfig.Builder

getPersistenceConfigOrBuilder()

public PersistenceConfigOrBuilder getPersistenceConfigOrBuilder()

Optional. Persistence configuration parameters

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

Returns
Type Description
PersistenceConfigOrBuilder

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

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

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

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

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

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

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

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

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.

getServerCaCerts(int index)

public TlsCertificate getServerCaCerts(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
TlsCertificate

getServerCaCertsBuilder(int index)

public TlsCertificate.Builder getServerCaCertsBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
TlsCertificate.Builder

getServerCaCertsBuilderList()

public List<TlsCertificate.Builder> getServerCaCertsBuilderList()

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

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

Returns
Type Description
List<Builder>

getServerCaCertsCount()

public int getServerCaCertsCount()

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

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

Returns
Type Description
int

getServerCaCertsList()

public List<TlsCertificate> getServerCaCertsList()

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

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

Returns
Type Description
List<TlsCertificate>

getServerCaCertsOrBuilder(int index)

public TlsCertificateOrBuilder getServerCaCertsOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
TlsCertificateOrBuilder

getServerCaCertsOrBuilderList()

public List<? extends TlsCertificateOrBuilder> getServerCaCertsOrBuilderList()

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

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

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

getState()

public Instance.State getState()

Output only. The current state of this instance.

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

Returns
Type Description
Instance.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of this instance.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getStatusMessage()

public String getStatusMessage()

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

public ByteString getStatusMessageBytes()

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.

getSuspensionReasons(int index)

public Instance.SuspensionReason getSuspensionReasons(int index)

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
Instance.SuspensionReason

The suspensionReasons at the given index.

getSuspensionReasonsCount()

public int getSuspensionReasonsCount()

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of suspensionReasons.

getSuspensionReasonsList()

public List<Instance.SuspensionReason> getSuspensionReasonsList()

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SuspensionReason>

A list containing the suspensionReasons.

getSuspensionReasonsValue(int index)

public int getSuspensionReasonsValue(int index)

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of suspensionReasons at the given index.

getSuspensionReasonsValueList()

public List<Integer> getSuspensionReasonsValueList()

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for suspensionReasons.

getTier()

public Instance.Tier getTier()

Required. The service tier of the instance.

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

Returns
Type Description
Instance.Tier

The tier.

getTierValue()

public int getTierValue()

Required. The service tier of the instance.

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

Returns
Type Description
int

The enum numeric value on the wire for tier.

getTransitEncryptionMode()

public Instance.TransitEncryptionMode getTransitEncryptionMode()

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

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

Returns
Type Description
Instance.TransitEncryptionMode

The transitEncryptionMode.

getTransitEncryptionModeValue()

public int getTransitEncryptionModeValue()

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

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

public 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 boolean hasMaintenancePolicy()

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
boolean

Whether the maintenancePolicy field is set.

hasMaintenanceSchedule()

public boolean hasMaintenanceSchedule()

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
boolean

Whether the maintenanceSchedule field is set.

hasPersistenceConfig()

public boolean hasPersistenceConfig()

Optional. Persistence configuration parameters

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

Returns
Type Description
boolean

Whether the persistenceConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

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

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Instance.Builder mergeCreateTime(Timestamp value)

Output only. The time the instance was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

mergeFrom(Instance other)

public Instance.Builder mergeFrom(Instance other)
Parameter
Name Description
other Instance
Returns
Type Description
Instance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Instance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Instance.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Instance.Builder
Overrides

mergeMaintenancePolicy(MaintenancePolicy value)

public Instance.Builder mergeMaintenancePolicy(MaintenancePolicy value)

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];

Parameter
Name Description
value MaintenancePolicy
Returns
Type Description
Instance.Builder

mergeMaintenanceSchedule(MaintenanceSchedule value)

public Instance.Builder mergeMaintenanceSchedule(MaintenanceSchedule value)

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];

Parameter
Name Description
value MaintenanceSchedule
Returns
Type Description
Instance.Builder

mergePersistenceConfig(PersistenceConfig value)

public Instance.Builder mergePersistenceConfig(PersistenceConfig value)

Optional. Persistence configuration parameters

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

Parameter
Name Description
value PersistenceConfig
Returns
Type Description
Instance.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Instance.Builder
Overrides

putAllLabels(Map<String,String> values)

public Instance.Builder putAllLabels(Map<String,String> values)

Resource labels to represent user provided metadata

map<string, string> labels = 3;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Instance.Builder

putAllRedisConfigs(Map<String,String> values)

public Instance.Builder putAllRedisConfigs(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
Instance.Builder

putLabels(String key, String value)

public Instance.Builder putLabels(String key, String value)

Resource labels to represent user provided metadata

map<string, string> labels = 3;

Parameters
Name Description
key String
value String
Returns
Type Description
Instance.Builder

putRedisConfigs(String key, String value)

public Instance.Builder putRedisConfigs(String key, String value)

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
value String
Returns
Type Description
Instance.Builder

removeLabels(String key)

public Instance.Builder removeLabels(String key)

Resource labels to represent user provided metadata

map<string, string> labels = 3;

Parameter
Name Description
key String
Returns
Type Description
Instance.Builder

removeNodes(int index)

public Instance.Builder removeNodes(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
Instance.Builder

removeRedisConfigs(String key)

public Instance.Builder removeRedisConfigs(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
Instance.Builder

removeServerCaCerts(int index)

public Instance.Builder removeServerCaCerts(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
Instance.Builder

setAlternativeLocationId(String value)

public Instance.Builder setAlternativeLocationId(String value)

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];

Parameter
Name Description
value String

The alternativeLocationId to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setAlternativeLocationIdBytes(ByteString value)

public Instance.Builder setAlternativeLocationIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for alternativeLocationId to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setAuthEnabled(boolean value)

public Instance.Builder setAuthEnabled(boolean value)

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];

Parameter
Name Description
value boolean

The authEnabled to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setAuthorizedNetwork(String value)

public Instance.Builder setAuthorizedNetwork(String value)

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];

Parameter
Name Description
value String

The authorizedNetwork to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setAuthorizedNetworkBytes(ByteString value)

public Instance.Builder setAuthorizedNetworkBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for authorizedNetwork to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setAvailableMaintenanceVersions(int index, String value)

public Instance.Builder setAvailableMaintenanceVersions(int index, String value)

Optional. The available maintenance versions that an instance could update to.

repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value String

The availableMaintenanceVersions to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setConnectMode(Instance.ConnectMode value)

public Instance.Builder setConnectMode(Instance.ConnectMode value)

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];

Parameter
Name Description
value Instance.ConnectMode

The connectMode to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setConnectModeValue(int value)

public Instance.Builder setConnectModeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for connectMode to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Instance.Builder setCreateTime(Timestamp value)

Output only. The time the instance was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Instance.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time the instance was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Instance.Builder

setCurrentLocationId(String value)

public Instance.Builder setCurrentLocationId(String value)

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];

Parameter
Name Description
value String

The currentLocationId to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setCurrentLocationIdBytes(ByteString value)

public Instance.Builder setCurrentLocationIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for currentLocationId to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setCustomerManagedKey(String value)

public Instance.Builder setCustomerManagedKey(String value)

Optional. The KMS key reference that the customer provides when trying to create the instance.

string customer_managed_key = 36 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The customerManagedKey to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setCustomerManagedKeyBytes(ByteString value)

public Instance.Builder setCustomerManagedKeyBytes(ByteString value)

Optional. The KMS key reference that the customer provides when trying to create the instance.

string customer_managed_key = 36 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for customerManagedKey to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setDisplayName(String value)

public Instance.Builder setDisplayName(String value)

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

string display_name = 2;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Instance.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 2;

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Instance.Builder
Overrides

setHost(String value)

public Instance.Builder setHost(String value)

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];

Parameter
Name Description
value String

The host to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setHostBytes(ByteString value)

public Instance.Builder setHostBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for host to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setLocationId(String value)

public Instance.Builder setLocationId(String value)

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];

Parameter
Name Description
value String

The locationId to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setLocationIdBytes(ByteString value)

public Instance.Builder setLocationIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for locationId to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setMaintenancePolicy(MaintenancePolicy value)

public Instance.Builder setMaintenancePolicy(MaintenancePolicy value)

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];

Parameter
Name Description
value MaintenancePolicy
Returns
Type Description
Instance.Builder

setMaintenancePolicy(MaintenancePolicy.Builder builderForValue)

public Instance.Builder setMaintenancePolicy(MaintenancePolicy.Builder builderForValue)

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];

Parameter
Name Description
builderForValue MaintenancePolicy.Builder
Returns
Type Description
Instance.Builder

setMaintenanceSchedule(MaintenanceSchedule value)

public Instance.Builder setMaintenanceSchedule(MaintenanceSchedule value)

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];

Parameter
Name Description
value MaintenanceSchedule
Returns
Type Description
Instance.Builder

setMaintenanceSchedule(MaintenanceSchedule.Builder builderForValue)

public Instance.Builder setMaintenanceSchedule(MaintenanceSchedule.Builder builderForValue)

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];

Parameter
Name Description
builderForValue MaintenanceSchedule.Builder
Returns
Type Description
Instance.Builder

setMaintenanceVersion(String value)

public Instance.Builder setMaintenanceVersion(String value)

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".

string maintenance_version = 39 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The maintenanceVersion to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setMaintenanceVersionBytes(ByteString value)

public Instance.Builder setMaintenanceVersionBytes(ByteString value)

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".

string maintenance_version = 39 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for maintenanceVersion to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setMemorySizeGb(int value)

public Instance.Builder setMemorySizeGb(int value)

Required. Redis memory size in GiB.

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

Parameter
Name Description
value int

The memorySizeGb to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setName(String value)

public Instance.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Instance.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setNodes(int index, NodeInfo value)

public Instance.Builder setNodes(int index, NodeInfo value)

Output only. Info per node.

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

Parameters
Name Description
index int
value NodeInfo
Returns
Type Description
Instance.Builder

setNodes(int index, NodeInfo.Builder builderForValue)

public Instance.Builder setNodes(int index, NodeInfo.Builder builderForValue)

Output only. Info per node.

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

Parameters
Name Description
index int
builderForValue NodeInfo.Builder
Returns
Type Description
Instance.Builder

setPersistenceConfig(PersistenceConfig value)

public Instance.Builder setPersistenceConfig(PersistenceConfig value)

Optional. Persistence configuration parameters

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

Parameter
Name Description
value PersistenceConfig
Returns
Type Description
Instance.Builder

setPersistenceConfig(PersistenceConfig.Builder builderForValue)

public Instance.Builder setPersistenceConfig(PersistenceConfig.Builder builderForValue)

Optional. Persistence configuration parameters

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

Parameter
Name Description
builderForValue PersistenceConfig.Builder
Returns
Type Description
Instance.Builder

setPersistenceIamIdentity(String value)

public Instance.Builder setPersistenceIamIdentity(String value)

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];

Parameter
Name Description
value String

The persistenceIamIdentity to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setPersistenceIamIdentityBytes(ByteString value)

public Instance.Builder setPersistenceIamIdentityBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for persistenceIamIdentity to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setPort(int value)

public Instance.Builder setPort(int value)

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

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

Parameter
Name Description
value int

The port to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setReadEndpoint(String value)

public Instance.Builder setReadEndpoint(String value)

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];

Parameter
Name Description
value String

The readEndpoint to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setReadEndpointBytes(ByteString value)

public Instance.Builder setReadEndpointBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for readEndpoint to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setReadEndpointPort(int value)

public Instance.Builder setReadEndpointPort(int value)

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];

Parameter
Name Description
value int

The readEndpointPort to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setReadReplicasMode(Instance.ReadReplicasMode value)

public Instance.Builder setReadReplicasMode(Instance.ReadReplicasMode value)

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];

Parameter
Name Description
value Instance.ReadReplicasMode

The readReplicasMode to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setReadReplicasModeValue(int value)

public Instance.Builder setReadReplicasModeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for readReplicasMode to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setRedisVersion(String value)

public Instance.Builder setRedisVersion(String value)

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];

Parameter
Name Description
value String

The redisVersion to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setRedisVersionBytes(ByteString value)

public Instance.Builder setRedisVersionBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for redisVersion to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Instance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Instance.Builder
Overrides

setReplicaCount(int value)

public Instance.Builder setReplicaCount(int value)

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];

Parameter
Name Description
value int

The replicaCount to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setReservedIpRange(String value)

public Instance.Builder setReservedIpRange(String value)

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];

Parameter
Name Description
value String

The reservedIpRange to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setReservedIpRangeBytes(ByteString value)

public Instance.Builder setReservedIpRangeBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for reservedIpRange to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setSecondaryIpRange(String value)

public Instance.Builder setSecondaryIpRange(String value)

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];

Parameter
Name Description
value String

The secondaryIpRange to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setSecondaryIpRangeBytes(ByteString value)

public Instance.Builder setSecondaryIpRangeBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for secondaryIpRange to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setServerCaCerts(int index, TlsCertificate value)

public Instance.Builder setServerCaCerts(int index, TlsCertificate value)

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

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

Parameters
Name Description
index int
value TlsCertificate
Returns
Type Description
Instance.Builder

setServerCaCerts(int index, TlsCertificate.Builder builderForValue)

public Instance.Builder setServerCaCerts(int index, TlsCertificate.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue TlsCertificate.Builder
Returns
Type Description
Instance.Builder

setState(Instance.State value)

public Instance.Builder setState(Instance.State value)

Output only. The current state of this instance.

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

Parameter
Name Description
value Instance.State

The state to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setStateValue(int value)

public Instance.Builder setStateValue(int value)

Output only. The current state of this instance.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setStatusMessage(String value)

public Instance.Builder setStatusMessage(String value)

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

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

Parameter
Name Description
value String

The statusMessage to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setStatusMessageBytes(ByteString value)

public Instance.Builder setStatusMessageBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for statusMessage to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setSuspensionReasons(int index, Instance.SuspensionReason value)

public Instance.Builder setSuspensionReasons(int index, Instance.SuspensionReason value)

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value Instance.SuspensionReason

The suspensionReasons to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setSuspensionReasonsValue(int index, int value)

public Instance.Builder setSuspensionReasonsValue(int index, int value)

Optional. reasons that causes instance in "SUSPENDED" state.

repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for suspensionReasons to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setTier(Instance.Tier value)

public Instance.Builder setTier(Instance.Tier value)

Required. The service tier of the instance.

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

Parameter
Name Description
value Instance.Tier

The tier to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setTierValue(int value)

public Instance.Builder setTierValue(int value)

Required. The service tier of the instance.

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

Parameter
Name Description
value int

The enum numeric value on the wire for tier to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setTransitEncryptionMode(Instance.TransitEncryptionMode value)

public Instance.Builder setTransitEncryptionMode(Instance.TransitEncryptionMode value)

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

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

Parameter
Name Description
value Instance.TransitEncryptionMode

The transitEncryptionMode to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setTransitEncryptionModeValue(int value)

public Instance.Builder setTransitEncryptionModeValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for transitEncryptionMode to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Instance.Builder
Overrides