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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigtable/admin/v2/doc/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

Instance Attribute Summary collapse

Instance Attribute Details

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

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

Returns:

  • (Google::Bigtable::Admin::V2::StorageType) —

    (+CreationOnly+) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 118

class Cluster
  # 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 (+CreationOnly+) 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//locations/+.

Returns:

  • (String) —

    (+CreationOnly+) 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//locations/+.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 118

class Cluster
  # 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 (+OutputOnly+) The unique name of the cluster. Values are of the form +projects//instances//clusters/[a-z][-a-z0-9]*+.

Returns:

  • (String) —

    (+OutputOnly+) The unique name of the cluster. Values are of the form +projects//instances//clusters/[a-z][-a-z0-9]*+.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 118

class Cluster
  # 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.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 118

class Cluster
  # 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::Bigtable::Admin::V2::Cluster::State

Returns (+OutputOnly+) The current state of the cluster.

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 118

class Cluster
  # 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