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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



1919
1920
1921
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1919

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) 


1682
1683
1684
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1682

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) 


1689
1690
1691
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1689

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) 


1697
1698
1699
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1697

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


1702
1703
1704
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1702

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) 


1708
1709
1710
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1708

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) 


1713
1714
1715
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1713

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) 


1720
1721
1722
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1720

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) 


1726
1727
1728
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1726

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) 


1731
1732
1733
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1731

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) 


1737
1738
1739
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1737

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


1742
1743
1744
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1742

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) 


1751
1752
1753
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1751

def location_id
  @location_id
end

#maintenance_policy ⇒ Google::Apis::RedisV1::MaintenancePolicy

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

Returns:



1756
1757
1758
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1756

def maintenance_policy
  @maintenance_policy
end

#maintenance_schedule ⇒ Google::Apis::RedisV1::MaintenanceSchedule

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

Returns:



1762
1763
1764
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1762

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) 


1768
1769
1770
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1768

def maintenance_version
  @maintenance_version
end

#memory_size_gb ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1773
1774
1775
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1773

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) 


1784
1785
1786
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1784

def name
  @name
end

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

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

Returns:



1789
1790
1791
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1789

def nodes
  @nodes
end

#persistence_config ⇒ Google::Apis::RedisV1::PersistenceConfig

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

Returns:



1794
1795
1796
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1794

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) 


1802
1803
1804
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1802

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) 


1807
1808
1809
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1807

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) 


1815
1816
1817
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1815

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) 


1821
1822
1823
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1821

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) 


1827
1828
1829
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1827

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


1836
1837
1838
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1836

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) 


1845
1846
1847
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1845

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) 


1853
1854
1855
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1853

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) 


1864
1865
1866
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1864

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) 


1869
1870
1871
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1869

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) 


1875
1876
1877
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1875

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) 


1885
1886
1887
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1885

def secondary_ip_range
  @secondary_ip_range
end

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

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

Returns:



1890
1891
1892
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1890

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) 


1895
1896
1897
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1895

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) 


1901
1902
1903
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1901

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


1906
1907
1908
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1906

def suspension_reasons
  @suspension_reasons
end

#tier ⇒ String

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

Returns:

  • (String) 


1911
1912
1913
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1911

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) 


1917
1918
1919
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1917

def transit_encryption_mode
  @transit_encryption_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
 
# File 'lib/google/apis/redis_v1/classes.rb', line 1924

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)
  @tier = args[:tier] if args.key?(:tier)
  @transit_encryption_mode = args[:transit_encryption_mode] if args.key?(:transit_encryption_mode)
end