Class: Google::Cloud::Bigtable::Admin::V2::Cluster

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/bigtable/admin/v2/instance.rb

Overview

A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.

Defined Under Namespace

Modules: State Classes: ClusterAutoscalingConfig, ClusterConfig, EncryptionConfig

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_config ⇒ ::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterConfig

Returns Configuration for this cluster.

Returns:



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 172

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Autoscaling config for a cluster.
  # @!attribute [rw] autoscaling_limits
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingLimits]
  #     Required. Autoscaling limits for this cluster.
  # @!attribute [rw] autoscaling_targets
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingTargets]
  #     Required. Autoscaling targets for this cluster.
  class ClusterAutoscalingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a cluster.
  # @!attribute [rw] cluster_autoscaling_config
  #   @return [::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterAutoscalingConfig]
  #     Autoscaling configuration for this cluster.
  class ClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected
  # cluster.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Describes the Cloud KMS encryption key that will be used to protect the
  #     destination Bigtable cluster. The requirements for this key are:
  #      1) The Cloud Bigtable service account associated with the project that
  #      contains this cluster must be granted the
  #      `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.
  #      2) Only regional keys can be used and the region of the CMEK key must
  #      match the region of the cluster.
  #      3) All clusters within an instance must use the same CMEK key.
  #     Values are of the form
  #     `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a cluster.
  module State
    # The state of the cluster could not be determined.
    STATE_NOT_KNOWN = 0

    # The cluster has been successfully created and is ready to serve requests.
    READY = 1

    # The cluster is currently being created, and may be destroyed
    # if the creation process encounters an error.
    # A cluster may not be able to serve requests while being created.
    CREATING = 2

    # The cluster is currently being resized, and may revert to its previous
    # node count if the process encounters an error.
    # A cluster is still capable of serving requests while being resized,
    # but may exhibit performance as if its number of allocated nodes is
    # between the starting and requested states.
    RESIZING = 3

    # The cluster has no backing nodes. The data (tables) still
    # exist, but no operations can be performed on the cluster.
    DISABLED = 4
  end
end

#default_storage_type ⇒ ::Google::Cloud::Bigtable::Admin::V2::StorageType

Returns Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

Returns:



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 172

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Autoscaling config for a cluster.
  # @!attribute [rw] autoscaling_limits
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingLimits]
  #     Required. Autoscaling limits for this cluster.
  # @!attribute [rw] autoscaling_targets
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingTargets]
  #     Required. Autoscaling targets for this cluster.
  class ClusterAutoscalingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a cluster.
  # @!attribute [rw] cluster_autoscaling_config
  #   @return [::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterAutoscalingConfig]
  #     Autoscaling configuration for this cluster.
  class ClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected
  # cluster.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Describes the Cloud KMS encryption key that will be used to protect the
  #     destination Bigtable cluster. The requirements for this key are:
  #      1) The Cloud Bigtable service account associated with the project that
  #      contains this cluster must be granted the
  #      `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.
  #      2) Only regional keys can be used and the region of the CMEK key must
  #      match the region of the cluster.
  #      3) All clusters within an instance must use the same CMEK key.
  #     Values are of the form
  #     `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a cluster.
  module State
    # The state of the cluster could not be determined.
    STATE_NOT_KNOWN = 0

    # The cluster has been successfully created and is ready to serve requests.
    READY = 1

    # The cluster is currently being created, and may be destroyed
    # if the creation process encounters an error.
    # A cluster may not be able to serve requests while being created.
    CREATING = 2

    # The cluster is currently being resized, and may revert to its previous
    # node count if the process encounters an error.
    # A cluster is still capable of serving requests while being resized,
    # but may exhibit performance as if its number of allocated nodes is
    # between the starting and requested states.
    RESIZING = 3

    # The cluster has no backing nodes. The data (tables) still
    # exist, but no operations can be performed on the cluster.
    DISABLED = 4
  end
end

#encryption_config ⇒ ::Google::Cloud::Bigtable::Admin::V2::Cluster::EncryptionConfig

Returns Immutable. The encryption configuration for CMEK-protected clusters.

Returns:



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 172

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Autoscaling config for a cluster.
  # @!attribute [rw] autoscaling_limits
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingLimits]
  #     Required. Autoscaling limits for this cluster.
  # @!attribute [rw] autoscaling_targets
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingTargets]
  #     Required. Autoscaling targets for this cluster.
  class ClusterAutoscalingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a cluster.
  # @!attribute [rw] cluster_autoscaling_config
  #   @return [::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterAutoscalingConfig]
  #     Autoscaling configuration for this cluster.
  class ClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected
  # cluster.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Describes the Cloud KMS encryption key that will be used to protect the
  #     destination Bigtable cluster. The requirements for this key are:
  #      1) The Cloud Bigtable service account associated with the project that
  #      contains this cluster must be granted the
  #      `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.
  #      2) Only regional keys can be used and the region of the CMEK key must
  #      match the region of the cluster.
  #      3) All clusters within an instance must use the same CMEK key.
  #     Values are of the form
  #     `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a cluster.
  module State
    # The state of the cluster could not be determined.
    STATE_NOT_KNOWN = 0

    # The cluster has been successfully created and is ready to serve requests.
    READY = 1

    # The cluster is currently being created, and may be destroyed
    # if the creation process encounters an error.
    # A cluster may not be able to serve requests while being created.
    CREATING = 2

    # The cluster is currently being resized, and may revert to its previous
    # node count if the process encounters an error.
    # A cluster is still capable of serving requests while being resized,
    # but may exhibit performance as if its number of allocated nodes is
    # between the starting and requested states.
    RESIZING = 3

    # The cluster has no backing nodes. The data (tables) still
    # exist, but no operations can be performed on the cluster.
    DISABLED = 4
  end
end

#location ⇒ ::String

Returns Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form projects/{project}/locations/{zone}.

Returns:

  • (::String) —

    Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form projects/{project}/locations/{zone}.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 172

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Autoscaling config for a cluster.
  # @!attribute [rw] autoscaling_limits
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingLimits]
  #     Required. Autoscaling limits for this cluster.
  # @!attribute [rw] autoscaling_targets
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingTargets]
  #     Required. Autoscaling targets for this cluster.
  class ClusterAutoscalingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a cluster.
  # @!attribute [rw] cluster_autoscaling_config
  #   @return [::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterAutoscalingConfig]
  #     Autoscaling configuration for this cluster.
  class ClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected
  # cluster.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Describes the Cloud KMS encryption key that will be used to protect the
  #     destination Bigtable cluster. The requirements for this key are:
  #      1) The Cloud Bigtable service account associated with the project that
  #      contains this cluster must be granted the
  #      `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.
  #      2) Only regional keys can be used and the region of the CMEK key must
  #      match the region of the cluster.
  #      3) All clusters within an instance must use the same CMEK key.
  #     Values are of the form
  #     `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a cluster.
  module State
    # The state of the cluster could not be determined.
    STATE_NOT_KNOWN = 0

    # The cluster has been successfully created and is ready to serve requests.
    READY = 1

    # The cluster is currently being created, and may be destroyed
    # if the creation process encounters an error.
    # A cluster may not be able to serve requests while being created.
    CREATING = 2

    # The cluster is currently being resized, and may revert to its previous
    # node count if the process encounters an error.
    # A cluster is still capable of serving requests while being resized,
    # but may exhibit performance as if its number of allocated nodes is
    # between the starting and requested states.
    RESIZING = 3

    # The cluster has no backing nodes. The data (tables) still
    # exist, but no operations can be performed on the cluster.
    DISABLED = 4
  end
end

#name ⇒ ::String

Returns The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.

Returns:

  • (::String) —

    The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 172

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Autoscaling config for a cluster.
  # @!attribute [rw] autoscaling_limits
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingLimits]
  #     Required. Autoscaling limits for this cluster.
  # @!attribute [rw] autoscaling_targets
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingTargets]
  #     Required. Autoscaling targets for this cluster.
  class ClusterAutoscalingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a cluster.
  # @!attribute [rw] cluster_autoscaling_config
  #   @return [::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterAutoscalingConfig]
  #     Autoscaling configuration for this cluster.
  class ClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected
  # cluster.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Describes the Cloud KMS encryption key that will be used to protect the
  #     destination Bigtable cluster. The requirements for this key are:
  #      1) The Cloud Bigtable service account associated with the project that
  #      contains this cluster must be granted the
  #      `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.
  #      2) Only regional keys can be used and the region of the CMEK key must
  #      match the region of the cluster.
  #      3) All clusters within an instance must use the same CMEK key.
  #     Values are of the form
  #     `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a cluster.
  module State
    # The state of the cluster could not be determined.
    STATE_NOT_KNOWN = 0

    # The cluster has been successfully created and is ready to serve requests.
    READY = 1

    # The cluster is currently being created, and may be destroyed
    # if the creation process encounters an error.
    # A cluster may not be able to serve requests while being created.
    CREATING = 2

    # The cluster is currently being resized, and may revert to its previous
    # node count if the process encounters an error.
    # A cluster is still capable of serving requests while being resized,
    # but may exhibit performance as if its number of allocated nodes is
    # between the starting and requested states.
    RESIZING = 3

    # The cluster has no backing nodes. The data (tables) still
    # exist, but no operations can be performed on the cluster.
    DISABLED = 4
  end
