BackupState class

Input properties used for looking up and filtering Backup resources.

Constructors

BackupState({Input<Map<String, String>?>? annotations, Input<String?>? backupId, Input<String?>? clusterName, Input<String?>? clusterUid, Input<String?>? createTime, Input<String?>? deleteTime, Input<String?>? deletionPolicy, Input<String?>? description, Input<String?>? displayName, Input<Map<String, String>?>? effectiveAnnotations, Input<Map<String, String>?>? effectiveLabels, Input<BackupEncryptionConfig?>? encryptionConfig, Input<List<BackupEncryptionInfo>?>? encryptionInfos, Input<String?>? etag, Input<List<BackupExpiryQuantity>?>? expiryQuantities, Input<String?>? expiryTime, Input<Map<String, String>?>? labels, Input<String?>? location, Input<String?>? name, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<bool?>? reconciling, Input<String?>? sizeBytes, Input<String?>? state, Input<String?>? type, Input<String?>? uid, Input<String?>? updateTime})
Creates a new BackupState. annotations Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 backupId The ID of the alloydb backup. clusterName The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}). clusterUid Output only. The system-generated UID of the cluster which was used to create this resource. createTime Output only. Create time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. deleteTime Output only. Delete time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description User-provided description of the backup. displayName User-settable and human-readable display name for the Backup. effectiveAnnotations All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. encryptionConfig EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). encryptionInfos EncryptionInfo describes the encryption information of a cluster or a backup. etag For Resource freshness validation (https://google.aip.dev/154) expiryQuantities Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. expiryTime Output only. The time at which after the backup is eligible to be garbage collected. labels User-defined labels for the alloydb backup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. location The location where the alloydb backup should reside. name Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId} project The ID of the project in which the resource belongs. pulumiLabels The combination of labels configured directly on the resource reconciling Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. sizeBytes Output only. The size of the backup in bytes. state Output only. The current state of the backup. type The backup type, which suggests the trigger for the backup. uid 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. updateTime Output only. Update time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
const
BackupState.fromMap(Map<String, dynamic> map)
factory

Properties

annotations → Input<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 An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
final
backupId → Input<String?>?
The ID of the alloydb backup.
final
clusterName → Input<String?>?
The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).
final
clusterUid → Input<String?>?
Output only. The system-generated UID of the cluster which was used to create this resource.
final
createTime → Input<String?>?
Output only. Create time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
final
deleteTime → Input<String?>?
Output only. Delete time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
User-provided description of the backup.
final
displayName → Input<String?>?
User-settable and human-readable display name for the Backup.
final
effectiveAnnotations → Input<Map<String, String>?>?
All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
encryptionConfig → Input<BackupEncryptionConfig?>?
EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
final
encryptionInfos → Input<List<BackupEncryptionInfo>?>?
EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.
final
etag → Input<String?>?
For Resource freshness validation (https://google.aip.dev/154)
final
expiryQuantities → Input<List<BackupExpiryQuantity>?>?
Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected. Structure is documented below.
final
expiryTime → Input<String?>?
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 createTime.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<Map<String, String>?>?
User-defined labels for the alloydb backup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
final
location → Input<String?>?
The location where the alloydb backup should reside.
final
name → Input<String?>?
Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
reconciling → Input<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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sizeBytes → Input<String?>?
Output only. The size of the backup in bytes.
final
state → Input<String?>?
Output only. The current state of the backup.
final
type → Input<String?>?
The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.
final
uid → Input<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.
final
updateTime → Input<String?>?
Output only. Update time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited