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.



341
342
343
 
# File 'lib/google/apis/redis_v1/classes.rb', line 341

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

Instance Attribute Details

#authorization_mode ⇒ String

Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. Corresponds to the JSON property authorizationMode

Returns:

  • (String) 


223
224
225
 
# File 'lib/google/apis/redis_v1/classes.rb', line 223

def authorization_mode
  @authorization_mode
end

#create_time ⇒ String

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

Returns:

  • (String) 


228
229
230
 
# File 'lib/google/apis/redis_v1/classes.rb', line 228

def create_time
  @create_time
end

#cross_cluster_replication_config ⇒ Google::Apis::RedisV1::CrossClusterReplicationConfig

Cross cluster replication config. Corresponds to the JSON property crossClusterReplicationConfig

Returns:



233
234
235
 
# File 'lib/google/apis/redis_v1/classes.rb', line 233

def cross_cluster_replication_config
  @cross_cluster_replication_config
end

#deletion_protection_enabled ⇒ Boolean Also known as: deletion_protection_enabled?

Optional. The delete operation will fail when the value is set to true. Corresponds to the JSON property deletionProtectionEnabled

Returns:

  • (Boolean) 


238
239
240
 
# File 'lib/google/apis/redis_v1/classes.rb', line 238

def deletion_protection_enabled
  @deletion_protection_enabled
end

#discovery_endpoints ⇒ Array<Google::Apis::RedisV1::DiscoveryEndpoint>

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

Returns:



245
246
247
 
# File 'lib/google/apis/redis_v1/classes.rb', line 245

def discovery_endpoints
  @discovery_endpoints
end

#maintenance_policy ⇒ Google::Apis::RedisV1::ClusterMaintenancePolicy

Maintenance policy per cluster. Corresponds to the JSON property maintenancePolicy

Returns:



250
251
252
 
# File 'lib/google/apis/redis_v1/classes.rb', line 250

def maintenance_policy
  @maintenance_policy
end

#maintenance_schedule ⇒ Google::Apis::RedisV1::ClusterMaintenanceSchedule

Upcoming maitenance schedule. Corresponds to the JSON property maintenanceSchedule

Returns:



255
256
257
 
# File 'lib/google/apis/redis_v1/classes.rb', line 255

def maintenance_schedule
  @maintenance_schedule
end

#name ⇒ String

Required. Identifier. 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) 


262
263
264
 
# File 'lib/google/apis/redis_v1/classes.rb', line 262

def name
  @name
end

#node_type ⇒ String

Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. Corresponds to the JSON property nodeType

Returns:

  • (String) 


268
269
270
 
# File 'lib/google/apis/redis_v1/classes.rb', line 268

def node_type
  @node_type
end

#persistence_config ⇒ Google::Apis::RedisV1::ClusterPersistenceConfig

Configuration of the persistence functionality. Corresponds to the JSON property persistenceConfig

Returns:



273
274
275
 
# File 'lib/google/apis/redis_v1/classes.rb', line 273

def persistence_config
  @persistence_config
end

#precise_size_gb ⇒ Float

Output only. Precise value of redis memory size in GB for the entire cluster. Corresponds to the JSON property preciseSizeGb

Returns:

  • (Float) 


278
279
280
 
# File 'lib/google/apis/redis_v1/classes.rb', line 278

def precise_size_gb
  @precise_size_gb
end

#psc_configs ⇒ Array<Google::Apis::RedisV1::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. Corresponds to the JSON property pscConfigs

Returns:



285
286
287
 
# File 'lib/google/apis/redis_v1/classes.rb', line 285

def psc_configs
  @psc_configs
end

#psc_connections ⇒ Array<Google::Apis::RedisV1::PscConnection>

Output only. PSC connections for discovery of the cluster topology and accessing the cluster. Corresponds to the JSON property pscConnections

Returns:



291
292
293
 
# File 'lib/google/apis/redis_v1/classes.rb', line 291

def psc_connections
  @psc_connections
end

#redis_configs ⇒ Hash<String,String>

Optional. Key/Value pairs of customer overrides for mutable Redis Configs Corresponds to the JSON property redisConfigs

Returns:

  • (Hash<String,String>) 


