Google Cloud Memorystore for Redis V1 API - Class Google::Cloud::Redis::Cluster::V1::Cluster (v0.3.0)

Reference documentation and code samples for the Google Cloud Memorystore for Redis V1 API class Google::Cloud::Redis::Cluster::V1::Cluster.

A cluster instance.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#authorization_mode

def authorization_mode() -> ::Google::Cloud::Redis::Cluster::V1::AuthorizationMode

Returns

(::Google::Cloud::Redis::Cluster::V1::AuthorizationMode) — Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

#authorization_mode=

def authorization_mode=(value) -> ::Google::Cloud::Redis::Cluster::V1::AuthorizationMode

Parameter

value (::Google::Cloud::Redis::Cluster::V1::AuthorizationMode) — Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

Returns

(::Google::Cloud::Redis::Cluster::V1::AuthorizationMode) — Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp associated with the cluster creation request.

#discovery_endpoints

def discovery_endpoints() -> ::Array<::Google::Cloud::Redis::Cluster::V1::DiscoveryEndpoint>

Returns

(::Array<::Google::Cloud::Redis::Cluster::V1::DiscoveryEndpoint>) — Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

#name

def name() -> ::String

Returns

(::String) — 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}

#name=

def name=(value) -> ::String

Parameter

value (::String) — 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}

Returns

(::String) — 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}

#psc_configs

def psc_configs() -> ::Array<::Google::Cloud::Redis::Cluster::V1::PscConfig>

Returns

(::Array<::Google::Cloud::Redis::Cluster::V1::PscConfig>) — 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.

#psc_configs=

def psc_configs=(value) -> ::Array<::Google::Cloud::Redis::Cluster::V1::PscConfig>

Parameter

value (::Array<::Google::Cloud::Redis::Cluster::V1::PscConfig>) — 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.

Returns

(::Array<::Google::Cloud::Redis::Cluster::V1::PscConfig>) — 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.

#psc_connections

def psc_connections() -> ::Array<::Google::Cloud::Redis::Cluster::V1::PscConnection>

Returns

(::Array<::Google::Cloud::Redis::Cluster::V1::PscConnection>) — Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

#replica_count

def replica_count() -> ::Integer

Returns

(::Integer) — Optional. The number of replica nodes per shard.

#replica_count=

def replica_count=(value) -> ::Integer

Parameter

value (::Integer) — Optional. The number of replica nodes per shard.

Returns

(::Integer) — Optional. The number of replica nodes per shard.

#shard_count

def shard_count() -> ::Integer

Returns

(::Integer) — Required. Number of shards for the Redis cluster.

#shard_count=

def shard_count=(value) -> ::Integer

Parameter

value (::Integer) — Required. Number of shards for the Redis cluster.

Returns

(::Integer) — Required. Number of shards for the Redis cluster.

#size_gb

def size_gb() -> ::Integer

Returns

(::Integer) — Output only. Redis memory size in GB for the entire cluster.

#state

def state() -> ::Google::Cloud::Redis::Cluster::V1::Cluster::State

Returns

(::Google::Cloud::Redis::Cluster::V1::Cluster::State) — Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED

#state_info

def state_info() -> ::Google::Cloud::Redis::Cluster::V1::Cluster::StateInfo

Returns

(::Google::Cloud::Redis::Cluster::V1::Cluster::StateInfo) — Output only. Additional information about the current state of the cluster.

#transit_encryption_mode

def transit_encryption_mode() -> ::Google::Cloud::Redis::Cluster::V1::TransitEncryptionMode

Returns

(::Google::Cloud::Redis::Cluster::V1::TransitEncryptionMode) — Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

#transit_encryption_mode=

def transit_encryption_mode=(value) -> ::Google::Cloud::Redis::Cluster::V1::TransitEncryptionMode

Parameter

value (::Google::Cloud::Redis::Cluster::V1::TransitEncryptionMode) — Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

Returns

(::Google::Cloud::Redis::Cluster::V1::TransitEncryptionMode) — Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

#uid

def uid() -> ::String

Returns

(::String) — Output only. System assigned, unique identifier for the cluster.