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

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 on which databases can be hosted.

Defined Under Namespace

Modules: DefaultBackupScheduleType, Edition, State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#autoscaling_config ⇒ ::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig

Returns Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.

Returns:

  • (::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig) —

    Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end

#config ⇒ ::String

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

Returns:

  • (::String) —

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



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end

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

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

Returns:



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end

#default_backup_schedule_type ⇒ ::Google::Cloud::Spanner::Admin::Instance::V1::Instance::DefaultBackupScheduleType

Returns Optional. Controls the default backup behavior for new databases within the instance.

Note that AUTOMATIC is not permitted for free instances, as backups and backup schedules are not allowed for free instances.

In the GetInstance or ListInstances response, if the value of default_backup_schedule_type is unset or NONE, no default backup schedule will be created for new databases within the instance.

Returns:

  • (::Google::Cloud::Spanner::Admin::Instance::V1::Instance::DefaultBackupScheduleType) —

    Optional. Controls the default backup behavior for new databases within the instance.

    Note that AUTOMATIC is not permitted for free instances, as backups and backup schedules are not allowed for free instances.

    In the GetInstance or ListInstances response, if the value of default_backup_schedule_type is unset or NONE, no default backup schedule will be created for new databases within the instance.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 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.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end

#edition ⇒ ::Google::Cloud::Spanner::Admin::Instance::V1::Instance::Edition

Returns Optional. The Edition of the current instance.

Returns:



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end

#endpoint_uris ⇒ ::Array<::String>

Returns Deprecated. This field is not populated.

Returns:

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

    Deprecated. This field is not populated.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end

#labels ⇒ ::Google::Protobuf::Map{::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][a-z0-9_-]{0,62}.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}.
  • 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:

  • (::Google::Protobuf::Map{::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][a-z0-9_-]{0,62}.
    • Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}.
    • 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.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 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/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]. The final segment of the name must be between 2 and 64 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/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end

#node_count ⇒ ::Integer

Returns The number of nodes allocated to this instance. At most, one of either node_count or processing_units should be present in the message.

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

If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance.

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

If the instance has varying node count across replicas (achieved by setting asymmetric_autoscaling_options in autoscaling config), the node_count here is the maximum node count across all replicas.

For more information, see Compute capacity, nodes, and processing units.

Returns:

  • (::Integer) —

    The number of nodes allocated to this instance. At most, one of either node_count or processing_units should be present in the message.

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

    If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance.

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

    If the instance has varying node count across replicas (achieved by setting asymmetric_autoscaling_options in autoscaling config), the node_count here is the maximum node count across all replicas.

    For more information, see Compute capacity, nodes, and processing units.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end

#processing_units ⇒ ::Integer

Returns The number of processing units allocated to this instance. At most, one of either processing_units or node_count should be present in the message.

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

If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance.

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

If the instance has varying processing units per replica (achieved by setting asymmetric_autoscaling_options in autoscaling config), the processing_units here is the maximum processing units across all replicas.

For more information, see Compute capacity, nodes and processing units.

Returns:

  • (::Integer) —

    The number of processing units allocated to this instance. At most, one of either processing_units or node_count should be present in the message.

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

    If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance.

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

    If the instance has varying processing units per replica (achieved by setting asymmetric_autoscaling_options in autoscaling config), the processing_units here is the maximum processing units across all replicas.

    For more information, see Compute capacity, nodes and processing units.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end

#replica_compute_capacity ⇒ ::Array<::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaComputeCapacity> (readonly)

Returns Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity.

Returns:



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end

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

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:



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end

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

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

Returns:



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 444

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

  # The edition selected for this instance. Different editions provide
  # different capabilities at different price points.
  module Edition
    # Edition not specified.
    EDITION_UNSPECIFIED = 0

    # Standard edition.
    STANDARD = 1

    # Enterprise edition.
    ENTERPRISE = 2

    # Enterprise Plus edition.
    ENTERPRISE_PLUS = 3
  end

  # Indicates the default backup behavior for new databases within the
  # instance.
  module DefaultBackupScheduleType
    # Not specified.
    DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0

    # No default backup schedule will be created automatically on creation of a
    # database within the instance.
    NONE = 1

    # A default backup schedule will be created automatically on creation of a
    # database within the instance. The default backup schedule creates a full
    # backup every 24 hours and retains the backup for a period of 7 days. Once
    # created, the default backup schedule can be edited/deleted similar to any
    # other backup schedule.
    AUTOMATIC = 2
  end
end