A Google Cloud Redis instance.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#alternative_location_id
def alternative_location_id() -> ::String
- (::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.
#alternative_location_id=
def alternative_location_id=(value) -> ::String
- value (::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.
- (::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.
#auth_enabled
def auth_enabled() -> ::Boolean
- (::Boolean) — 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.
#auth_enabled=
def auth_enabled=(value) -> ::Boolean
- value (::Boolean) — 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.
- (::Boolean) — 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.
#authorized_network
def authorized_network() -> ::String
-
(::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.
#authorized_network=
def authorized_network=(value) -> ::String
-
value (::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.
-
(::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.
#connect_mode
def connect_mode() -> ::Google::Cloud::Redis::V1beta1::Instance::ConnectMode
- (::Google::Cloud::Redis::V1beta1::Instance::ConnectMode) — Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
#connect_mode=
def connect_mode=(value) -> ::Google::Cloud::Redis::V1beta1::Instance::ConnectMode
- value (::Google::Cloud::Redis::V1beta1::Instance::ConnectMode) — Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
- (::Google::Cloud::Redis::V1beta1::Instance::ConnectMode) — Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The time the instance was created.
#current_location_id
def current_location_id() -> ::String
- (::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.
#display_name
def display_name() -> ::String
- (::String) — An arbitrary and optional user-provided name for the instance.
#display_name=
def display_name=(value) -> ::String
- value (::String) — An arbitrary and optional user-provided name for the instance.
- (::String) — An arbitrary and optional user-provided name for the instance.
#host
def host() -> ::String
- (::String) — Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
- (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
- value (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata
- (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata
#location_id
def location_id() -> ::String
- (::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.
#location_id=
def location_id=(value) -> ::String
- value (::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.
- (::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.
#maintenance_policy
def maintenance_policy() -> ::Google::Cloud::Redis::V1beta1::MaintenancePolicy
- (::Google::Cloud::Redis::V1beta1::MaintenancePolicy) — Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
#maintenance_policy=
def maintenance_policy=(value) -> ::Google::Cloud::Redis::V1beta1::MaintenancePolicy
- value (::Google::Cloud::Redis::V1beta1::MaintenancePolicy) — Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
- (::Google::Cloud::Redis::V1beta1::MaintenancePolicy) — Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
#maintenance_schedule
def maintenance_schedule() -> ::Google::Cloud::Redis::V1beta1::MaintenanceSchedule
- (::Google::Cloud::Redis::V1beta1::MaintenanceSchedule) — Output only. Date and time of upcoming maintenance events which have been scheduled.
#memory_size_gb
def memory_size_gb() -> ::Integer
- (::Integer) — Required. Redis memory size in GiB.
#memory_size_gb=
def memory_size_gb=(value) -> ::Integer
- value (::Integer) — Required. Redis memory size in GiB.
- (::Integer) — Required. Redis memory size in GiB.
#name
def name() -> ::String
-
(::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.
#name=
def name=(value) -> ::String
-
value (::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.
-
(::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.
#nodes
def nodes() -> ::Array<::Google::Cloud::Redis::V1beta1::NodeInfo>
- (::Array<::Google::Cloud::Redis::V1beta1::NodeInfo>) — Output only. Info per node.
#persistence_iam_identity
def persistence_iam_identity() -> ::String
- (::String) — Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:
#port
def port() -> ::Integer
- (::Integer) — Output only. The port number of the exposed Redis endpoint.
#read_endpoint
def read_endpoint() -> ::String
- (::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'.
#read_endpoint_port
def read_endpoint_port() -> ::Integer
- (::Integer) — Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
#read_replicas_mode
def read_replicas_mode() -> ::Google::Cloud::Redis::V1beta1::Instance::ReadReplicasMode
- (::Google::Cloud::Redis::V1beta1::Instance::ReadReplicasMode) — Optional. Read replica mode. Can only be specified when trying to create the instance.
#read_replicas_mode=
def read_replicas_mode=(value) -> ::Google::Cloud::Redis::V1beta1::Instance::ReadReplicasMode
- value (::Google::Cloud::Redis::V1beta1::Instance::ReadReplicasMode) — Optional. Read replica mode. Can only be specified when trying to create the instance.
- (::Google::Cloud::Redis::V1beta1::Instance::ReadReplicasMode) — Optional. Read replica mode. Can only be specified when trying to create the instance.
#redis_configs
def redis_configs() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::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
#redis_configs=
def redis_configs=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::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
-
(::Google::Protobuf::Map{::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
#redis_version
def redis_version() -> ::String
-
(::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_version=
def redis_version=(value) -> ::String
-
value (::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
-
-
(::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
-
#replica_count
def replica_count() -> ::Integer
- (::Integer) — 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.
#replica_count=
def replica_count=(value) -> ::Integer
- value (::Integer) — 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.
- (::Integer) — 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.
#reserved_ip_range
def reserved_ip_range() -> ::String
- (::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.
#reserved_ip_range=
def reserved_ip_range=(value) -> ::String
- value (::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.
- (::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.
#server_ca_certs
def server_ca_certs() -> ::Array<::Google::Cloud::Redis::V1beta1::TlsCertificate>
- (::Array<::Google::Cloud::Redis::V1beta1::TlsCertificate>) — Output only. List of server CA certificates for the instance.
#state
def state() -> ::Google::Cloud::Redis::V1beta1::Instance::State
- (::Google::Cloud::Redis::V1beta1::Instance::State) — Output only. The current state of this instance.
#status_message
def status_message() -> ::String
- (::String) — Output only. Additional information about the current status of this instance, if available.
#tier
def tier() -> ::Google::Cloud::Redis::V1beta1::Instance::Tier
- (::Google::Cloud::Redis::V1beta1::Instance::Tier) — Required. The service tier of the instance.
#tier=
def tier=(value) -> ::Google::Cloud::Redis::V1beta1::Instance::Tier
- value (::Google::Cloud::Redis::V1beta1::Instance::Tier) — Required. The service tier of the instance.
- (::Google::Cloud::Redis::V1beta1::Instance::Tier) — Required. The service tier of the instance.
#transit_encryption_mode
def transit_encryption_mode() -> ::Google::Cloud::Redis::V1beta1::Instance::TransitEncryptionMode
- (::Google::Cloud::Redis::V1beta1::Instance::TransitEncryptionMode) — Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
#transit_encryption_mode=
def transit_encryption_mode=(value) -> ::Google::Cloud::Redis::V1beta1::Instance::TransitEncryptionMode
- value (::Google::Cloud::Redis::V1beta1::Instance::TransitEncryptionMode) — Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
- (::Google::Cloud::Redis::V1beta1::Instance::TransitEncryptionMode) — Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.