RestoreConfig class
Configuration of a restore. Next id: 12
- Inheritance
-
- Object
- GeneratedMessage
- RestoreConfig
Constructors
-
RestoreConfig({RestoreConfig_VolumeDataRestorePolicy? volumeDataRestorePolicy, RestoreConfig_ClusterResourceConflictPolicy? clusterResourceConflictPolicy, RestoreConfig_NamespacedResourceRestoreMode? namespacedResourceRestoreMode, RestoreConfig_ClusterResourceRestoreScope? clusterResourceRestoreScope, bool? allNamespaces, Namespaces? selectedNamespaces, NamespacedNames? selectedApplications, Iterable<
RestoreConfig_SubstitutionRule> ? substitutionRules}) -
factory
-
RestoreConfig.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- RestoreConfig.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- allNamespaces ↔ bool
-
Restore all namespaced resources in the Backup if set to "True".
Specifying this field to "False" is an error.
getter/setter pair
- clusterResourceConflictPolicy ↔ RestoreConfig_ClusterResourceConflictPolicy
-
Defines the behavior for handling the situation where cluster-scoped
resources being restored already exist in the target cluster. This MUST be
set to a value other than CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if
google.cloud.gkebackup.v1.RestoreConfig.cluster_resource_restore_scopeis not empty.getter/setter pair - clusterResourceRestoreScope ↔ RestoreConfig_ClusterResourceRestoreScope
-
Identifies the cluster-scoped resources to restore from the Backup.
Not specifying it means NO cluster resource will be restored.
getter/setter pair
- eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setteroverride
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - namespacedResourceRestoreMode ↔ RestoreConfig_NamespacedResourceRestoreMode
-
Defines the behavior for handling the situation where sets of namespaced
resources being restored already exist in the target cluster. This MUST be
set to a value other than NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selectedApplications ↔ NamespacedNames
-
A list of selected ProtectedApplications to restore. The listed
ProtectedApplications and all the resources to which they refer will be
restored.
getter/setter pair
- selectedNamespaces ↔ Namespaces
-
A list of selected Namespaces to restore from the Backup. The listed
Namespaces and all resources contained in them will be restored.
getter/setter pair
-
substitutionRules
→ List<
RestoreConfig_SubstitutionRule> -
A list of transformation rules to be applied against Kubernetes resources
as they are selected for restoration from a Backup. Rules are executed in
order defined - this order matters, as changes made by a rule may impact
the filtering logic of subsequent rules. An empty list means no
substitution will occur.
no setter
- unknownFields → UnknownFieldSet
-
no setterinherited
- volumeDataRestorePolicy ↔ RestoreConfig_VolumeDataRestorePolicy
-
Specifies the mechanism to be used to restore volume data.
Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as
NO_VOLUME_DATA_RESTORATION).
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
-
clearAllNamespaces(
) → void -
clearClusterResourceConflictPolicy(
) → void -
clearClusterResourceRestoreScope(
) → 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
-
clearNamespacedResourceRestoreMode(
) → void -
clearNamespacedResourceRestoreScope(
) → void -
clearSelectedApplications(
) → void -
clearSelectedNamespaces(
) → void -
clearVolumeDataRestorePolicy(
) → void -
clone(
) → RestoreConfig -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(RestoreConfig)) → RestoreConfig -
Apply
updatesto a copy of this message.override -
createEmptyInstance(
) → RestoreConfig -
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
-
ensureClusterResourceRestoreScope(
) → RestoreConfig_ClusterResourceRestoreScope -
ensureSelectedApplications(
) → NamespacedNames -
ensureSelectedNamespaces(
) → Namespaces -
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
-
hasAllNamespaces(
) → bool -
hasClusterResourceConflictPolicy(
) → bool -
hasClusterResourceRestoreScope(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasNamespacedResourceRestoreMode(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasSelectedApplications(
) → bool -
hasSelectedNamespaces(
) → bool -
hasVolumeDataRestorePolicy(
) → 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 byGeneratedMessage.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
otherinto 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
-
whichNamespacedResourceRestoreScope(
) → RestoreConfig_NamespacedResourceRestoreScope -
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(
) → RestoreConfig -
createRepeated(
) → PbList< RestoreConfig> -
getDefault(
) → RestoreConfig