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

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

#authorization_mode=

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

#create_time

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

#deletion_protection_enabled

def deletion_protection_enabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. The delete operation will fail when the value is set to true.

#deletion_protection_enabled=

def deletion_protection_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. The delete operation will fail when the value is set to true.
Returns
  • (::Boolean) — Optional. The delete operation will fail when the value is set to true.

#discovery_endpoints

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

#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}

#node_type

def node_type() -> ::Google::Cloud::Redis::Cluster::V1::NodeType
Returns

#node_type=

def node_type=(value) -> ::Google::Cloud::Redis::Cluster::V1::NodeType
Parameter
Returns

#persistence_config

def persistence_config() -> ::Google::Cloud::Redis::Cluster::V1::ClusterPersistenceConfig
Returns

#persistence_config=

def persistence_config=(value) -> ::Google::Cloud::Redis::Cluster::V1::ClusterPersistenceConfig
Parameter
Returns

#precise_size_gb

def precise_size_gb() -> ::Float
Returns
  • (::Float) — Output only. Precise value of redis memory size in GB for the entire cluster.

#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

#redis_configs

def redis_configs() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Key/Value pairs of customer overrides for mutable Redis Configs

#redis_configs=

def redis_configs=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Key/Value pairs of customer overrides for mutable Redis Configs
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Key/Value pairs of customer overrides for mutable Redis Configs

#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 rounded up to the next integer.

#state

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

#state_info

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

#transit_encryption_mode

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

#transit_encryption_mode=

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

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. System assigned, unique identifier for the cluster.

#zone_distribution_config

def zone_distribution_config() -> ::Google::Cloud::Redis::Cluster::V1::ZoneDistributionConfig
Returns

#zone_distribution_config=

def zone_distribution_config=(value) -> ::Google::Cloud::Redis::Cluster::V1::ZoneDistributionConfig
Parameter
Returns