class Google::Apis::RedisV1beta1::Instance

A Google Cloud Redis instance. next id = 36

Attributes

alternative_location_id[RW]

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` @return [String]

auth_enabled[RW]

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` @return [Boolean]

auth_enabled?[RW]

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` @return [Boolean]

authorized_network[RW]

Optional. The full name of the Google Compute Engine [network](cloud. google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used. Corresponds to the JSON property `authorizedNetwork` @return [String]

connect_mode[RW]

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` @return [String]

create_time[RW]

Output only. The time the instance was created. Corresponds to the JSON property `createTime` @return [String]

current_location_id[RW]

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` @return [String]

display_name[RW]

An arbitrary and optional user-provided name for the instance. Corresponds to the JSON property `displayName` @return [String]

host[RW]

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` @return [String]

labels[RW]

Resource labels to represent user provided metadata Corresponds to the JSON property `labels` @return [Hash<String,String>]

location_id[RW]

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, 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` @return [String]

maintenance_policy[RW]

Maintenance policy for an instance. Corresponds to the JSON property `maintenancePolicy` @return [Google::Apis::RedisV1beta1::MaintenancePolicy]

maintenance_schedule[RW]

Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated. Corresponds to the JSON property `maintenanceSchedule` @return [Google::Apis::RedisV1beta1::MaintenanceSchedule]

memory_size_gb[RW]

Required. Redis memory size in GiB. Corresponds to the JSON property `memorySizeGb` @return [Fixnum]

name[RW]

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 property `name` @return [String]

persistence_iam_identity[RW]

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` @return [String]

port[RW]

Output only. The port number of the exposed Redis endpoint. Corresponds to the JSON property `port` @return [Fixnum]

redis_configs[RW]

Optional. Redis configuration parameters, according to 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` @return [Hash<String,String>]

redis_version[RW]

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 Corresponds to the JSON property `redisVersion` @return [String]

reserved_ip_range[RW]

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. Corresponds to the JSON property `reservedIpRange` @return [String]

server_ca_certs[RW]

Output only. List of server CA certificates for the instance. Corresponds to the JSON property `serverCaCerts` @return [Array<Google::Apis::RedisV1beta1::TlsCertificate>]

state[RW]

Output only. The current state of this instance. Corresponds to the JSON property `state` @return [String]

status_message[RW]

Output only. Additional information about the current status of this instance, if available. Corresponds to the JSON property `statusMessage` @return [String]

tier[RW]

Required. The service tier of the instance. Corresponds to the JSON property `tier` @return [String]

transit_encryption_mode[RW]

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance. Corresponds to the JSON property `transitEncryptionMode` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/redis_v1beta1/classes.rb, line 420
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/redis_v1beta1/classes.rb, line 425
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)
  @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)
  @maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy)
  @maintenance_schedule = args[:maintenance_schedule] if args.key?(:maintenance_schedule)
  @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)
  @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)
  @tier = args[:tier] if args.key?(:tier)
  @transit_encryption_mode = args[:transit_encryption_mode] if args.key?(:transit_encryption_mode)
end