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

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



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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}).



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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.



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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:



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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:



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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.



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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.



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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.



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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:



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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:



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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.



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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}


888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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.



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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.



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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:



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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:



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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.



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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:



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 888

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

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

  # @!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