Class: Google::Cloud::AlloyDB::V1::Backup

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

Overview

Message describing Backup object

Defined Under Namespace

Modules: State, Type Classes: AnnotationsEntry, LabelsEntry, QuantityBasedExpiry

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



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#cluster_name ⇒ ::String

Returns Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

Returns:

  • (::String) —

    Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#cluster_uid ⇒ ::String (readonly)

Returns Output only. The system-generated UID of the cluster which was used to create this resource.

Returns:

  • (::String) —

    Output only. The system-generated UID of the cluster which was used to create this resource.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

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

Returns Output only. Create time stamp.

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#database_version ⇒ ::Google::Cloud::AlloyDB::V1::DatabaseVersion (readonly)

Returns Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.

Returns:

  • (::Google::Cloud::AlloyDB::V1::DatabaseVersion) —

    Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

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

Returns Output only. Delete time stamp.

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#description ⇒ ::String

Returns User-provided description of the backup.

Returns:

  • (::String) —

    User-provided description of the backup.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#display_name ⇒ ::String

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

Returns:

  • (::String) —

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



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#encryption_config ⇒ ::Google::Cloud::AlloyDB::V1::EncryptionConfig

Returns Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

Returns:

  • (::Google::Cloud::AlloyDB::V1::EncryptionConfig) —

    Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#encryption_info ⇒ ::Google::Cloud::AlloyDB::V1::EncryptionInfo (readonly)

Returns Output only. The encryption information for the backup.

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#etag ⇒ ::String

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

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#expiry_quantity ⇒ ::Google::Cloud::AlloyDB::V1::Backup::QuantityBasedExpiry (readonly)

Returns Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

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

Returns Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  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



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#name ⇒ ::String (readonly)

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

  • projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup 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 backup resource name is the name of the parent resource:
  • projects/{project}/locations/{region}.

Returns:

  • (::String) —

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

    • projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup 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 backup resource name is the name of the parent resource:
    • projects/{project}/locations/{region}


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#reconciling ⇒ ::Boolean (readonly)

Returns Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. 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), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#size_bytes ⇒ ::Integer (readonly)

Returns Output only. The size of the backup in bytes.

Returns:

  • (::Integer) —

    Output only. The size of the backup in bytes.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#state ⇒ ::Google::Cloud::AlloyDB::V1::Backup::State (readonly)

Returns Output only. The current state of the backup.

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

#type ⇒ ::Google::Cloud::AlloyDB::V1::Backup::Type

Returns The backup type, which suggests the trigger for the backup.

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  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.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end

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

Returns Output only. Update time stamp.

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 963

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

  # A backup's position in a quantity-based retention queue, of backups with
  # the same source cluster and type, with length, retention, specified by the
  # backup's retention policy.
  # Once the position is greater than the retention, the backup is eligible to
  # be garbage collected.
  #
  # Example: 5 backups from the same source cluster and type with a
  # quantity-based retention of 3 and denoted by backup_id (position,
  # retention).
  #
  # Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3).
  # Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
  # @!attribute [r] retention_count
  #   @return [::Integer]
  #     Output only. The backup's position among its backups with the same source
  #     cluster and type, by descending chronological order create time(i.e.
  #     newest first).
  # @!attribute [r] total_retention_count
  #   @return [::Integer]
  #     Output only. The length of the quantity-based queue, specified by the
  #     backup's retention policy.
  class QuantityBasedExpiry
    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 AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backup State
  module State
    # The state of the backup is unknown.
    STATE_UNSPECIFIED = 0

    # The backup is ready.
    READY = 1

    # The backup is creating.
    CREATING = 2

    # The backup failed.
    FAILED = 3

    # The backup is being deleted.
    DELETING = 4
  end

  # Backup Type
  module Type
    # Backup Type is unknown.
    TYPE_UNSPECIFIED = 0

    # ON_DEMAND backups that were triggered by the customer (e.g., not
    # AUTOMATED).
    ON_DEMAND = 1

    # AUTOMATED backups triggered by the automated backups scheduler pursuant
    # to an automated backup policy.
    AUTOMATED = 2

    # CONTINUOUS backups triggered by the automated backups scheduler
    # due to a continuous backup policy.
    CONTINUOUS = 3
  end
end