BackupPlan class
Defines the configuration and scheduling for a "line" of Backups.
- Inheritance
-
- Object
- GeneratedMessage
- BackupPlan
Constructors
-
BackupPlan({String? name, String? uid, Timestamp? createTime, Timestamp? updateTime, String? description, String? cluster, BackupPlan_RetentionPolicy? retentionPolicy, Map<
String, String> ? labels, BackupPlan_Schedule? backupSchedule, String? etag, bool? deactivated, BackupPlan_BackupConfig? backupConfig, int? protectedPodCount}) -
factory
-
BackupPlan.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- BackupPlan.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- backupConfig ↔ BackupPlan_BackupConfig
-
Defines the configuration of Backups created via this BackupPlan.
getter/setter pair
- backupSchedule ↔ BackupPlan_Schedule
-
Defines a schedule for automatic Backup creation via this BackupPlan.
getter/setter pair
- cluster ↔ String
-
Required. Immutable. The source cluster from which Backups will be created
via this BackupPlan. Valid formats:
getter/setter pair
- createTime ↔ Timestamp
-
Output only. The timestamp when this BackupPlan resource was created.
getter/setter pair
- deactivated ↔ bool
-
This flag indicates whether this BackupPlan has been deactivated.
Setting this field to True locks the BackupPlan such that no further
updates will be allowed (except deletes), including the deactivated field
itself. It also prevents any new Backups from being created via this
BackupPlan (including scheduled Backups).
getter/setter pair
- description ↔ String
-
User specified descriptive string for this BackupPlan.
getter/setter pair
- etag ↔ String
-
Output only.
etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: Anetagis returned in the response toGetBackupPlan, and systems are expected to put that etag in the request toUpdateBackupPlanorDeleteBackupPlanto 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 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 -
labels
→ Map<
String, String> -
A set of custom labels supplied by user.
no setter
- name ↔ String
-
Output only. The full name of the BackupPlan resource.
Format:
projects/*/locations/*/backupPlans/*getter/setter pair - protectedPodCount ↔ int
-
Output only. The number of Kubernetes Pods backed up in the
last successful Backup created via this BackupPlan.
getter/setter pair
- retentionPolicy ↔ BackupPlan_RetentionPolicy
-
RetentionPolicy governs lifecycle of Backups created under this plan.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- uid ↔ String
-
Output only. Server generated global unique identifier of
UUID format.
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
- updateTime ↔ Timestamp
-
Output only. The timestamp when this BackupPlan resource was last
updated.
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
-
clearBackupConfig(
) → void -
clearBackupSchedule(
) → void -
clearCluster(
) → void -
clearCreateTime(
) → void -
clearDeactivated(
) → 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 -
clearProtectedPodCount(
) → void -
clearRetentionPolicy(
) → void -
clearUid(
) → void -
clearUpdateTime(
) → void -
clone(
) → BackupPlan -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(BackupPlan)) → BackupPlan -
Apply
updatesto a copy of this message.override -
createEmptyInstance(
) → BackupPlan -
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
-
ensureBackupConfig(
) → BackupPlan_BackupConfig -
ensureBackupSchedule(
) → BackupPlan_Schedule -
ensureCreateTime(
) → Timestamp -
ensureRetentionPolicy(
) → BackupPlan_RetentionPolicy -
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
-
hasBackupConfig(
) → bool -
hasBackupSchedule(
) → bool -
hasCluster(
) → bool -
hasCreateTime(
) → bool -
hasDeactivated(
) → bool -
hasDescription(
) → bool -
hasEtag(
) → 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 -
hasName(
) → bool -
hasProtectedPodCount(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasRetentionPolicy(
) → bool -
hasUid(
) → bool -
hasUpdateTime(
) → 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
-
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(
) → BackupPlan -
createRepeated(
) → PbList< BackupPlan> -
getDefault(
) → BackupPlan