Class: Google::Cloud::GkeBackup::V1::VolumeBackup

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

Overview

Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts.

Defined Under Namespace

Modules: State, VolumeBackupFormat

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. The timestamp when the associated underlying volume backup operation completed.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

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

Returns Output only. The timestamp when this VolumeBackup resource was created.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

#disk_size_bytes ⇒ ::Integer (readonly)

Returns Output only. The minimum size of the disk to which this VolumeBackup can be restored.

Returns:

  • (::Integer) —

    Output only. The minimum size of the disk to which this VolumeBackup can be restored.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

#etag ⇒ ::String (readonly)

Returns Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform volume backup updates in order to avoid race conditions.

Returns:

  • (::String) —

    Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform volume backup updates in order to avoid race conditions.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

#format ⇒ ::Google::Cloud::GkeBackup::V1::VolumeBackup::VolumeBackupFormat (readonly)

Returns Output only. The format used for the volume backup.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.

Returns:

  • (::String) —

    Output only. The full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

#source_pvc ⇒ ::Google::Cloud::GkeBackup::V1::NamespacedName (readonly)

Returns Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

#state ⇒ ::Google::Cloud::GkeBackup::V1::VolumeBackup::State (readonly)

Returns Output only. The current state of this VolumeBackup.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

#state_message ⇒ ::String (readonly)

Returns Output only. A human readable message explaining why the VolumeBackup is in its current state.

Returns:

  • (::String) —

    Output only. A human readable message explaining why the VolumeBackup is in its current state.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

#storage_bytes ⇒ ::Integer (readonly)

Returns Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same volume share the same backup storage location. In particular, this is likely to increase in size when the immediately preceding backup of the same volume is deleted.

Returns:

  • (::Integer) —

    Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same volume share the same backup storage location. In particular, this is likely to increase in size when the immediately preceding backup of the same volume is deleted.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. Server generated global unique identifier of UUID format.

Returns:

  • (::String) —

    Output only. Server generated global unique identifier of UUID format.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

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

Returns Output only. The timestamp when this VolumeBackup resource was last updated.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end

#volume_backup_handle ⇒ ::String (readonly)

Returns Output only. A storage system-specific opaque handle to the underlying volume backup.

Returns:

  • (::String) —

    Output only. A storage system-specific opaque handle to the underlying volume backup.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 83

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

  # Identifies the format used for the volume backup.
  module VolumeBackupFormat
    # Default value, not specified.
    VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0

    # Compute Engine Persistent Disk snapshot based volume backup.
    GCE_PERSISTENT_DISK = 1
  end

  # The current state of a VolumeBackup
  module State
    # This is an illegal state and should not be encountered.
    STATE_UNSPECIFIED = 0

    # A volume for the backup was identified and backup process is about to
    # start.
    CREATING = 1

    # The volume backup operation has begun and is in the initial "snapshot"
    # phase of the process. Any defined ProtectedApplication "pre" hooks will
    # be executed before entering this state and "post" hooks will be executed
    # upon leaving this state.
    SNAPSHOTTING = 2

    # The snapshot phase of the volume backup operation has completed and
    # the snapshot is now being uploaded to backup storage.
    UPLOADING = 3

    # The volume backup operation has completed successfully.
    SUCCEEDED = 4

    # The volume backup operation has failed.
    FAILED = 5

    # This VolumeBackup resource (and its associated artifacts) is in the
    # process of being deleted.
    DELETING = 6
  end
end