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.

Defined Under Namespace

Modules: State 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/*.



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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  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/*


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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  end
end

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

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

Returns:



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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  end
end

#description ⇒ ::String

Returns Optional. User specified descriptive string for this RestorePlan.

Returns:

  • (::String) —

    Optional. User specified descriptive string for this RestorePlan.



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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  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.



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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  end
end

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

Returns Optional. A set of custom labels supplied by user.

Returns:

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

    Optional. A set of custom labels supplied by user.



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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  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/*.



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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  end
end

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

Returns Required. Configuration of Restores created via this RestorePlan.

Returns:



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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  end
end

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

Returns Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

Returns:



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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  end
end

#state_reason ⇒ ::String (readonly)

Returns Output only. Human-readable description of why RestorePlan is in the current state.

Returns:

  • (::String) —

    Output only. Human-readable description of why RestorePlan is in the current state



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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  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.



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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  end
end

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

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

Returns:



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
 
# File 'proto_docs/google/cloud/gkebackup/v1/restore_plan.rb', line 84

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

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The RestorePlan has successfully been created and is ready for Restores.
    READY = 2

    # RestorePlan creation has failed.
    FAILED = 3

    # The RestorePlan is in the process of being deleted.
    DELETING = 4
  end
end