Class: Google::Apis::RedisV1::Instance

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

Overview

A Google Cloud Redis instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



398
399
400
 
# File 'generated/google/apis/redis_v1/classes.rb', line 398

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

Instance Attribute Details

#alternative_location_id ⇒ String

Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in location_id. Corresponds to the JSON property alternativeLocationId

Returns:

  • (String) 


264
265
266
 
# File 'generated/google/apis/redis_v1/classes.rb', line 264

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


272
273
274
 
# File 'generated/google/apis/redis_v1/classes.rb', line 272

def authorized_network
  @authorized_network
end

#connect_mode ⇒ String

Optional. The connect mode of Redis instance. If not provided, default one will be used. Current default: DIRECT_PEERING. Corresponds to the JSON property connectMode

Returns:

  • (String) 


279
280
281
 
# File 'generated/google/apis/redis_v1/classes.rb', line 279

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) 


284
285
286
 
# File 'generated/google/apis/redis_v1/classes.rb', line 284

def create_time
  @create_time
end

#current_location_id ⇒ String

Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the location_id provided by the user at creation time. For Standard Tier instances, this can be either location_id or alternative_location_id and can change after a failover event. Corresponds to the JSON property currentLocationId

Returns:

  • (String) 


293
294
295
 
# File 'generated/google/apis/redis_v1/classes.rb', line 293

def current_location_id
  @current_location_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


298
299
300
 
# File 'generated/google/apis/redis_v1/classes.rb', line 298

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) 


304
305
306
 
# File 'generated/google/apis/redis_v1/classes.rb', line 304

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>) 


309
310
311
 
# File 'generated/google/apis/redis_v1/classes.rb', line 309

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 for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If alternative_location_id is also provided, it must be different from location_id. Corresponds to the JSON property locationId

Returns:

  • (String) 


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

def location_id
  @location_id
end

#memory_size_gb ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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) 


335
336
337
 
# File 'generated/google/apis/redis_v1/classes.rb', line 335

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


344
345
346
 
# File 'generated/google/apis/redis_v1/classes.rb', line 344

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) 


349
350
351
 
# File 'generated/google/apis/redis_v1/classes.rb', line 349

def port
  @port
end

#redis_configs ⇒ Hash<String,String>

Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis 3.2 and above:

  • maxmemory-policy
  • notify-keyspace-events Redis 4.0 and above:
  • activedefrag
  • lfu-log-factor
  • lfu-decay-time Corresponds to the JSON property redisConfigs

Returns:

  • (Hash<String,String>) 


363
364
365
 
# File 'generated/google/apis/redis_v1/classes.rb', line 363

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_4_0 for Redis 4.0 compatibility (default)
  • REDIS_3_2 for Redis 3.2 compatibility Corresponds to the JSON property redisVersion

Returns:

  • (String) 


372
373
374
 
# File 'generated/google/apis/redis_v1/classes.rb', line 372

def redis_version
  @redis_version
end

#reserved_ip_range ⇒ String

Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network. Corresponds to the JSON property reservedIpRange

Returns:

  • (String) 


380
381
382
 
# File 'generated/google/apis/redis_v1/classes.rb', line 380

def reserved_ip_range
  @reserved_ip_range
end

#state ⇒ String

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

Returns:

  • (String) 


385
386
387
 
# File 'generated/google/apis/redis_v1/classes.rb', line 385

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) 


391
392
393
 
# File 'generated/google/apis/redis_v1/classes.rb', line 391

def status_message
  @status_message
end

#tier ⇒ String

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

Returns:

  • (String) 


396
397
398
 
# File 'generated/google/apis/redis_v1/classes.rb', line 396

def tier
  @tier
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'generated/google/apis/redis_v1/classes.rb', line 403

def update!(**args)
  @alternative_location_id = args[:alternative_location_id] if args.key?(:alternative_location_id)
  @authorized_network = args[:authorized_network] if args.key?(:authorized_network)
  @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)
  @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)
  @memory_size_gb = args[:memory_size_gb] if args.key?(:memory_size_gb)
  @name = args[:name] if args.key?(:name)
  @persistence_iam_identity = args[:persistence_iam_identity] if args.key?(:persistence_iam_identity)
  @port = args[:port] if args.key?(:port)
  @redis_configs = args[:redis_configs] if args.key?(:redis_configs)
  @redis_version = args[:redis_version] if args.key?(:redis_version)
  @reserved_ip_range = args[:reserved_ip_range] if args.key?(:reserved_ip_range)
  @state = args[:state] if args.key?(:state)
  @status_message = args[:status_message] if args.key?(:status_message)
  @tier = args[:tier] if args.key?(:tier)
end