Class: Google::Apis::RedisV1beta1::Cluster

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/redis_v1beta1/classes.rb,
lib/google/apis/redis_v1beta1/representations.rb,
lib/google/apis/redis_v1beta1/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.



591
592
593
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 591

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) 


441
442
443
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 441

def authorization_mode
  @authorization_mode
end

#automated_backup_config ⇒ Google::Apis::RedisV1beta1::AutomatedBackupConfig

The automated backup config for a cluster. Corresponds to the JSON property automatedBackupConfig

Returns:



446
447
448
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 446

def automated_backup_config
  @automated_backup_config
end

#backup_collection ⇒ String

Optional. Output only. The backup collection full resource name. Example: projects/project/locations/location/backupCollections/collection Corresponds to the JSON property backupCollection

Returns:

  • (String) 


452
453
454
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 452

def backup_collection
  @backup_collection
end

#cluster_endpoints ⇒ Array<Google::Apis::RedisV1beta1::ClusterEndpoint>

Optional. A list of cluster enpoints. Corresponds to the JSON property clusterEndpoints

Returns:



457
458
459
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 457

def cluster_endpoints
  @cluster_endpoints
end

#create_time ⇒ String

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

Returns:

  • (String) 


462
463
464
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 462

def create_time
  @create_time
end

#cross_cluster_replication_config ⇒ Google::Apis::RedisV1beta1::CrossClusterReplicationConfig

Cross cluster replication config. Corresponds to the JSON property crossClusterReplicationConfig

Returns:



467
468
469
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 467

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) 


472
473
474
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 472

def deletion_protection_enabled
  @deletion_protection_enabled
end

#discovery_endpoints ⇒ Array<Google::Apis::RedisV1beta1::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:



479
480
481
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 479

def discovery_endpoints
  @discovery_endpoints
end

#gcs_source ⇒ Google::Apis::RedisV1beta1::GcsBackupSource

Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Corresponds to the JSON property gcsSource

Returns:



485
486
487
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 485

def gcs_source
  @gcs_source
end

#maintenance_policy ⇒ Google::Apis::RedisV1beta1::ClusterMaintenancePolicy

Maintenance policy per cluster. Corresponds to the JSON property maintenancePolicy

Returns:



490
491
492
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 490

def maintenance_policy
  @maintenance_policy
end

#maintenance_schedule ⇒ Google::Apis::RedisV1beta1::ClusterMaintenanceSchedule

Upcoming maitenance schedule. Corresponds to the JSON property maintenanceSchedule

Returns:



495
496
497
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 495

def maintenance_schedule
  @maintenance_schedule
end

#managed_backup_source ⇒ Google::Apis::RedisV1beta1::ManagedBackupSource

Backups that generated and managed by memorystore. Corresponds to the JSON property managedBackupSource

Returns:



500
501
502
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 500

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


507
508
509
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 507

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) 


513
514
515
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 513

def node_type
  @node_type
end

#persistence_config ⇒ Google::Apis::RedisV1beta1::ClusterPersistenceConfig

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

Returns:



518
519
520
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 518

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) 


523
524
525
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 523

def precise_size_gb
  @precise_size_gb
end

#psc_configs ⇒ Array<Google::Apis::RedisV1beta1::PscConfig>

Optional. 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:



530
531
532
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 530

def psc_configs
  @psc_configs
end

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

Output only. The list of PSC connections that are auto-created through service connectivity automation. Corresponds to the JSON property pscConnections

Returns:



536
537
538
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 536

def psc_connections
  @psc_connections
end

#psc_service_attachments ⇒ Array<Google::Apis::RedisV1beta1::PscServiceAttachment>

Output only. Service attachment details to configure Psc connections Corresponds to the JSON property pscServiceAttachments

Returns:



541
542
543
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 541

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


546
547
548
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 546

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) 


551
552
553
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 551

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) 


556
557
558
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 556

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) 


562
563
564
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 562

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) 


568
569
570
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 568

def state
  @state
end

#state_info ⇒ Google::Apis::RedisV1beta1::StateInfo

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

Returns:



573
574
575
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 573

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) 


579
580
581
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 579

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) 


584
585
586
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 584

def uid
  @uid
end

#zone_distribution_config ⇒ Google::Apis::RedisV1beta1::ZoneDistributionConfig

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

Returns:



589
590
591
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 589

def zone_distribution_config
  @zone_distribution_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 596

def update!(**args)
  @authorization_mode = args[:authorization_mode] if args.key?(:authorization_mode)
  @automated_backup_config = args[:automated_backup_config] if args.key?(:automated_backup_config)
  @backup_collection = args[:backup_collection] if args.key?(:backup_collection)
  @cluster_endpoints = args[:cluster_endpoints] if args.key?(:cluster_endpoints)
  @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)
  @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
  @maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy)
  @maintenance_schedule = args[:maintenance_schedule] if args.key?(:maintenance_schedule)
  @managed_backup_source = args[:managed_backup_source] if args.key?(:managed_backup_source)
  @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)
  @psc_service_attachments = args[:psc_service_attachments] if args.key?(:psc_service_attachments)
  @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