296
297
298
 
# File 'lib/google/apis/redis_v1/classes.rb', line 296

def redis_configs
  @redis_configs
end

#replica_count ⇒ Fixnum

Optional. The number of replica nodes per shard. Corresponds to the JSON property replicaCount

Returns:

  • (Fixnum) 


301
302
303
 
# File 'lib/google/apis/redis_v1/classes.rb', line 301

def replica_count
  @replica_count
end

#shard_count ⇒ Fixnum

Optional. Number of shards for the Redis cluster. Corresponds to the JSON property shardCount

Returns:

  • (Fixnum) 


306
307
308
 
# File 'lib/google/apis/redis_v1/classes.rb', line 306

def shard_count
  @shard_count
end

#size_gb ⇒ Fixnum

Output only. Redis memory size in GB for the entire cluster rounded up to the next integer. Corresponds to the JSON property sizeGb

Returns:

  • (Fixnum) 


312
313
314
 
# File 'lib/google/apis/redis_v1/classes.rb', line 312

def size_gb
  @size_gb
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) 


318
319
320
 
# File 'lib/google/apis/redis_v1/classes.rb', line 318

def state
  @state
end

#state_info ⇒ Google::Apis::RedisV1::StateInfo

Represents additional information about the state of the cluster. Corresponds to the JSON property stateInfo

Returns:



323
324
325
 
# File 'lib/google/apis/redis_v1/classes.rb', line 323

def state_info
  @state_info
end

#transit_encryption_mode ⇒ String

Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. Corresponds to the JSON property transitEncryptionMode

Returns:

  • (String) 


329
330
331
 
# File 'lib/google/apis/redis_v1/classes.rb', line 329

def transit_encryption_mode
  @transit_encryption_mode
end

#uid ⇒ String

Output only. System assigned, unique identifier for the cluster. Corresponds to the JSON property uid

Returns:

  • (String) 


334
335
336
 
# File 'lib/google/apis/redis_v1/classes.rb', line 334

def uid
  @uid
end

#zone_distribution_config ⇒ Google::Apis::RedisV1::ZoneDistributionConfig

Zone distribution config for allocation of cluster resources. Corresponds to the JSON property zoneDistributionConfig

Returns:



339
340
341
 
# File 'lib/google/apis/redis_v1/classes.rb', line 339

def zone_distribution_config
  @zone_distribution_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/google/apis/redis_v1/classes.rb', line 346

def update!(**args)
  @authorization_mode = args[:authorization_mode] if args.key?(:authorization_mode)
  @create_time = args[:create_time] if args.key?(:create_time)
  @cross_cluster_replication_config = args[:cross_cluster_replication_config] if args.key?(:cross_cluster_replication_config)
  @deletion_protection_enabled = args[:deletion_protection_enabled] if args.key?(:deletion_protection_enabled)
  @discovery_endpoints = args[:discovery_endpoints] if args.key?(:discovery_endpoints)
  @maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy)
  @maintenance_schedule = args[:maintenance_schedule] if args.key?(:maintenance_schedule)
  @name = args[:name] if args.key?(:name)
  @node_type = args[:node_type] if args.key?(:node_type)
  @persistence_config = args[:persistence_config] if args.key?(:persistence_config)
  @precise_size_gb = args[:precise_size_gb] if args.key?(:precise_size_gb)
  @psc_configs = args[:psc_configs] if args.key?(:psc_configs)
  @psc_connections = args[:psc_connections] if args.key?(:psc_connections)
  @redis_configs = args[:redis_configs] if args.key?(:redis_configs)
  @replica_count = args[:replica_count] if args.key?(:replica_count)
  @shard_count = args[:shard_count] if args.key?(:shard_count)
  @size_gb = args[:size_gb] if args.key?(:size_gb)
  @state = args[:state] if args.key?(:state)
  @state_info = args[:state_info] if args.key?(:state_info)
  @transit_encryption_mode = args[:transit_encryption_mode] if args.key?(:transit_encryption_mode)
  @uid = args[:uid] if args.key?(:uid)
  @zone_distribution_config = args[:zone_distribution_config] if args.key?(:zone_distribution_config)
end