Restore class

Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself. Next id: 18

Inheritance

• Object
• GeneratedMessage
• Restore

Constructors

Restore({String? name, String? uid, Timestamp? createTime, Timestamp? updateTime, String? description, String? backup, String? cluster, RestoreConfig? restoreConfig, Map<String, String>? labels, Restore_State? state, String? stateReason, Timestamp? completeTime, int? resourcesRestoredCount, int? resourcesExcludedCount, int? resourcesFailedCount, int? volumesRestoredCount, String? etag})

factory

Restore.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Restore.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Properties

backup ↔ String

Required. Immutable. A reference to the google.cloud.gkebackup.v1.Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's google.cloud.gkebackup.v1.RestorePlan.backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.

getter/setter pair

cluster ↔ String

Output only. The target cluster into which this Restore will restore data. Valid formats:

getter/setter pair

completeTime ↔ Timestamp

Output only. Timestamp of when the restore operation completed.

getter/setter pair

createTime ↔ Timestamp

Output only. The timestamp when this Restore resource was created.

getter/setter pair

description ↔ String

User specified descriptive string for this Restore.

getter/setter pair

etag ↔ 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 GetRestore, and systems are expected to put that etag in the request to UpdateRestore or DeleteRestore to ensure that their change will be applied to the same version of the resource.

getter/setter pair

eventPlugin → EventPlugin?

Subclasses can override this getter to be notified of changes to protobuf fields.

no setter, inherited

hashCode → int

Calculates a hash code based on the contents of the protobuf.

no setter, inherited

info_ → BuilderInfo

no setter, override

isFrozen → bool

Returns true if this message is marked read-only. Otherwise false.

no setter, inherited

labels → Map<String, String>

A set of custom labels supplied by user.

no setter

name ↔ String

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

getter/setter pair

resourcesExcludedCount ↔ int

Output only. Number of resources excluded during the restore execution.

getter/setter pair

resourcesFailedCount ↔ int

Output only. Number of resources that failed to be restored during the restore execution.

getter/setter pair

resourcesRestoredCount ↔ int

Output only. Number of resources restored during the restore execution.

getter/setter pair

restoreConfig ↔ RestoreConfig

Output only. Configuration of the Restore. Inherited from parent RestorePlan's google.cloud.gkebackup.v1.RestorePlan.restore_config.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Restore_State

Output only. The current state of the Restore.

getter/setter pair

stateReason ↔ String

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

getter/setter pair

uid ↔ String

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

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

updateTime ↔ Timestamp

Output only. The timestamp when this Restore resource was last updated.

getter/setter pair

volumesRestoredCount ↔ int

Output only. Number of volumes restored during the restore execution.

getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void

Adds an extension field value to a repeated field.

inherited

check() → void

inherited

clear() → void

Clears all data that was set in this message.

inherited

clearBackup() → void

clearCluster() → void

clearCompleteTime() → void

clearCreateTime() → void

clearDescription() → void

clearEtag() → void

clearExtension(Extension extension) → void

Clears an extension field and also removes the extension.

inherited

clearField(int tagNumber) → void

Clears the contents of a given field.

inherited

clearName() → void

clearResourcesExcludedCount() → void

clearResourcesFailedCount() → void

clearResourcesRestoredCount() → void

clearRestoreConfig() → void

clearState() → void

clearStateReason() → void

clearUid() → void

clearUpdateTime() → void

clearVolumesRestoredCount() → void

clone() → Restore

Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)

override

copyWith(void updates(Restore)) → Restore

Apply updates to a copy of this message.

override

createEmptyInstance() → Restore

Creates an empty instance of the same message type as this.

override

createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>

Creates a Map representing a map field.

inherited

createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>

Creates List implementing a mutable repeated field.

inherited

ensureCompleteTime() → Timestamp

ensureCreateTime() → Timestamp

ensureRestoreConfig() → RestoreConfig

ensureUpdateTime() → Timestamp

extensionsAreInitialized() → bool

inherited

freeze() → GeneratedMessage

Make this message read-only.

inherited

getDefaultForField(int tagNumber) → dynamic

Returns the default value for the given field.

inherited

getExtension(Extension extension) → dynamic

Returns the value of extension.

inherited

getField(int tagNumber) → dynamic

Returns the value of the field associated with tagNumber, or the default value if it is not set.

inherited

getFieldOrNull(int tagNumber) → dynamic

Returns the value of a field, ignoring any defaults.

inherited

getTagNumber(String fieldName) → int?

inherited

hasBackup() → bool

hasCluster() → bool

hasCompleteTime() → bool

hasCreateTime() → bool

hasDescription() → bool

hasEtag() → bool

hasExtension(Extension extension) → bool

Returns true if a value of extension is present.

inherited

hasField(int tagNumber) → bool

Whether this message has a field associated with tagNumber.

inherited

hasName() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasResourcesExcludedCount() → bool

hasResourcesFailedCount() → bool

hasResourcesRestoredCount() → bool

hasRestoreConfig() → bool

hasState() → bool

hasStateReason() → bool

hasUid() → bool

hasUpdateTime() → bool

hasVolumesRestoredCount() → bool

isInitialized() → bool

Whether all required fields in the message and embedded messages are set.

inherited

mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges serialized protocol buffer data into this message.

inherited

mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

inherited

mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.

inherited

mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from a JSON object represented as a Dart map.

inherited

mergeFromMessage(GeneratedMessage other) → void

Merges the contents of the other into this message.

inherited

mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void

Merges field values from json, a JSON object using proto3 encoding.

inherited

mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setExtension(Extension extension, Object value) → void

Sets the value of a non-repeated extension field to value.

inherited

setField(int tagNumber, Object value) → void

Sets the value of a field by its tagNumber.

inherited

toBuilder() → GeneratedMessage

Creates a writable, shallow copy of this message.

inherited

toDebugString() → String

Returns a String representation of this message.

inherited

toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?

Returns an Object representing Proto3 JSON serialization of this.

inherited

toString() → String

Returns a String representation of this message.

inherited

writeToBuffer() → Uint8List

inherited

writeToCodedBufferWriter(CodedBufferWriter output) → void

inherited

writeToJson() → String

Returns a JSON string that encodes this message.

inherited

writeToJsonMap() → Map<String, dynamic>

Returns the JSON encoding of this message as a Dart Map.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create() → Restore

createRepeated() → PbList<Restore>

getDefault() → Restore