Backup class

Message describing Backup object

Inheritance

• Object
• GeneratedMessage
• Backup

Constructors

Backup({String? name, String? displayName, String? uid, Timestamp? createTime, Timestamp? updateTime, Map<String, String>? labels, Backup_State? state, Backup_Type? type, String? description, String? clusterName, bool? reconciling, EncryptionConfig? encryptionConfig, EncryptionInfo? encryptionInfo, String? etag, Timestamp? deleteTime, Map<String, String>? annotations, Int64? sizeBytes, String? clusterUid, Timestamp? expiryTime})

factory

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

factory

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

factory

Properties

annotations → Map<String, String>

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

no setter

clusterName ↔ String

Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

getter/setter pair

clusterUid ↔ String

Output only. The system-generated UID of the cluster which was used to create this resource.

getter/setter pair

createTime ↔ Timestamp

Output only. Create time stamp

getter/setter pair

deleteTime ↔ Timestamp

Output only. Delete time stamp

getter/setter pair

description ↔ String

User-provided description of the backup.

getter/setter pair

displayName ↔ String

User-settable and human-readable display name for the Backup.

getter/setter pair

encryptionConfig ↔ EncryptionConfig

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

getter/setter pair

encryptionInfo ↔ EncryptionInfo

Output only. The encryption information for the backup.

getter/setter pair

etag ↔ String

For Resource freshness validation (https://google.aip.dev/154)

getter/setter pair

eventPlugin → EventPlugin?

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

no setter, inherited

expiryTime ↔ Timestamp

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

getter/setter pair

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>

Labels as key value pairs

no setter

name ↔ String

Output only. The name of the backup resource with the format:

getter/setter pair

reconciling ↔ bool

Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sizeBytes ↔ Int64

Output only. The size of the backup in bytes.

getter/setter pair

state ↔ Backup_State

Output only. The current state of the backup.

getter/setter pair

type ↔ Backup_Type

The backup type, which suggests the trigger for the backup.

getter/setter pair

uid ↔ String

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

updateTime ↔ Timestamp

Output only. Update time stamp

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

clearClusterName() → void

clearClusterUid() → void

clearCreateTime() → void

clearDeleteTime() → void

clearDescription() → void

clearDisplayName() → void

clearEncryptionConfig() → void

clearEncryptionInfo() → void

clearEtag() → void

clearExpiryTime() → 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

clearReconciling() → void

clearSizeBytes() → void

clearState() → void

clearType() → void

clearUid() → void

clearUpdateTime() → void

clone() → Backup

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

override

copyWith(void updates(Backup)) → Backup

Apply updates to a copy of this message.

override

createEmptyInstance() → Backup

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

ensureCreateTime() → Timestamp

ensureDeleteTime() → Timestamp

ensureEncryptionConfig() → EncryptionConfig

ensureEncryptionInfo() → EncryptionInfo

ensureExpiryTime() → Timestamp

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

hasClusterName() → bool

hasClusterUid() → bool

hasCreateTime() → bool

hasDeleteTime() → bool

hasDescription() → bool

hasDisplayName() → bool

hasEncryptionConfig() → bool

hasEncryptionInfo() → bool

hasEtag() → bool

hasExpiryTime() → 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

hasReconciling() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasSizeBytes() → bool

hasState() → bool

hasType() → 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 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() → Backup

createRepeated() → PbList<Backup>

getDefault() → Backup