Class: Google::Cloud::Spanner::Admin::Instance::V1::InstancePartition

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

Overview

An isolated set of Cloud Spanner resources that databases can define placements on.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#config ⇒ ::String

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

Returns:

  • (::String) —

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



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1155

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

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

    # The instance partition is still being created. Resources may not be
    # available yet, and operations such as creating placements using this
    # instance partition may not work.
    CREATING = 1

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

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

Returns Output only. The time at which the instance partition was created.

Returns:



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1155

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

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

    # The instance partition is still being created. Resources may not be
    # available yet, and operations such as creating placements using this
    # instance partition may not work.
    CREATING = 1

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

#display_name ⇒ ::String

Returns Required. The descriptive name for this instance partition 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 partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1155

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

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

    # The instance partition is still being created. Resources may not be
    # available yet, and operations such as creating placements using this
    # instance partition may not work.
    CREATING = 1

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

#etag ⇒ ::String

Returns Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly.

Returns:

  • (::String) —

    Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly.



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1155

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

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

    # The instance partition is still being created. Resources may not be
    # available yet, and operations such as creating placements using this
    # instance partition may not work.
    CREATING = 1

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

#name ⇒ ::String

Returns Required. A unique identifier for the instance partition. Values are of the form projects/<project>/instances/<instance>/instancePartitions/[a-z][-a-z0-9]*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created.

Returns:

  • (::String) —

    Required. A unique identifier for the instance partition. Values are of the form projects/<project>/instances/<instance>/instancePartitions/[a-z][-a-z0-9]*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created.



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1155

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

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

    # The instance partition is still being created. Resources may not be
    # available yet, and operations such as creating placements using this
    # instance partition may not work.
    CREATING = 1

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

#node_count ⇒ ::Integer

Returns The number of nodes allocated to this instance partition.

Users can set the node_count field to specify the target number of nodes allocated to the instance partition.

This may be zero in API responses for instance partitions that are not yet in state READY.

Note: The following fields are mutually exclusive: node_count, processing_units. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Integer) —

    The number of nodes allocated to this instance partition.

    Users can set the node_count field to specify the target number of nodes allocated to the instance partition.

    This may be zero in API responses for instance partitions that are not yet in state READY.

    Note: The following fields are mutually exclusive: node_count, processing_units. If a field in that set is populated, all other fields in the set will automatically be cleared.



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1155

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

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

    # The instance partition is still being created. Resources may not be
    # available yet, and operations such as creating placements using this
    # instance partition may not work.
    CREATING = 1

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

#processing_units ⇒ ::Integer

Returns The number of processing units allocated to this instance partition.

Users can set the processing_units field to specify the target number of processing units allocated to the instance partition.

This might be zero in API responses for instance partitions that are not yet in the READY state.

Note: The following fields are mutually exclusive: processing_units, node_count. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Integer) —

    The number of processing units allocated to this instance partition.

    Users can set the processing_units field to specify the target number of processing units allocated to the instance partition.

    This might be zero in API responses for instance partitions that are not yet in the READY state.

    Note: The following fields are mutually exclusive: processing_units, node_count. If a field in that set is populated, all other fields in the set will automatically be cleared.



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1155

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

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

    # The instance partition is still being created. Resources may not be
    # available yet, and operations such as creating placements using this
    # instance partition may not work.
    CREATING = 1

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

#referencing_backups ⇒ ::Array<::String> (readonly)

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Output only. Deprecated: This field is not populated. Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted.

Returns:

  • (::Array<::String>) —

    Output only. Deprecated: This field is not populated. Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted.



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1155

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

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

    # The instance partition is still being created. Resources may not be
    # available yet, and operations such as creating placements using this
    # instance partition may not work.
    CREATING = 1

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

#referencing_databases ⇒ ::Array<::String> (readonly)

Returns Output only. The names of the databases that reference this instance partition. Referencing databases should share the parent instance. The existence of any referencing database prevents the instance partition from being deleted.

Returns:

  • (::Array<::String>) —

    Output only. The names of the databases that reference this instance partition. Referencing databases should share the parent instance. The existence of any referencing database prevents the instance partition from being deleted.



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1155

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

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

    # The instance partition is still being created. Resources may not be
    # available yet, and operations such as creating placements using this
    # instance partition may not work.
    CREATING = 1

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

#state ⇒ ::Google::Cloud::Spanner::Admin::Instance::V1::InstancePartition::State (readonly)

Returns Output only. The current instance partition state.

Returns:



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1155

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

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

    # The instance partition is still being created. Resources may not be
    # available yet, and operations such as creating placements using this
    # instance partition may not work.
    CREATING = 1

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

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the instance partition was most recently updated.

Returns:



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1155

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

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

    # The instance partition is still being created. Resources may not be
    # available yet, and operations such as creating placements using this
    # instance partition may not work.
    CREATING = 1

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