Class Restore (1.0.0-beta01)

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

Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself. Next id: 18

Inheritance

Object > Restore

Implements

IMessage<Restore>, IEquatable<Restore>, IDeepCloneable<Restore>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

Restore()

public Restore()

Restore(Restore)

public Restore(Restore other)

Parameter
Name	Description
`other`	`Restore`

Properties

Backup

public string Backup { get; set; }

Required. Immutable. A reference to the [Backup][google.cloud.gkebackup.v1.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][google.cloud.gkebackup.v1.RestorePlan.backup_plan]. Format: projects//locations//backupPlans//backups/.

Property Value
Type	Description
`String`

BackupAsBackupName

public BackupName BackupAsBackupName { get; set; }

BackupName-typed view over the Backup resource name property.

Property Value
Type	Description
`BackupName`

Cluster

public string Cluster { get; set; }

Output only. The target cluster into which this Restore will restore data. Valid formats:

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

Inherited from parent RestorePlan's [cluster][google.cloud.gkebackup.v1.RestorePlan.cluster] value.

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`

CompleteTime

public Timestamp CompleteTime { get; set; }

Output only. Timestamp of when the restore operation completed.

Property Value
Type	Description
`Timestamp`

CreateTime

public Timestamp CreateTime { get; set; }

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

Property Value
Type	Description
`Timestamp`

Description

public string Description { get; set; }

User specified descriptive string for this Restore.

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 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.

Property Value
Type	Description
`String`

Labels

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

A set of custom labels supplied by user.

Property Value
Type	Description
`MapField<String, String>`

Name

public string Name { get; set; }

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

Property Value
Type	Description
`String`

ResourcesExcludedCount

public int ResourcesExcludedCount { get; set; }

Output only. Number of resources excluded during the restore execution.

Property Value
Type	Description
`Int32`

ResourcesFailedCount

public int ResourcesFailedCount { get; set; }

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

Property Value
Type	Description
`Int32`

ResourcesRestoredCount

public int ResourcesRestoredCount { get; set; }

Output only. Number of resources restored during the restore execution.

Property Value
Type	Description
`Int32`

RestoreConfig

public RestoreConfig RestoreConfig { get; set; }

Output only. Configuration of the Restore. Inherited from parent RestorePlan's [restore_config][google.cloud.gkebackup.v1.RestorePlan.restore_config].

Property Value
Type	Description
`RestoreConfig`

RestoreName

public RestoreName RestoreName { get; set; }

RestoreName-typed view over the Name resource name property.

Property Value
Type	Description
`RestoreName`

State

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

Output only. The current state of the Restore.

Property Value
Type	Description
`Restore.Types.State`

StateReason

public string StateReason { get; set; }

Output only. Human-readable description of why the Restore is in its 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 Restore resource was last updated.

Property Value
Type	Description
`Timestamp`

VolumesRestoredCount

public int VolumesRestoredCount { get; set; }

Output only. Number of volumes restored during the restore execution.

Property Value
Type	Description
`Int32`