Class: Google::Cloud::GkeBackup::V1::RestorePlan

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

Overview

The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan. Next id: 11

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#backup_plan ⇒ ::String

Returns Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects//locations//backupPlans/*.

Returns:

  • (::String) —

    Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects//locations//backupPlans/*.



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 76

class RestorePlan
  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
end

#cluster ⇒ ::String

Returns Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

  • projects//locations//clusters/*
  • projects//zones//clusters/*.

Returns:

  • (::String) —

    Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

    • projects//locations//clusters/*
    • projects//zones//clusters/*


76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 76

class RestorePlan
  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
end

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

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

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 76

class RestorePlan
  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
end

#description ⇒ ::String

Returns User specified descriptive string for this RestorePlan.

Returns:

  • (::String) —

    User specified descriptive string for this RestorePlan.



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 76

class RestorePlan
  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
end

#etag ⇒ ::String (readonly)

Returns Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestorePlan, and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

Returns:

  • (::String) —

    Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestorePlan, and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 76

class RestorePlan
  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
end

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

Returns A set of custom labels supplied by user.

Returns:

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

    A set of custom labels supplied by user.



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 76

class RestorePlan
  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
end

#name ⇒ ::String (readonly)

Returns Output only. The full name of the RestorePlan resource. Format: projects//locations//restorePlans/*.

Returns:

  • (::String) —

    Output only. The full name of the RestorePlan resource. Format: projects//locations//restorePlans/*.



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 76

class RestorePlan
  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
end

#restore_config ⇒ ::Google::Cloud::GkeBackup::V1::RestoreConfig

Returns Required. Configuration of Restores created via this RestorePlan.

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 76

class RestorePlan
  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
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.



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 76

class RestorePlan
  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
end

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

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

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 76

class RestorePlan
  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
end