Restore class

Creates a new Restore for the given RestorePlan. Auto-naming is currently not supported for this resource.

Constructors

Restore(String name, {RestoreArgs? args, CustomResourceOptions? options})

Creates a new Restore. name The Pulumi resource name. args Arguments used to configure this Restore. The set of arguments for Restore. options Resource options controlling this resource's behavior.

Properties

backup ↔ Output<String>

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

late, final

childResources → Set<Resource>

final, inherited

cluster ↔ Output<String>

The target cluster into which this Restore will restore data. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* Inherited from parent RestorePlan's cluster value.

late, final

completeTime ↔ Output<String>

Timestamp of when the restore operation completed.

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The timestamp when this Restore resource was created.

late, final

description ↔ Output<String>

User specified descriptive string for this Restore.

late, final

etag ↔ Output<String>

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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>>

A set of custom labels supplied by user.

late, final

location ↔ Output<String>

late, final

name ↔ Output<String>

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

late, final

project ↔ Output<String>

late, final

resourcesExcludedCount ↔ Output<int>

Number of resources excluded during the restore execution.

late, final

resourcesFailedCount ↔ Output<int>

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

late, final

resourcesRestoredCount ↔ Output<int>

Number of resources restored during the restore execution.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

restoreConfig ↔ Output<RestoreConfigResponse>

Configuration of the Restore. Inherited from parent RestorePlan's restore_config.

late, final

restoreId ↔ Output<String>

Required. The client-provided short name for the Restore resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Restores in this RestorePlan.

late, final

restorePlanId ↔ Output<String>

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

The current state of the Restore.

late, final

stateReason ↔ Output<String>

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

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

Server generated global unique identifier of UUID format.

late, final

updateTime ↔ Output<String>

The timestamp when this Restore resource was last updated.

late, final

urn ↔ Output<String>

late, final, inherited

volumesRestoredCount ↔ Output<int>

Number of volumes restored during the restore execution.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited