Class: Google::Bigtable::Admin::V2::Instance

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb

Overview

A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.

Defined Under Namespace

Modules: State, Type

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ String

Returns Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

Returns:

  • (String) —

    Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 53

class Instance
  # Possible states of an instance.
  module State
    # The state of the instance could not be determined.
    STATE_NOT_KNOWN = 0

    # The instance has been successfully created and can serve requests
    # to its tables.
    READY = 1

    # The instance is currently being created, and may be destroyed
    # if the creation process encounters an error.
    CREATING = 2
  end

  # The type of the instance.
  module Type
    # The type of the instance is unspecified. If set when creating an
    # instance, a `PRODUCTION` instance will be created. If set when updating
    # an instance, the type will be left unchanged.
    TYPE_UNSPECIFIED = 0

    # An instance meant for production use. `serve_nodes` must be set
    # on the cluster.
    PRODUCTION = 1

    # The instance is meant for development and testing purposes only; it has
    # no performance or uptime guarantees and is not covered by SLA.
    # After a development instance is created, it can be upgraded by
    # updating the instance to type `PRODUCTION`. An instance created
    # as a production instance cannot be changed to a development instance.
    # When creating a development instance, `serve_nodes` on the cluster must
    # not be set.
    DEVELOPMENT = 2
  end
end

#labels ⇒ Hash{String => String}

Returns Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.

  • Label keys must be between 1 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}.
  • No more than 64 labels can be associated with a given resource.
  • Keys and values must both be under 128 bytes.

Returns:

  • (Hash{String => String}) —

    Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.

    • Label keys must be between 1 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}.
    • Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}.
    • No more than 64 labels can be associated with a given resource.
    • Keys and values must both be under 128 bytes.


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 53

class Instance
  # Possible states of an instance.
  module State
    # The state of the instance could not be determined.
    STATE_NOT_KNOWN = 0

    # The instance has been successfully created and can serve requests
    # to its tables.
    READY = 1

    # The instance is currently being created, and may be destroyed
    # if the creation process encounters an error.
    CREATING = 2
  end

  # The type of the instance.
  module Type
    # The type of the instance is unspecified. If set when creating an
    # instance, a `PRODUCTION` instance will be created. If set when updating
    # an instance, the type will be left unchanged.
    TYPE_UNSPECIFIED = 0

    # An instance meant for production use. `serve_nodes` must be set
    # on the cluster.
    PRODUCTION = 1

    # The instance is meant for development and testing purposes only; it has
    # no performance or uptime guarantees and is not covered by SLA.
    # After a development instance is created, it can be upgraded by
    # updating the instance to type `PRODUCTION`. An instance created
    # as a production instance cannot be changed to a development instance.
    # When creating a development instance, `serve_nodes` on the cluster must
    # not be set.
    DEVELOPMENT = 2
  end
end

#name ⇒ String

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

Returns:

  • (String) —

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 53

class Instance
  # Possible states of an instance.
  module State
    # The state of the instance could not be determined.
    STATE_NOT_KNOWN = 0

    # The instance has been successfully created and can serve requests
    # to its tables.
    READY = 1

    # The instance is currently being created, and may be destroyed
    # if the creation process encounters an error.
    CREATING = 2
  end

  # The type of the instance.
  module Type
    # The type of the instance is unspecified. If set when creating an
    # instance, a `PRODUCTION` instance will be created. If set when updating
    # an instance, the type will be left unchanged.
    TYPE_UNSPECIFIED = 0

    # An instance meant for production use. `serve_nodes` must be set
    # on the cluster.
    PRODUCTION = 1

    # The instance is meant for development and testing purposes only; it has
    # no performance or uptime guarantees and is not covered by SLA.
    # After a development instance is created, it can be upgraded by
    # updating the instance to type `PRODUCTION`. An instance created
    # as a production instance cannot be changed to a development instance.
    # When creating a development instance, `serve_nodes` on the cluster must
    # not be set.
    DEVELOPMENT = 2
  end
end

#state ⇒ Google::Bigtable::Admin::V2::Instance::State

Returns (OutputOnly) The current state of the instance.

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 53

class Instance
  # Possible states of an instance.
  module State
    # The state of the instance could not be determined.
    STATE_NOT_KNOWN = 0

    # The instance has been successfully created and can serve requests
    # to its tables.
    READY = 1

    # The instance is currently being created, and may be destroyed
    # if the creation process encounters an error.
    CREATING = 2
  end

  # The type of the instance.
  module Type
    # The type of the instance is unspecified. If set when creating an
    # instance, a `PRODUCTION` instance will be created. If set when updating
    # an instance, the type will be left unchanged.
    TYPE_UNSPECIFIED = 0

    # An instance meant for production use. `serve_nodes` must be set
    # on the cluster.
    PRODUCTION = 1

    # The instance is meant for development and testing purposes only; it has
    # no performance or uptime guarantees and is not covered by SLA.
    # After a development instance is created, it can be upgraded by
    # updating the instance to type `PRODUCTION`. An instance created
    # as a production instance cannot be changed to a development instance.
    # When creating a development instance, `serve_nodes` on the cluster must
    # not be set.
    DEVELOPMENT = 2
  end
end

#type ⇒ Google::Bigtable::Admin::V2::Instance::Type

Returns The type of the instance. Defaults to PRODUCTION.

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 53

class Instance
  # Possible states of an instance.
  module State
    # The state of the instance could not be determined.
    STATE_NOT_KNOWN = 0

    # The instance has been successfully created and can serve requests
    # to its tables.
    READY = 1

    # The instance is currently being created, and may be destroyed
    # if the creation process encounters an error.
    CREATING = 2
  end

  # The type of the instance.
  module Type
    # The type of the instance is unspecified. If set when creating an
    # instance, a `PRODUCTION` instance will be created. If set when updating
    # an instance, the type will be left unchanged.
    TYPE_UNSPECIFIED = 0

    # An instance meant for production use. `serve_nodes` must be set
    # on the cluster.
    PRODUCTION = 1

    # The instance is meant for development and testing purposes only; it has
    # no performance or uptime guarantees and is not covered by SLA.
    # After a development instance is created, it can be upgraded by
    # updating the instance to type `PRODUCTION`. An instance created
    # as a production instance cannot be changed to a development instance.
    # When creating a development instance, `serve_nodes` on the cluster must
    # not be set.
    DEVELOPMENT = 2
  end
end