Class: Google::Apis::RedisV1::Cluster

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/redis_v1/classes.rb,
lib/google/apis/redis_v1/representations.rb,
lib/google/apis/redis_v1/representations.rb

Overview

A cluster instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Cluster

Returns a new instance of Cluster.



98
99
100
 
# File 'lib/google/apis/redis_v1/classes.rb', line 98

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cluster_uid ⇒ String

Output only. UID of the cluster for use by Pantheon for analytics. Corresponds to the JSON property clusterUid

Returns:

  • (String) 


32
33
34
 
# File 'lib/google/apis/redis_v1/classes.rb', line 32

def cluster_uid
  @cluster_uid
end

#create_time ⇒ String

Output only. The timestamp associated with the cluster creation request. Corresponds to the JSON property createTime

Returns:

  • (String) 


37
38
39
 
# File 'lib/google/apis/redis_v1/classes.rb', line 37

def create_time
  @create_time
end

#customer_managed_key ⇒ String

Input only. The KMS key reference that the customer provides when trying to create the instance. Corresponds to the JSON property customerManagedKey

Returns:

  • (String) 


43
44
45
 
# File 'lib/google/apis/redis_v1/classes.rb', line 43

def customer_managed_key
  @customer_managed_key
end

#default_replica_count ⇒ Fixnum

Optional. The number of replica nodes per shard. Valid range is [1-2] and defaults to 1. Corresponds to the JSON property defaultReplicaCount

Returns:

  • (Fixnum) 


49
50
51
 
# File 'lib/google/apis/redis_v1/classes.rb', line 49

def default_replica_count
  @default_replica_count
end

#display_name ⇒ String

Optional. An arbitrary and optional user-provided name for the cluster. Corresponds to the JSON property displayName

Returns:

  • (String) 


54
55
56
 
# File 'lib/google/apis/redis_v1/classes.rb', line 54

def display_name
  @display_name
end

#endpoints ⇒ Array<Google::Apis::RedisV1::Endpoint>

Output only. Hostname or IP address and port pairs used to connect to the cluster. Corresponds to the JSON property endpoints

Returns:



60
61
62
 
# File 'lib/google/apis/redis_v1/classes.rb', line 60

def endpoints
  @endpoints
end

#name ⇒ 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` Corresponds to the JSON propertyname`

Returns:

  • (String) 


67
68
69
 
# File 'lib/google/apis/redis_v1/classes.rb', line 67

def name
  @name
end

#private_service_connect ⇒ Google::Apis::RedisV1::PrivateServiceConnect

Contains private service connect specific options. Corresponds to the JSON property privateServiceConnect

Returns:



72
73
74
 
# File 'lib/google/apis/redis_v1/classes.rb', line 72

def private_service_connect
  @private_service_connect
end

#redis_configs ⇒ Hash<String,String>

Optional. Redis configuration parameters, according to http://redis.io/topics/ config. Currently, the only supported parameters are: Redis version 6.x and newer: * lfu-decay-time * lfu-log-factor * maxmemory-policy Corresponds to the JSON property redisConfigs

Returns:

  • (Hash<String,String>) 


79
80
81
 
# File 'lib/google/apis/redis_v1/classes.rb', line 79

def redis_configs
  @redis_configs
end

#slots ⇒ Array<Google::Apis::RedisV1::ClusterSlots>

Output only. The slots making up the cluster. Read-only. In future versions this will be writable to allow for heterogeneous clusters. Corresponds to the JSON property slots

Returns:



85
86
87
 
# File 'lib/google/apis/redis_v1/classes.rb', line 85

def slots
  @slots
end

#state ⇒ String

Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED Corresponds to the JSON property state

Returns:

  • (String) 


91
92
93
 
# File 'lib/google/apis/redis_v1/classes.rb', line 91

def state
  @state
end

#total_memory_size_gb ⇒ Fixnum

Optional. Redis memory size in GiB for the entire cluster. Defaults to 32. Corresponds to the JSON property totalMemorySizeGb

Returns:

  • (Fixnum) 


96
97
98
 
# File 'lib/google/apis/redis_v1/classes.rb', line 96

def total_memory_size_gb
  @total_memory_size_gb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/google/apis/redis_v1/classes.rb', line 103

def update!(**args)
  @cluster_uid = args[:cluster_uid] if args.key?(:cluster_uid)
  @create_time = args[:create_time] if args.key?(:create_time)
  @customer_managed_key = args[:customer_managed_key] if args.key?(:customer_managed_key)
  @default_replica_count = args[:default_replica_count] if args.key?(:default_replica_count)
  @display_name = args[:display_name] if args.key?(:display_name)
  @endpoints = args[:endpoints] if args.key?(:endpoints)
  @name = args[:name] if args.key?(:name)
  @private_service_connect = args[:private_service_connect] if args.key?(:private_service_connect)
  @redis_configs = args[:redis_configs] if args.key?(:redis_configs)
  @slots = args[:slots] if args.key?(:slots)
  @state = args[:state] if args.key?(:state)
  @total_memory_size_gb = args[:total_memory_size_gb] if args.key?(:total_memory_size_gb)
end