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.



141
142
143
 
# File 'lib/google/apis/redis_v1/classes.rb', line 141

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) 


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

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) 


76
77
78
 
# File 'lib/google/apis/redis_v1/classes.rb', line 76

def create_time
  @create_time
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:



82
83
84
 
# File 'lib/google/apis/redis_v1/classes.rb', line 82

def discovery_endpoints
  @discovery_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) 


89
90
91
 
# File 'lib/google/apis/redis_v1/classes.rb', line 89

def name
  @name
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:



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

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:



102
103
104
 
# File 'lib/google/apis/redis_v1/classes.rb', line 102

def psc_connections
  @psc_connections
end

#replica_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


107
108
109
 
# File 'lib/google/apis/redis_v1/classes.rb', line 107

def replica_count
  @replica_count
end

#shard_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


112
113
114
 
# File 'lib/google/apis/redis_v1/classes.rb', line 112

def shard_count
  @shard_count
end

#size_gb ⇒ Fixnum

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

Returns:

  • (Fixnum) 


117
118
119
 
# File 'lib/google/apis/redis_v1/classes.rb', line 117

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) 


123
124
125
 
# File 'lib/google/apis/redis_v1/classes.rb', line 123

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:



128
129
130
 
# File 'lib/google/apis/redis_v1/classes.rb', line 128

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) 


134
135
136
 
# File 'lib/google/apis/redis_v1/classes.rb', line 134

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) 


139
140
141
 
# File 'lib/google/apis/redis_v1/classes.rb', line 139

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/google/apis/redis_v1/classes.rb', line 146

def update!(**args)
  @authorization_mode = args[:authorization_mode] if args.key?(:authorization_mode)
  @create_time = args[:create_time] if args.key?(:create_time)
  @discovery_endpoints = args[:discovery_endpoints] if args.key?(:discovery_endpoints)
  @name = args[:name] if args.key?(:name)
  @psc_configs = args[:psc_configs] if args.key?(:psc_configs)
  @psc_connections = args[:psc_connections] if args.key?(:psc_connections)
  @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)
end