Class: Google::Cloud::Redis::V1::Instance
- Inherits:
-
Object
- Object
- Google::Cloud::Redis::V1::Instance
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/redis/v1/cloud_redis.rb
Overview
A Google Cloud Redis instance.
Defined Under Namespace
Modules: ConnectMode, State, Tier Classes: LabelsEntry, RedisConfigsEntry
Instance Attribute Summary collapse
-
#alternative_location_id ⇒ ::String
Optional.
-
#authorized_network ⇒ ::String
Optional.
-
#connect_mode ⇒ ::Google::Cloud::Redis::V1::Instance::ConnectMode
Optional.
-
#create_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#current_location_id ⇒ ::String
readonly
Output only.
-
#display_name ⇒ ::String
An arbitrary and optional user-provided name for the instance.
-
#host ⇒ ::String
readonly
Output only.
-
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Resource labels to represent user provided metadata.
-
#location_id ⇒ ::String
Optional.
-
#memory_size_gb ⇒ ::Integer
Required.
-
#name ⇒ ::String
Required.
-
#persistence_iam_identity ⇒ ::String
readonly
Output only.
-
#port ⇒ ::Integer
readonly
Output only.
-
#redis_configs ⇒ ::Google::Protobuf::Map{::String => ::String}
Optional.
-
#redis_version ⇒ ::String
Optional.
-
#reserved_ip_range ⇒ ::String
Optional.
-
#state ⇒ ::Google::Cloud::Redis::V1::Instance::State
readonly
Output only.
-
#status_message ⇒ ::String
readonly
Output only.
-
#tier ⇒ ::Google::Cloud::Redis::V1::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.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 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.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#connect_mode ⇒ ::Google::Cloud::Redis::V1::Instance::ConnectMode
Returns Optional. The connect mode of Redis instance. If not provided, default one will be used. Current default: DIRECT_PEERING.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The time the instance was created.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#current_location_id ⇒ ::String (readonly)
Returns 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.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#display_name ⇒ ::String
Returns An arbitrary and optional user-provided name for the instance.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#host ⇒ ::String (readonly)
Returns Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns Resource labels to represent user provided metadata.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 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.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#memory_size_gb ⇒ ::Integer
Returns Required. Redis memory size in GiB.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 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 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.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#persistence_iam_identity ⇒ ::String (readonly)
Returns Output only. Cloud IAM identity used by import / export operations to
transfer data to/from Cloud Storage. Format is
"serviceAccount:
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#port ⇒ ::Integer (readonly)
Returns Output only. The port number of the exposed Redis endpoint.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#redis_configs ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns 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.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#redis_version ⇒ ::String
Returns Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are:
-
REDIS_3_2for Redis 3.2 compatibility -
REDIS_4_0for Redis 4.0 compatibility (default) -
REDIS_5_0for Redis 5.0 compatibility.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 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 an authorized network.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#state ⇒ ::Google::Cloud::Redis::V1::Instance::State (readonly)
Returns Output only. The current state of this instance.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#status_message ⇒ ::String (readonly)
Returns Output only. Additional information about the current status of this instance, if available.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |
#tier ⇒ ::Google::Cloud::Redis::V1::Instance::Tier
Returns Required. The service tier of the instance.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 139 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class RedisConfigsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. REPAIRING = 5 # Maintenance is being performed on this Redis instance. MAINTENANCE = 6 # Redis instance is importing data (availability may be affected). IMPORTING = 8 # Redis instance is failing over (availability may be affected). FAILING_OVER = 9 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 # Available connection modes. module ConnectMode # Not set. CONNECT_MODE_UNSPECIFIED = 0 # Connect via directly peering with memorystore redis hosted service. DIRECT_PEERING = 1 # Connect with google via private service access and share connection # across google managed services. PRIVATE_SERVICE_ACCESS = 2 end end |