Class: Google::Cloud::GkeBackup::V1::VolumeRestore

Inherits:

Object

Object
Google::Cloud::GkeBackup::V1::VolumeRestore

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/gkebackup/v1/volume.rb

Overview

Represents the operation of restoring a volume from a VolumeBackup. Next id: 13

Defined Under Namespace

Modules: State, VolumeType

Instance Attribute Summary collapse

#complete_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#create_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#etag ⇒ ::String readonly
Output only.
#name ⇒ ::String readonly
Output only.
#state ⇒ ::Google::Cloud::GkeBackup::V1::VolumeRestore::State readonly
Output only.
#state_message ⇒ ::String readonly
Output only.
#target_pvc ⇒ ::Google::Cloud::GkeBackup::V1::NamespacedName readonly
Output only.
#uid ⇒ ::String readonly
Output only.
#update_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#volume_backup ⇒ ::String readonly
Output only.
#volume_handle ⇒ ::String readonly
Output only.
#volume_type ⇒ ::Google::Cloud::GkeBackup::V1::VolumeRestore::VolumeType readonly
Output only.

Instance Attribute Details

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

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

Returns:

(::Google::Protobuf::Timestamp) —
Output only. The timestamp when the associated underlying volume restoration completed.

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  end
end

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

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

Returns:

(::Google::Protobuf::Timestamp) —
Output only. The timestamp when this VolumeRestore resource was created.

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  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 restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform volume restore 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 restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform volume restore updates in order to avoid race conditions.

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  end
end

#name ⇒ `::String` (readonly)

Returns Output only. Full name of the VolumeRestore resource. Format: projects//locations//restorePlans//restores//volumeRestores/*.

Returns:

(::String) —
Output only. Full name of the VolumeRestore resource. Format: projects//locations//restorePlans//restores//volumeRestores/*.

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  end
end

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

Returns Output only. The current state of this VolumeRestore.

Returns:

(::Google::Cloud::GkeBackup::V1::VolumeRestore::State) —
Output only. The current state of this VolumeRestore.

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  end
end

#state_message ⇒ `::String` (readonly)

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

Returns:

(::String) —
Output only. A human readable message explaining why the VolumeRestore is in its current state.

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  end
end

#target_pvc ⇒ `::Google::Cloud::GkeBackup::V1::NamespacedName` (readonly)

Returns Output only. The reference to the target Kubernetes PVC to be restored.

Returns:

(::Google::Cloud::GkeBackup::V1::NamespacedName) —
Output only. The reference to the target Kubernetes PVC to be restored.

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  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.

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  end
end

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

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

Returns:

(::Google::Protobuf::Timestamp) —
Output only. The timestamp when this VolumeRestore resource was last updated.

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  end
end

#volume_backup ⇒ `::String` (readonly)

Returns Output only. The full name of the VolumeBackup from which the volume will be restored. Format: projects//locations//backupPlans//backups//volumeBackups/*.

Returns:

(::String) —
Output only. The full name of the VolumeBackup from which the volume will be restored. Format: projects//locations//backupPlans//backups//volumeBackups/*.

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  end
end

#volume_handle ⇒ `::String` (readonly)

Returns Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup.

Returns:

(::String) —
Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup.

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  end
end

#volume_type ⇒ `::Google::Cloud::GkeBackup::V1::VolumeRestore::VolumeType` (readonly)

Returns Output only. The type of volume provisioned.

Returns:

(::Google::Cloud::GkeBackup::V1::VolumeRestore::VolumeType) —
Output only. The type of volume provisioned

# File 'proto_docs/google/cloud/gkebackup/v1/volume.rb', line 176

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

  # Supported volume types.
  module VolumeType
    # Default
    VOLUME_TYPE_UNSPECIFIED = 0

    # Compute Engine Persistent Disk volume
    GCE_PERSISTENT_DISK = 1
  end

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

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

    # The volume is currently being restored.
    RESTORING = 2

    # The volume has been successfully restored.
    SUCCEEDED = 3

    # The volume restoration process failed.
    FAILED = 4

    # This VolumeRestore resource is in the process of being deleted.
    DELETING = 5
  end
end

Class: Google::Cloud::GkeBackup::V1::VolumeRestore

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

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

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

#etag ⇒ ::String (readonly)

#name ⇒ ::String (readonly)

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

#state_message ⇒ ::String (readonly)

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

#uid ⇒ ::String (readonly)

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

#volume_backup ⇒ ::String (readonly)

#volume_handle ⇒ ::String (readonly)

#volume_type ⇒ ::Google::Cloud::GkeBackup::V1::VolumeRestore::VolumeType (readonly)

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

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

#etag ⇒ `::String` (readonly)

#name ⇒ `::String` (readonly)

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

#state_message ⇒ `::String` (readonly)

#target_pvc ⇒ `::Google::Cloud::GkeBackup::V1::NamespacedName` (readonly)

#uid ⇒ `::String` (readonly)

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

#volume_backup ⇒ `::String` (readonly)

#volume_handle ⇒ `::String` (readonly)

#volume_type ⇒ `::Google::Cloud::GkeBackup::V1::VolumeRestore::VolumeType` (readonly)