Class: Google::Cloud::Redis::V1beta1::Instance

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb

Overview

A Google Cloud Redis instance.

Defined Under Namespace

Modules: ConnectMode, ReadReplicasMode, State, Tier Classes: LabelsEntry, RedisConfigsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#alternative_location_id::String

Returns 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.

Returns:

  • (::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.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 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.

Returns:

  • (::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.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#connect_mode::Google::Cloud::Redis::V1beta1::Instance::ConnectMode

Returns Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.

Returns:



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#create_time::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the instance was created.

Returns:



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#current_location_id::String (readonly)

Returns 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.

Returns:

  • (::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.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#display_name::String

Returns An arbitrary and optional user-provided name for the instance.

Returns:

  • (::String)

    An arbitrary and optional user-provided name for the instance.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 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.

Returns:

  • (::String)

    Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#labels::Google::Protobuf::Map{::String => ::String}

Returns Resource labels to represent user provided metadata.

Returns:

  • (::Google::Protobuf::Map{::String => ::String})

    Resource labels to represent user provided metadata



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 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 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.

Returns:

  • (::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.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#memory_size_gb::Integer

Returns Required. Redis memory size in GiB.

Returns:

  • (::Integer)

    Required. Redis memory size in GiB.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 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.

Returns:

  • (::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.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#nodes::Array<::Google::Cloud::Redis::V1beta1::NodeInfo> (readonly)

Returns Output only. Info per node.

Returns:



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 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:". The value may change over time for a given instance so should be checked before each import/export operation.

Returns:

  • (::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.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#port::Integer (readonly)

Returns Output only. The port number of the exposed Redis endpoint.

Returns:

  • (::Integer)

    Output only. The port number of the exposed Redis endpoint.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#read_endpoint::String (readonly)

Returns 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'.

Returns:

  • (::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'.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#read_endpoint_port::Integer (readonly)

Returns Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.

Returns:

  • (::Integer)

    Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#read_replicas_mode::Google::Cloud::Redis::V1beta1::Instance::ReadReplicasMode

Returns Optional. Read replica mode.

Returns:



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 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.

Returns:

  • (::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


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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 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_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.

Returns:

  • (::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


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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#replica_count::Integer

Returns Optional. The number of replica nodes. Valid range for standard tier is [1-5] and defaults to 1. Valid value for basic tier is 0 and defaults to 0.

Returns:

  • (::Integer)

    Optional. The number of replica nodes. Valid range for standard tier is [1-5] and defaults to 1. Valid value for basic tier is 0 and defaults to 0.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#reserved_ip_range::String

Returns 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.

Returns:

  • (::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.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#state::Google::Cloud::Redis::V1beta1::Instance::State (readonly)

Returns Output only. The current state of this instance.

Returns:



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#status_message::String (readonly)

Returns Output only. Additional information about the current status of this instance, if available.

Returns:

  • (::String)

    Output only. Additional information about the current status of this instance, if available.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end

#tier::Google::Cloud::Redis::V1beta1::Instance::Tier

Returns Required. The service tier of the instance.

Returns:



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb', line 178

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 = 10
  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 direct peering to the Memorystore for Redis hosted service.
    DIRECT_PEERING = 1

    # Connect your Memorystore for Redis instance using Private Service
    # Access. Private services access provides an IP address range for multiple
    # Google Cloud services, including Memorystore.
    PRIVATE_SERVICE_ACCESS = 2
  end

  # Read replicas mode.
  module ReadReplicasMode
    # If not set, Memorystore for Redis backend will pick the mode based on
    # other fields in the request.
    READ_REPLICAS_MODE_UNSPECIFIED = 0

    # If disabled, read endpoint will not be provided and the instance cannot
    # scale up or down the number of replicas.
    READ_REPLICAS_DISABLED = 1

    # If enabled, read endpoint will be provided and the instance can scale
    # up and down the number of replicas.
    READ_REPLICAS_ENABLED = 2
  end
end