Class: Google::Spanner::Admin::Instance::V1::Instance

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb

Overview

An isolated set of Cloud Spanner resources on which databases can be hosted.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#config ⇒ String

Returns Required. The name of the instance's configuration. Values are of the form +projects//instanceConfigs/+. See also InstanceConfig and ListInstanceConfigs.

Returns:

  • (String) —

    Required. The name of the instance's configuration. Values are of the form +projects//instanceConfigs/+. See also InstanceConfig and ListInstanceConfigs.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 97

class Instance
  # Indicates the current state of the instance.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The instance is still being created. Resources may not be
    # available yet, and operations such as database creation may not
    # work.
    CREATING = 1

    # The instance is fully created and ready to do work such as
    # creating databases.
    READY = 2
  end
end

#display_name ⇒ String

Returns Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

Returns:

  • (String) —

    Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 97

class Instance
  # Indicates the current state of the instance.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The instance is still being created. Resources may not be
    # available yet, and operations such as database creation may not
    # work.
    CREATING = 1

    # The instance is fully created and ready to do work such as
    # creating databases.
    READY = 2
  end
end

#labels ⇒ Hash{String => String}

Returns Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

  • Label keys must be between 1 and 63 characters long and must conform to the following regular expression: +a-z?+.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression +(a-z?)?+.
  • No more than 64 labels can be associated with a given resource.

See https://goo.gl/xmQnxf for more information on and examples of labels.

If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.

Returns:

  • (Hash{String => String}) —

    Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

    • Label keys must be between 1 and 63 characters long and must conform to the following regular expression: +a-z?+.
    • Label values must be between 0 and 63 characters long and must conform to the regular expression +(a-z?)?+.
    • No more than 64 labels can be associated with a given resource.

    See https://goo.gl/xmQnxf for more information on and examples of labels.

    If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 97

class Instance
  # Indicates the current state of the instance.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The instance is still being created. Resources may not be
    # available yet, and operations such as database creation may not
    # work.
    CREATING = 1

    # The instance is fully created and ready to do work such as
    # creating databases.
    READY = 2
  end
end

#name ⇒ String

Returns Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form +projects//instances/[a-z][-a-z0-9]*[a-z0-9]+. The final segment of the name must be between 6 and 30 characters in length.

Returns:

  • (String) —

    Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form +projects//instances/[a-z][-a-z0-9]*[a-z0-9]+. The final segment of the name must be between 6 and 30 characters in length.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 97

class Instance
  # Indicates the current state of the instance.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The instance is still being created. Resources may not be
    # available yet, and operations such as database creation may not
    # work.
    CREATING = 1

    # The instance is fully created and ready to do work such as
    # creating databases.
    READY = 2
  end
end

#node_count ⇒ Integer

Returns Required. The number of nodes allocated to this instance. This may be zero in API responses for instances that are not yet in state +READY+.

See the documentation for more information about nodes.

Returns:

  • (Integer) —

    Required. The number of nodes allocated to this instance. This may be zero in API responses for instances that are not yet in state +READY+.

    See the documentation for more information about nodes.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 97

class Instance
  # Indicates the current state of the instance.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The instance is still being created. Resources may not be
    # available yet, and operations such as database creation may not
    # work.
    CREATING = 1

    # The instance is fully created and ready to do work such as
    # creating databases.
    READY = 2
  end
end

#state ⇒ Google::Spanner::Admin::Instance::V1::Instance::State

Returns Output only. The current instance state. For CreateInstance, the state must be either omitted or set to +CREATING+. For UpdateInstance, the state must be either omitted or set to +READY+.

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 97

class Instance
  # Indicates the current state of the instance.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The instance is still being created. Resources may not be
    # available yet, and operations such as database creation may not
    # work.
    CREATING = 1

    # The instance is fully created and ready to do work such as
    # creating databases.
    READY = 2
  end
end