Class Cluster (0.16.0)

public final class Cluster extends GeneratedMessageV3 implements ClusterOrBuilder

A cluster instance.

Protobuf type google.cloud.redis.cluster.v1.Cluster

Implements

ClusterOrBuilder

Static Fields

AUTHORIZATION_MODE_FIELD_NUMBER

public static final int AUTHORIZATION_MODE_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISCOVERY_ENDPOINTS_FIELD_NUMBER

public static final int DISCOVERY_ENDPOINTS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PSC_CONFIGS_FIELD_NUMBER

public static final int PSC_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

PSC_CONNECTIONS_FIELD_NUMBER

public static final int PSC_CONNECTIONS_FIELD_NUMBER
Field Value
Type Description
int

REPLICA_COUNT_FIELD_NUMBER

public static final int REPLICA_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SHARD_COUNT_FIELD_NUMBER

public static final int SHARD_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SIZE_GB_FIELD_NUMBER

public static final int SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATE_INFO_FIELD_NUMBER

public static final int STATE_INFO_FIELD_NUMBER
Field Value
Type Description
int

TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER

public static final int TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Cluster getDefaultInstance()
Returns
Type Description
Cluster

getDescriptor()

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

newBuilder()

public static Cluster.Builder newBuilder()
Returns
Type Description
Cluster.Builder

newBuilder(Cluster prototype)

public static Cluster.Builder newBuilder(Cluster prototype)
Parameter
Name Description
prototype Cluster
Returns
Type Description
Cluster.Builder

parseDelimitedFrom(InputStream input)

public static Cluster parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Cluster parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Cluster parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Cluster parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Cluster parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Cluster parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Cluster> parser()
Returns
Type Description
Parser<Cluster>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAuthorizationMode()

public AuthorizationMode getAuthorizationMode()

Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

.google.cloud.redis.cluster.v1.AuthorizationMode authorization_mode = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AuthorizationMode

The authorizationMode.

getAuthorizationModeValue()

public int getAuthorizationModeValue()

Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

.google.cloud.redis.cluster.v1.AuthorizationMode authorization_mode = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for authorizationMode.

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp associated with the cluster creation request.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp associated with the cluster creation request.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Cluster getDefaultInstanceForType()
Returns
Type Description
Cluster

getDiscoveryEndpoints(int index)

public DiscoveryEndpoint getDiscoveryEndpoints(int index)

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

repeated .google.cloud.redis.cluster.v1.DiscoveryEndpoint discovery_endpoints = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DiscoveryEndpoint

getDiscoveryEndpointsCount()

public int getDiscoveryEndpointsCount()

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

repeated .google.cloud.redis.cluster.v1.DiscoveryEndpoint discovery_endpoints = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getDiscoveryEndpointsList()

public List<DiscoveryEndpoint> getDiscoveryEndpointsList()

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

repeated .google.cloud.redis.cluster.v1.DiscoveryEndpoint discovery_endpoints = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<DiscoveryEndpoint>

getDiscoveryEndpointsOrBuilder(int index)

public DiscoveryEndpointOrBuilder getDiscoveryEndpointsOrBuilder(int index)

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

repeated .google.cloud.redis.cluster.v1.DiscoveryEndpoint discovery_endpoints = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DiscoveryEndpointOrBuilder

getDiscoveryEndpointsOrBuilderList()

public List<? extends DiscoveryEndpointOrBuilder> getDiscoveryEndpointsOrBuilderList()

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

repeated .google.cloud.redis.cluster.v1.DiscoveryEndpoint discovery_endpoints = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

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}/clusters/{cluster_id}

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}/clusters/{cluster_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Cluster> getParserForType()
Returns
Type Description
Parser<Cluster>
Overrides

getPscConfigs(int index)

public PscConfig getPscConfigs(int index)

Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
PscConfig

getPscConfigsCount()

public int getPscConfigsCount()

Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getPscConfigsList()

public List<PscConfig> getPscConfigsList()

Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<PscConfig>

getPscConfigsOrBuilder(int index)

public PscConfigOrBuilder getPscConfigsOrBuilder(int index)

Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
PscConfigOrBuilder

getPscConfigsOrBuilderList()

public List<? extends PscConfigOrBuilder> getPscConfigsOrBuilderList()

Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];

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

getPscConnections(int index)

public PscConnection getPscConnections(int index)

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PscConnection

getPscConnectionsCount()

public int getPscConnectionsCount()

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getPscConnectionsList()

public List<PscConnection> getPscConnectionsList()

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<PscConnection>

getPscConnectionsOrBuilder(int index)

public PscConnectionOrBuilder getPscConnectionsOrBuilder(int index)

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PscConnectionOrBuilder

getPscConnectionsOrBuilderList()

public List<? extends PscConnectionOrBuilder> getPscConnectionsOrBuilderList()

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getReplicaCount()

public int getReplicaCount()

Optional. The number of replica nodes per shard.

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

Returns
Type Description
int

The replicaCount.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShardCount()

public int getShardCount()

Required. Number of shards for the Redis cluster.

optional int32 shard_count = 14 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The shardCount.

getSizeGb()

public int getSizeGb()

Output only. Redis memory size in GB for the entire cluster.

optional int32 size_gb = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The sizeGb.

getState()

public Cluster.State getState()

Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED

.google.cloud.redis.cluster.v1.Cluster.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.State

The state.

getStateInfo()

public Cluster.StateInfo getStateInfo()

Output only. Additional information about the current state of the cluster.

.google.cloud.redis.cluster.v1.Cluster.StateInfo state_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.StateInfo

The stateInfo.

getStateInfoOrBuilder()

public Cluster.StateInfoOrBuilder getStateInfoOrBuilder()

Output only. Additional information about the current state of the cluster.

.google.cloud.redis.cluster.v1.Cluster.StateInfo state_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.StateInfoOrBuilder

getStateValue()

public int getStateValue()

Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED

.google.cloud.redis.cluster.v1.Cluster.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTransitEncryptionMode()

public TransitEncryptionMode getTransitEncryptionMode()

Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

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

Returns
Type Description
TransitEncryptionMode

The transitEncryptionMode.

getTransitEncryptionModeValue()

public int getTransitEncryptionModeValue()

Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

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

Returns
Type Description
int

The enum numeric value on the wire for transitEncryptionMode.

getUid()

public String getUid()

Output only. System assigned, unique identifier for the cluster.

string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. System assigned, unique identifier for the cluster.

string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp associated with the cluster creation request.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasReplicaCount()

public boolean hasReplicaCount()

Optional. The number of replica nodes per shard.

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

Returns
Type Description
boolean

Whether the replicaCount field is set.

hasShardCount()

public boolean hasShardCount()

Required. Number of shards for the Redis cluster.

optional int32 shard_count = 14 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the shardCount field is set.

hasSizeGb()

public boolean hasSizeGb()

Output only. Redis memory size in GB for the entire cluster.

optional int32 size_gb = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the sizeGb field is set.

hasStateInfo()

public boolean hasStateInfo()

Output only. Additional information about the current state of the cluster.

.google.cloud.redis.cluster.v1.Cluster.StateInfo state_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the stateInfo field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Cluster.Builder newBuilderForType()
Returns
Type Description
Cluster.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Cluster.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Cluster.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Cluster.Builder toBuilder()
Returns
Type Description
Cluster.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException