Class: Google::Cloud::AlloyDB::V1alpha::Instance

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/alloydb/v1alpha/resources.rb

Overview

An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.

Defined Under Namespace

Modules: AvailabilityType, InstanceType, State Classes: AnnotationsEntry, ClientConnectionConfig, DatabaseFlagsEntry, LabelsEntry, MachineConfig, Node, QueryInsightsInstanceConfig, ReadPoolConfig, UpdatePolicy

Instance Attribute Summary collapse

Instance Attribute Details

#annotations::Google::Protobuf::Map{::String => ::String}

Returns Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128.

Returns:

  • (::Google::Protobuf::Map{::String => ::String})

    Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#availability_type::Google::Cloud::AlloyDB::V1alpha::Instance::AvailabilityType

Returns Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).

Returns:

  • (::Google::Cloud::AlloyDB::V1alpha::Instance::AvailabilityType)

    Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#client_connection_config::Google::Cloud::AlloyDB::V1alpha::Instance::ClientConnectionConfig

Returns Optional. Client connection specific configurations.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

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

Returns Output only. Create time stamp.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#database_flags::Google::Protobuf::Map{::String => ::String}

Returns Database flags. Set at instance level.

  • They are copied from primary instance on read instance creation.
  • Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary.

This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

Returns:

  • (::Google::Protobuf::Map{::String => ::String})

    Database flags. Set at instance level.

    • They are copied from primary instance on read instance creation.
    • Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary.

    This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#delete_time::Google::Protobuf::Timestamp (readonly)

Returns Output only. Delete time stamp.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#display_name::String

Returns User-settable and human-readable display name for the Instance.

Returns:

  • (::String)

    User-settable and human-readable display name for the Instance.



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#etag::String

