Backup for GKE v1 API - Class VolumeRestoreName (2.5.0)

public sealed class VolumeRestoreName : IResourceName, IEquatable<VolumeRestoreName>

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

Resource name for the VolumeRestore resource.

Inheritance

object > VolumeRestoreName

Implements

IResourceName, IEquatable VolumeRestoreName

Inherited Members

object.GetType()

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

VolumeRestoreName(string, string, string, string, string)

public VolumeRestoreName(string projectId, string locationId, string restorePlanId, string restoreId, string volumeRestoreId)

Constructs a new instance of a VolumeRestoreName class from the component parts of pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`restorePlanId`	`string` The `RestorePlan` ID. Must not be `null` or empty.
`restoreId`	`string` The `Restore` ID. Must not be `null` or empty.
`volumeRestoreId`	`string` The `VolumeRestore` ID. Must not be `null` or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type	Description
`bool`

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

RestoreId

public string RestoreId { get; }

The Restore ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

RestorePlanId

public string RestorePlanId { get; }

The RestorePlan ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

Type

public VolumeRestoreName.ResourceNameType Type { get; }

The VolumeRestoreName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`VolumeRestoreNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
`UnparsedResourceName`

VolumeRestoreId

public string VolumeRestoreId { get; }

The VolumeRestore ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

Methods

Format(string, string, string, string, string)

public static string Format(string projectId, string locationId, string restorePlanId, string restoreId, string volumeRestoreId)

Formats the IDs into the string representation of this VolumeRestoreName with pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore} .

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`restorePlanId`	`string` The `RestorePlan` ID. Must not be `null` or empty.
`restoreId`	`string` The `Restore` ID. Must not be `null` or empty.
`volumeRestoreId`	`string` The `VolumeRestore` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this VolumeRestoreName with pattern `projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}` .

FormatProjectLocationRestorePlanRestoreVolumeRestore(string, string, string, string, string)

public static string FormatProjectLocationRestorePlanRestoreVolumeRestore(string projectId, string locationId, string restorePlanId, string restoreId, string volumeRestoreId)

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`restorePlanId`	`string` The `RestorePlan` ID. Must not be `null` or empty.
`restoreId`	`string` The `Restore` ID. Must not be `null` or empty.
`volumeRestoreId`	`string` The `VolumeRestore` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this VolumeRestoreName with pattern `projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}` .

FromProjectLocationRestorePlanRestoreVolumeRestore(string, string, string, string, string)

public static VolumeRestoreName FromProjectLocationRestorePlanRestoreVolumeRestore(string projectId, string locationId, string restorePlanId, string restoreId, string volumeRestoreId)

Creates a VolumeRestoreName with the pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore} .

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`restorePlanId`	`string` The `RestorePlan` ID. Must not be `null` or empty.
`restoreId`	`string` The `Restore` ID. Must not be `null` or empty.
`volumeRestoreId`	`string` The `VolumeRestore` ID. Must not be `null` or empty.

Returns
Type	Description
`VolumeRestoreName`	A new instance of VolumeRestoreName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static VolumeRestoreName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VolumeRestoreName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`VolumeRestoreName`	A new instance of VolumeRestoreName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static VolumeRestoreName Parse(string volumeRestoreName)

Parses the given resource name string into a new VolumeRestoreName instance.

Parameter
Name	Description
`volumeRestoreName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`VolumeRestoreName`	The parsed VolumeRestoreName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}

Parse(string, bool)

public static VolumeRestoreName Parse(string volumeRestoreName, bool allowUnparsed)

Parses the given resource name string into a new VolumeRestoreName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`volumeRestoreName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type	Description
`VolumeRestoreName`	The parsed VolumeRestoreName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

TryParse(string, out VolumeRestoreName)

public static bool TryParse(string volumeRestoreName, out VolumeRestoreName result)

Tries to parse the given resource name string into a new VolumeRestoreName instance.

Parameters
Name	Description
`volumeRestoreName`	`string` The resource name in string form. Must not be `null`.
`result`	`VolumeRestoreName` When this method returns, the parsed VolumeRestoreName, or `null` if parsing failed.

Returns
Type	Description
`bool`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}

TryParse(string, bool, out VolumeRestoreName)

public static bool TryParse(string volumeRestoreName, bool allowUnparsed, out VolumeRestoreName result)

Tries to parse the given resource name string into a new VolumeRestoreName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`volumeRestoreName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
`result`	`VolumeRestoreName` When this method returns, the parsed VolumeRestoreName, or `null` if parsing failed.

Returns
Type	Description
`bool`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(VolumeRestoreName, VolumeRestoreName)

public static bool operator ==(VolumeRestoreName a, VolumeRestoreName b)

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`VolumeRestoreName` The first resource name to compare, or null.
`b`	`VolumeRestoreName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is the same as the value of `b`; otherwise, false.

operator !=(VolumeRestoreName, VolumeRestoreName)

public static bool operator !=(VolumeRestoreName a, VolumeRestoreName b)

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`VolumeRestoreName` The first resource name to compare, or null.
`b`	`VolumeRestoreName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is different from the value of `b`; otherwise, false.