Backup for GKE v1 API - Class RestorePlanName (2.8.0) 

public sealed class RestorePlanName : IResourceName, IEquatable<RestorePlanName>

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

Resource name for the RestorePlan resource.

Inheritance

object > RestorePlanName

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

RestorePlanName(string, string, string)

public RestorePlanName(string projectId, string locationId, string restorePlanId)

Constructs a new instance of a RestorePlanName class from the component parts of pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}

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.

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

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

The RestorePlanName.ResourceNameType of the contained resource name.

Property Value
Type Description
RestorePlanNameResourceNameType

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)

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

Formats the IDs into the string representation of this RestorePlanName with pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}.

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.
Returns
Type Description
string

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

FormatProjectLocationRestorePlan(string, string, string)

public static string FormatProjectLocationRestorePlan(string projectId, string locationId, string restorePlanId)

Formats the IDs into the string representation of this RestorePlanName with pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}.

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.
Returns
Type Description
string

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

FromProjectLocationRestorePlan(string, string, string)

public static RestorePlanName FromProjectLocationRestorePlan(string projectId, string locationId, string restorePlanId)

Creates a RestorePlanName with the pattern projects/{project}/locations/{location}/restorePlans/{restore_plan}.

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.
Returns
Type Description
RestorePlanName

A new instance of RestorePlanName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RestorePlanName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RestorePlanName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of RestorePlanName 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 RestorePlanName Parse(string restorePlanName)

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

Parameter
Name Description
restorePlanName string

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

The parsed RestorePlanName if successful.
Remarks

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

  • projects/{project}/locations/{location}/restorePlans/{restore_plan}

Parse(string, bool)

public static RestorePlanName Parse(string restorePlanName, bool allowUnparsed)

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

Parameters
Name Description
restorePlanName 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
RestorePlanName

The parsed RestorePlanName if successful.
Remarks

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

  • projects/{project}/locations/{location}/restorePlans/{restore_plan}
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 RestorePlanName)

public static bool TryParse(string restorePlanName, out RestorePlanName result)

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

Parameters
Name Description
restorePlanName string

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

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

TryParse(string, bool, out RestorePlanName)

public static bool TryParse(string restorePlanName, bool allowUnparsed, out RestorePlanName result)

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

Parameters
Name Description
restorePlanName 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 RestorePlanName

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

Operators

operator ==(RestorePlanName, RestorePlanName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RestorePlanName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RestorePlanName

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

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.