Backup for GKE v1 API - Class RestorePlan (2.4.0)

public sealed class RestorePlan : IMessage<RestorePlan>, IEquatable<RestorePlan>, IDeepCloneable<RestorePlan>, IBufferMessage, IMessage

Reference documentation and code samples for the Backup for GKE v1 API class RestorePlan.

The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.

Inheritance

object > RestorePlan

Implements

IMessage RestorePlan, IEquatable RestorePlan, IDeepCloneable RestorePlan, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

RestorePlan()

public RestorePlan()

RestorePlan(RestorePlan)

public RestorePlan(RestorePlan other)

Parameter
Name	Description
`other`	`RestorePlan`

Properties

BackupPlan

public string BackupPlan { get; set; }

Required. Immutable. A reference to the [BackupPlan][google.cloud.gkebackup.v1.BackupPlan] from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.

Property Value
Type	Description
`string`

BackupPlanAsBackupPlanName

public BackupPlanName BackupPlanAsBackupPlanName { get; set; }

BackupPlanName-typed view over the BackupPlan resource name property.

Property Value
Type	Description
`BackupPlanName`

Cluster

public string Cluster { get; set; }

Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

projects/*/locations/*/clusters/*
projects/*/zones/*/clusters/*

Property Value
Type	Description
`string`

ClusterAsClusterName

public ClusterName ClusterAsClusterName { get; set; }

ClusterName-typed view over the Cluster resource name property.

Property Value
Type	Description
`ClusterName`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The timestamp when this RestorePlan resource was created.

Property Value
Type	Description
`Timestamp`

Description

public string Description { get; set; }

Optional. User specified descriptive string for this RestorePlan.

Property Value
Type	Description
`string`

Etag

public string Etag { get; set; }

Output only. 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 GetRestorePlan, and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

Property Value
Type	Description
`string`

Labels

public MapField<string, string> Labels { get; }

Optional. A set of custom labels supplied by user.

Property Value
Type	Description
`MapFieldstringstring`

Name

public string Name { get; set; }

Output only. The full name of the RestorePlan resource. Format: projects/*/locations/*/restorePlans/*.

Property Value
Type	Description
`string`

RestoreConfig

public RestoreConfig RestoreConfig { get; set; }

Required. Configuration of Restores created via this RestorePlan.

Property Value
Type	Description
`RestoreConfig`

RestorePlanName

public RestorePlanName RestorePlanName { get; set; }

RestorePlanName-typed view over the Name resource name property.

Property Value
Type	Description
`RestorePlanName`

State

public RestorePlan.Types.State State { get; set; }

Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

Property Value
Type	Description
`RestorePlanTypesState`

StateReason

public string StateReason { get; set; }

Output only. Human-readable description of why RestorePlan is in the current state

Property Value
Type	Description
`string`

Uid

public string Uid { get; set; }

Output only. Server generated global unique identifier of UUID format.

Property Value
Type	Description
`string`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The timestamp when this RestorePlan resource was last updated.

Property Value
Type	Description
`Timestamp`