Class: Google::Cloud::Redis::V1beta1::Instance
- Inherits:
-
Object
- Object
- Google::Cloud::Redis::V1beta1::Instance
- Defined in:
- lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb
Overview
A Google Cloud Redis instance.
Defined Under Namespace
Instance Attribute Summary collapse
-
#alternative_location_id ⇒ String
Optional.
-
#authorized_network ⇒ String
Optional.
-
#create_time ⇒ Google::Protobuf::Timestamp
Output only.
-
#current_location_id ⇒ String
Output only.
-
#display_name ⇒ String
An arbitrary and optional user-provided name for the instance.
-
#host ⇒ String
Output only.
-
#labels ⇒ Hash{String => String}
Resource labels to represent user provided metadata.
-
#location_id ⇒ String
Optional.
-
#memory_size_gb ⇒ Integer
Required.
-
#name ⇒ String
Required.
-
#port ⇒ Integer
Output only.
-
#redis_configs ⇒ Hash{String => String}
Optional.
-
#redis_version ⇒ String
Optional.
-
#reserved_ip_range ⇒ String
Optional.
-
#state ⇒ Google::Cloud::Redis::V1beta1::Instance::State
Output only.
-
#status_message ⇒ String
Output only.
-
#tier ⇒ Google::Cloud::Redis::V1beta1::Instance::Tier
Required.
Instance Attribute Details
#alternative_location_id ⇒ String
Returns 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].
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#authorized_network ⇒ String
Returns 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.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#create_time ⇒ Google::Protobuf::Timestamp
Returns Output only. The time the instance was created.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#current_location_id ⇒ String
Returns Output only. The current zone where the Redis endpoint is placed. In single zone deployments, this will always be the same as [location_id] provided by the user at creation time. In cross-zone instances (only applicable in STANDARD_HA tier), this can be either [location_id] or [alternative_location_id] and can change on a failover event.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#display_name ⇒ String
Returns An arbitrary and optional user-provided name for the instance.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#host ⇒ String
Returns Output only. Hostname or IP address of the exposed redis endpoint used by clients to connect to the service.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#labels ⇒ Hash{String => String}
Returns Resource labels to represent user provided metadata
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#location_id ⇒ String
Returns 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].
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#memory_size_gb ⇒ Integer
Returns Required. Redis memory size in GB.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#name ⇒ String
Returns 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 get to 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.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#port ⇒ Integer
Returns Output only. The port number of the exposed redis endpoint.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#redis_configs ⇒ Hash{String => String}
Returns Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are:
- maxmemory-policy
- notify-keyspace-events
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#redis_version ⇒ String
Returns Optional. The version of Redis software. If not provided, latest supported version will be used.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#reserved_ip_range ⇒ String
Returns 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 a network.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#state ⇒ Google::Cloud::Redis::V1beta1::Instance::State
Returns Output only. The current state of this instance.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#status_message ⇒ String
Returns Output only. Additional information about the current status of this instance, if available.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |
#tier ⇒ Google::Cloud::Redis::V1beta1::Instance::Tier
Returns Required. The service tier of the instance.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 102 class Instance # Represents the different states of a Redis instance. module State # Not set. STATE_UNSPECIFIED = 0 # Redis instance is being created. CREATING = 1 # Redis instance has been created and is fully usable. READY = 2 # Redis instance configuration is being updated. Certain kinds of updates # may cause the instance to become unusable while the update is in # progress. UPDATING = 3 # Redis instance is being deleted. DELETING = 4 # Redis instance is being repaired and may be unusable. Details can be # found in the +status_message+ field. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 end # Available service tiers to choose from module Tier # Not set. TIER_UNSPECIFIED = 0 # BASIC tier: standalone instance BASIC = 1 # STANDARD_HA tier: highly available primary/replica instances STANDARD_HA = 3 end end |