end

#serve_nodes ⇒ ::Integer

Returns The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

Returns:

  • (::Integer) —

    The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 172

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Autoscaling config for a cluster.
  # @!attribute [rw] autoscaling_limits
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingLimits]
  #     Required. Autoscaling limits for this cluster.
  # @!attribute [rw] autoscaling_targets
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingTargets]
  #     Required. Autoscaling targets for this cluster.
  class ClusterAutoscalingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a cluster.
  # @!attribute [rw] cluster_autoscaling_config
  #   @return [::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterAutoscalingConfig]
  #     Autoscaling configuration for this cluster.
  class ClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected
  # cluster.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Describes the Cloud KMS encryption key that will be used to protect the
  #     destination Bigtable cluster. The requirements for this key are:
  #      1) The Cloud Bigtable service account associated with the project that
  #      contains this cluster must be granted the
  #      `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.
  #      2) Only regional keys can be used and the region of the CMEK key must
  #      match the region of the cluster.
  #      3) All clusters within an instance must use the same CMEK key.
  #     Values are of the form
  #     `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a cluster.
  module State
    # The state of the cluster could not be determined.
    STATE_NOT_KNOWN = 0

    # The cluster has been successfully created and is ready to serve requests.
    READY = 1

    # The cluster is currently being created, and may be destroyed
    # if the creation process encounters an error.
    # A cluster may not be able to serve requests while being created.
    CREATING = 2

    # The cluster is currently being resized, and may revert to its previous
    # node count if the process encounters an error.
    # A cluster is still capable of serving requests while being resized,
    # but may exhibit performance as if its number of allocated nodes is
    # between the starting and requested states.
    RESIZING = 3

    # The cluster has no backing nodes. The data (tables) still
    # exist, but no operations can be performed on the cluster.
    DISABLED = 4
  end
end

#state ⇒ ::Google::Cloud::Bigtable::Admin::V2::Cluster::State (readonly)

Returns Output only. The current state of the cluster.

Returns:



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 172

class Cluster
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Autoscaling config for a cluster.
  # @!attribute [rw] autoscaling_limits
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingLimits]
  #     Required. Autoscaling limits for this cluster.
  # @!attribute [rw] autoscaling_targets
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AutoscalingTargets]
  #     Required. Autoscaling targets for this cluster.
  class ClusterAutoscalingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a cluster.
  # @!attribute [rw] cluster_autoscaling_config
  #   @return [::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterAutoscalingConfig]
  #     Autoscaling configuration for this cluster.
  class ClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected
  # cluster.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Describes the Cloud KMS encryption key that will be used to protect the
  #     destination Bigtable cluster. The requirements for this key are:
  #      1) The Cloud Bigtable service account associated with the project that
  #      contains this cluster must be granted the
  #      `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.
  #      2) Only regional keys can be used and the region of the CMEK key must
  #      match the region of the cluster.
  #      3) All clusters within an instance must use the same CMEK key.
  #     Values are of the form
  #     `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a cluster.
  module State
    # The state of the cluster could not be determined.
    STATE_NOT_KNOWN = 0

    # The cluster has been successfully created and is ready to serve requests.
    READY = 1

    # The cluster is currently being created, and may be destroyed
    # if the creation process encounters an error.
    # A cluster may not be able to serve requests while being created.
    CREATING = 2

    # The cluster is currently being resized, and may revert to its previous
    # node count if the process encounters an error.
    # A cluster is still capable of serving requests while being resized,
    # but may exhibit performance as if its number of allocated nodes is
    # between the starting and requested states.
    RESIZING = 3

    # The cluster has no backing nodes. The data (tables) still
    # exist, but no operations can be performed on the cluster.
    DISABLED = 4
  end
end