Returns For Resource freshness validation (https://google.aip.dev/154).

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#gce_zone::String

Returns The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.

Returns:

  • (::String)

    The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#instance_type::Google::Cloud::AlloyDB::V1alpha::Instance::InstanceType

Returns Required. The type of the instance. Specified at creation time.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#ip_address::String (readonly)

Returns Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.

Returns:

  • (::String)

    Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#labels::Google::Protobuf::Map{::String => ::String}

Returns Labels as key value pairs.

Returns:

  • (::Google::Protobuf::Map{::String => ::String})

    Labels as key value pairs



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#machine_config::Google::Cloud::AlloyDB::V1alpha::Instance::MachineConfig

Returns Configurations for the machines that host the underlying database engine.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#name::String (readonly)

Returns Output only. The name of the instance resource with the format:

  • projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource:
  • projects/{project}/locations/{region}/clusters/{cluster_id}.

Returns:

  • (::String)

    Output only. The name of the instance resource with the format:

    • projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource:
    • projects/{project}/locations/{region}/clusters/{cluster_id}


681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#nodes::Array<::Google::Cloud::AlloyDB::V1alpha::Instance::Node> (readonly)

Returns Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#query_insights_config::Google::Cloud::AlloyDB::V1alpha::Instance::QueryInsightsInstanceConfig

Returns Configuration for query insights.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#read_pool_config::Google::Cloud::AlloyDB::V1alpha::Instance::ReadPoolConfig

Returns Read pool specific config.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#reconciling::Boolean (readonly)

Returns Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

Returns:

  • (::Boolean)

    Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#satisfies_pzs::Boolean

Returns Reserved for future use.

Returns:

  • (::Boolean)

    Reserved for future use.



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#state::Google::Cloud::AlloyDB::V1alpha::Instance::State (readonly)

Returns Output only. The current serving state of the instance.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#uid::String (readonly)

Returns Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

Returns:

  • (::String)

    Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#update_policy::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy

Returns Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.

Returns:

  • (::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy)

    Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

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

Returns Output only. Update time stamp.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end

#writable_node::Google::Cloud::AlloyDB::V1alpha::Instance::Node (readonly)

Returns Output only. This is set for the read-write VM of the PRIMARY instance only.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 681

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

  # MachineConfig describes the configuration of a machine.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     The number of CPU's in the VM instance.
  class MachineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details of a single node in the instance.
  # Nodes in an AlloyDB instance are ephemereal, they can change during
  # update, failover, autohealing and resize operations.
  # @!attribute [rw] zone_id
  #   @return [::String]
  #     The Compute Engine zone of the VM e.g. "us-central1-b".
  # @!attribute [rw] id
  #   @return [::String]
  #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
  # @!attribute [rw] ip
  #   @return [::String]
  #     The private IP address of the VM e.g. "10.57.0.34".
  # @!attribute [rw] state
  #   @return [::String]
  #     Determined by state of the compute VM and postgres-service health.
  #     Compute VM state can have values listed in
  #     https://cloud.google.com/compute/docs/instances/instance-life-cycle and
  #     postgres-service health can have values: HEALTHY and UNHEALTHY.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # QueryInsights Instance specific configuration.
  # @!attribute [rw] record_application_tags
  #   @return [::Boolean]
  #     Record application tags for an instance.
  #     This flag is turned "on" by default.
  # @!attribute [rw] record_client_address
  #   @return [::Boolean]
  #     Record client address for an instance. Client address is PII information.
  #     This flag is turned "on" by default.
  # @!attribute [rw] query_string_length
  #   @return [::Integer]
  #     Query string length. The default value is 1024.
  #     Any integer between 256 and 4500 is considered valid.
  # @!attribute [rw] query_plans_per_minute
  #   @return [::Integer]
  #     Number of query execution plans captured by Insights per minute
  #     for all queries combined. The default value is 5.
  #     Any integer between 0 and 20 is considered valid.
  class QueryInsightsInstanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a read pool instance.
  # @!attribute [rw] node_count
  #   @return [::Integer]
  #     Read capacity, i.e. number of nodes in a read pool instance.
  class ReadPoolConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Policy to be used while updating the instance.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Instance::UpdatePolicy::Mode]
  #     Mode for updating the instance.
  class UpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the available modes of update.
    module Mode
      # Mode is unknown.
      MODE_UNSPECIFIED = 0

      # Least disruptive way to apply the update.
      DEFAULT = 1

      # Performs a forced update when applicable. This will be fast but may
      # incur a downtime.
      FORCE_APPLY = 2
    end
  end

  # Client connection configuration
  # @!attribute [rw] require_connectors
  #   @return [::Boolean]
  #     Optional. Configuration to enforce connectors only (ex: AuthProxy)
  #     connections to the database.
  # @!attribute [rw] ssl_config
  #   @return [::Google::Cloud::AlloyDB::V1alpha::SslConfig]
  #     Optional. SSL config option for this instance.
  class ClientConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

  # Instance State
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # The instance is active and running.
    READY = 1

    # The instance is stopped. Instance name and IP resources are preserved.
    STOPPED = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance.
    # Note: Instances in this state would tried to be auto-repaired. And
    # Customers should be able to restart, update or delete these instances.
    FAILED = 6

    # Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
    # index unused in case that state also needs to exposed via consumer apis
    # in future.
    # The instance has been configured to sync data from some other source.
    BOOTSTRAPPING = 8

    # The instance is being promoted.
    PROMOTING = 9
  end

  # Type of an Instance
  module InstanceType
    # The type of the instance is unknown.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # PRIMARY instances support read and write operations.
    PRIMARY = 1

    # READ POOL instances support read operations only. Each read pool instance
    # consists of one or more homogeneous nodes.
    #  * Read pool of size 1 can only have zonal availability.
    #  * Read pools with node count of 2 or more can have regional
    #    availability (nodes are present in 2 or more zones in a region).
    READ_POOL = 2

    # SECONDARY instances support read operations only. SECONDARY instance
    # is a cross-region read replica
    SECONDARY = 3
  end

  # The Availability type of an instance. Potential values:
  #
  # - ZONAL: The instance serves data from only one zone. Outages in that
  #     zone affect instance availability.
  # - REGIONAL: The instance can serve data from more than one zone in a
  #     region (it is highly available).
  module AvailabilityType
    # This is an unknown Availability type.
    AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal available instance.
    ZONAL = 1

    # Regional (or Highly) available instance.
    REGIONAL = 2
  end
end