Backup for GKE v1 API - Class RestoreName (2.8.0) 

public sealed class RestoreName : IResourceName, IEquatable<RestoreName>

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

Resource name for the Restore resource.

Inheritance

object > RestoreName

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

RestoreName(string, string, string, string)

public RestoreName(string projectId, string locationId, string restorePlanId, string restoreId)

Constructs a new instance of a RestoreName class from the component parts of pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{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.

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 RestoreName.ResourceNameType Type { get; }

The RestoreName.ResourceNameType of the contained resource name.

Property Value
Type Description
RestoreNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string, string)

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

Formats the IDs into the string representation of this RestoreName with pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{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.
Returns
Type Description
string

The string representation of this RestoreName with pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}.

FormatProjectLocationRestorePlanRestore(string, string, string, string)

public static string FormatProjectLocationRestorePlanRestore(string projectId, string locationId, string restorePlanId, string restoreId)

Formats the IDs into the string representation of this RestoreName with pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{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.
Returns
Type Description
string

The string representation of this RestoreName with pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}.

FromProjectLocationRestorePlanRestore(string, string, string, string)

public static RestoreName FromProjectLocationRestorePlanRestore(string projectId, string locationId, string restorePlanId, string restoreId)

Creates a RestoreName with the pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{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.
Returns
Type Description
RestoreName

A new instance of RestoreName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RestoreName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RestoreName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
RestoreName

A new instance of RestoreName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static RestoreName Parse(string restoreName)

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

Parameter
Name Description
restoreName string

The resource name in string form. Must not be null.
Returns
Type Description
RestoreName

The parsed RestoreName 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}

Parse(string, bool)

public static RestoreName Parse(string restoreName, bool allowUnparsed)

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

Parameters
Name Description
restoreName 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
RestoreName

The parsed RestoreName 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}
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

TryParse(string, out RestoreName)

public static bool TryParse(string restoreName, out RestoreName result)

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

Parameters
Name Description
restoreName string

The resource name in string form. Must not be null.
result RestoreName

When this method returns, the parsed RestoreName, 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}

TryParse(string, bool, out RestoreName)

public static bool TryParse(string restoreName, bool allowUnparsed, out RestoreName result)

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

Parameters
Name Description
restoreName 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 RestoreName

When this method returns, the parsed RestoreName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RestoreName, RestoreName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RestoreName

The first resource name to compare, or null.
b RestoreName

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 !=(RestoreName, RestoreName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RestoreName

The first resource name to compare, or null.
b RestoreName

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.