Class: Google::Apis::RedisV1beta1::Instance

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 Memorystore for Redis instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



2449
2450
2451
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2449

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

Instance Attribute Details

#alternative_location_id ⇒ String

Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [ location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service. Corresponds to the JSON property alternativeLocationId

Returns:

  • (String) 


2205
2206
2207
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2205

def alternative_location_id
  @alternative_location_id
end

#auth_enabled ⇒ Boolean Also known as: auth_enabled?

Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled. Corresponds to the JSON property authEnabled

Returns:

  • (Boolean) 


2212
2213
2214
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2212

def auth_enabled
  @auth_enabled
end

#authorized_network ⇒ String

Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used. Corresponds to the JSON property authorizedNetwork

Returns:

  • (String) 


2220
2221
2222
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2220

def authorized_network
  @authorized_network
end

#available_maintenance_versions ⇒ Array<String>

Optional. The available maintenance versions that an instance could update to. Corresponds to the JSON property availableMaintenanceVersions

Returns:

  • (Array<String>) 


2225
2226
2227
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2225

def available_maintenance_versions
  @available_maintenance_versions
end

#connect_mode ⇒ String

Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING. Corresponds to the JSON property connectMode

Returns:

  • (String) 


2231
2232
2233
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2231

def connect_mode
  @connect_mode
end

#create_time ⇒ String

Output only. The time the instance was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


2236
2237
2238
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2236

def create_time
  @create_time
end

#current_location_id ⇒ String

Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance. Corresponds to the JSON property currentLocationId

Returns:

  • (String) 


2243
2244
2245
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2243

def current_location_id
  @current_location_id
end

#customer_managed_key ⇒ String

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

Returns:

  • (String) 


2249
2250
2251
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2249

def customer_managed_key
  @customer_managed_key
end

#display_name ⇒ String

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

Returns:

  • (String) 


2254
2255
2256
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2254

def display_name
  @display_name
end

#host ⇒ String

Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. Corresponds to the JSON property host

Returns:

  • (String) 


2260
2261
2262
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2260

def host
  @host
end

#labels ⇒ Hash<String,String>

Resource labels to represent user provided metadata Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2265
2266
2267
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2265

def labels
  @labels
end

#location_id ⇒ String

Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone. Corresponds to the JSON property locationId

Returns:

  • (String) 


2274
2275
2276
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2274

def location_id
  @location_id
end

#maintenance_policy ⇒ Google::Apis::RedisV1beta1::MaintenancePolicy

Maintenance policy for an instance. Corresponds to the JSON property maintenancePolicy

Returns:



2279
2280
2281
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2279

def maintenance_policy
  @maintenance_policy
end

#maintenance_schedule ⇒ Google::Apis::RedisV1beta1::MaintenanceSchedule

Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated. Corresponds to the JSON property maintenanceSchedule

Returns:



2285
2286
2287
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2285

def maintenance_schedule
  @maintenance_schedule
end

#maintenance_version ⇒ String

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00". Corresponds to the JSON property maintenanceVersion

Returns:

  • (String) 


2291
2292
2293
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2291

def maintenance_version
  @maintenance_version
end

#memory_size_gb ⇒ Fixnum

Required. Redis memory size in GiB. Corresponds to the JSON property memorySizeGb

Returns:

  • (Fixnum) 


2296
2297
2298
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2296

def memory_size_gb
  @memory_size_gb
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/ instances/instance_id`Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. Corresponds to the JSON propertyname`

Returns:

  • (String) 


2307
2308
2309
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2307

def name
  @name
end

#nodes ⇒ Array<Google::Apis::RedisV1beta1::NodeInfo>

Output only. Info per node. Corresponds to the JSON property nodes

Returns:



2312
2313
2314
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2312

def nodes
  @nodes
end

#persistence_config ⇒ Google::Apis::RedisV1beta1::PersistenceConfig

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

Returns:



2317
2318
2319
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2317

def persistence_config
  @persistence_config
end

#persistence_iam_identity ⇒ String

Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation. Corresponds to the JSON property persistenceIamIdentity

Returns:

  • (String) 


2325
2326
2327
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2325

def persistence_iam_identity
  @persistence_iam_identity
end

#port ⇒ Fixnum

Output only. The port number of the exposed Redis endpoint. Corresponds to the JSON property port

Returns:

  • (Fixnum) 


2330
2331
2332
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2330

def port
  @port
end

#read_endpoint ⇒ String

Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. Corresponds to the JSON property readEndpoint

Returns:

  • (String) 


2338
2339
2340
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2338

def read_endpoint
  @read_endpoint
end

#read_endpoint_port ⇒ Fixnum

Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. Corresponds to the JSON property readEndpointPort

Returns:

  • (Fixnum) 


2344
2345
2346
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2344

def read_endpoint_port
  @read_endpoint_port
end

#read_replicas_mode ⇒ String

Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. Corresponds to the JSON property readReplicasMode

Returns:

  • (String) 


2350
2351
2352
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2350

def read_replicas_mode
  @read_replicas_mode
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 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer:

  • activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries Corresponds to the JSON property redisConfigs

Returns:

  • (Hash<String,String>) 


2359
2360
2361
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2359

def redis_configs
  @redis_configs
end

#redis_version ⇒ String

Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * REDIS_3_2 for Redis 3.2 compatibility * REDIS_4_0 for Redis 4.0 compatibility (default) * REDIS_5_0 for Redis 5.0 compatibility * REDIS_6_X for Redis 6.x compatibility * REDIS_7_0 for Redis 7.0 compatibility Corresponds to the JSON property redisVersion

Returns:

  • (String) 


2368
2369
2370
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2368

def redis_version
  @redis_version
end

#replica_count ⇒ Fixnum

Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0. Corresponds to the JSON property replicaCount

Returns:

  • (Fixnum) 


2376
2377
2378
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2376

def replica_count
  @replica_count
end

#reserved_ip_range ⇒ String

Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused / 29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28. Corresponds to the JSON property reservedIpRange

Returns:

  • (String) 


2387
2388
2389
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2387

def reserved_ip_range
  @reserved_ip_range
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Optional. Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


2392
2393
2394
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2392

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Optional. Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


2398
2399
2400
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2398

def satisfies_pzs
  @satisfies_pzs
end

#secondary_ip_range ⇒ String

Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto". Corresponds to the JSON property secondaryIpRange

Returns:

  • (String) 


2408
2409
2410
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2408

def secondary_ip_range
  @secondary_ip_range
end

#server_ca_certs ⇒ Array<Google::Apis::RedisV1beta1::TlsCertificate>

Output only. List of server CA certificates for the instance. Corresponds to the JSON property serverCaCerts

Returns:



2413
2414
2415
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2413

def server_ca_certs
  @server_ca_certs
end

#state ⇒ String

Output only. The current state of this instance. Corresponds to the JSON property state

Returns:

  • (String) 


2418
2419
2420
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2418

def state
  @state
end

#status_message ⇒ String

Output only. Additional information about the current status of this instance, if available. Corresponds to the JSON property statusMessage

Returns:

  • (String) 


2424
2425
2426
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2424

def status_message
  @status_message
end

#suspension_reasons ⇒ Array<String>

Optional. reasons that causes instance in "SUSPENDED" state. Corresponds to the JSON property suspensionReasons

Returns:

  • (Array<String>) 


2429
2430
2431
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2429

def suspension_reasons
  @suspension_reasons
end

#tags ⇒ Hash<String,String>

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": " marketing" Corresponds to the JSON property tags

Returns:

  • (Hash<String,String>) 


2436
2437
2438
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2436

def tags
  @tags
end

#tier ⇒ String

Required. The service tier of the instance. Corresponds to the JSON property tier

Returns:

  • (String) 


2441
2442
2443
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2441

def tier
  @tier
end

#transit_encryption_mode ⇒ String

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance. Corresponds to the JSON property transitEncryptionMode

Returns:

  • (String) 


2447
2448
2449
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2447

def transit_encryption_mode
  @transit_encryption_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 2454

def update!(**args)
  @alternative_location_id = args[:alternative_location_id] if args.key?(:alternative_location_id)
  @auth_enabled = args[:auth_enabled] if args.key?(:auth_enabled)
  @authorized_network = args[:authorized_network] if args.key?(:authorized_network)
  @available_maintenance_versions = args[:available_maintenance_versions] if args.key?(:available_maintenance_versions)
  @connect_mode = args[:connect_mode] if args.key?(:connect_mode)
  @create_time = args[:create_time] if args.key?(:create_time)
  @current_location_id = args[:current_location_id] if args.key?(:current_location_id)
  @customer_managed_key = args[:customer_managed_key] if args.key?(:customer_managed_key)
  @display_name = args[:display_name] if args.key?(:display_name)
  @host = args[:host] if args.key?(:host)
  @labels = args[:labels] if args.key?(:labels)
  @location_id = args[:location_id] if args.key?(:location_id)
  @maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy)
  @maintenance_schedule = args[:maintenance_schedule] if args.key?(:maintenance_schedule)
  @maintenance_version = args[:maintenance_version] if args.key?(:maintenance_version)
  @memory_size_gb = args[:memory_size_gb] if args.key?(:memory_size_gb)
  @name = args[:name] if args.key?(:name)
  @nodes = args[:nodes] if args.key?(:nodes)
  @persistence_config = args[:persistence_config] if args.key?(:persistence_config)
  @persistence_iam_identity = args[:persistence_iam_identity] if args.key?(:persistence_iam_identity)
  @port = args[:port] if args.key?(:port)
  @read_endpoint = args[:read_endpoint] if args.key?(:read_endpoint)
  @read_endpoint_port = args[:read_endpoint_port] if args.key?(:read_endpoint_port)
  @read_replicas_mode = args[:read_replicas_mode] if args.key?(:read_replicas_mode)
  @redis_configs = args[:redis_configs] if args.key?(:redis_configs)
  @redis_version = args[:redis_version] if args.key?(:redis_version)
  @replica_count = args[:replica_count] if args.key?(:replica_count)
  @reserved_ip_range = args[:reserved_ip_range] if args.key?(:reserved_ip_range)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @secondary_ip_range = args[:secondary_ip_range] if args.key?(:secondary_ip_range)
  @server_ca_certs = args[:server_ca_certs] if args.key?(:server_ca_certs)
  @state = args[:state] if args.key?(:state)
  @status_message = args[:status_message] if args.key?(:status_message)
  @suspension_reasons = args[:suspension_reasons] if args.key?(:suspension_reasons)
  @tags = args[:tags] if args.key?(:tags)
  @tier = args[:tier] if args.key?(:tier)
  @transit_encryption_mode = args[:transit_encryption_mode] if args.key?(:transit_encryption_mode)
end