Backup and DR Service v1 API - Class RestoreVerificationPlanName (2.11.0)

public sealed class RestoreVerificationPlanName : IResourceName, IEquatable<RestoreVerificationPlanName>

Reference documentation and code samples for the Backup and DR Service v1 API class RestoreVerificationPlanName.

Resource name for the RestoreVerificationPlan resource.

Inheritance

object > RestoreVerificationPlanName

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

RestoreVerificationPlanName(string, string, string)

public RestoreVerificationPlanName(string projectId, string locationId, string restoreVerificationPlanId)

Constructs a new instance of a RestoreVerificationPlanName class from the component parts of pattern projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}

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.

restoreVerificationPlanId string

The RestoreVerificationPlan 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

RestoreVerificationPlanId

public string RestoreVerificationPlanId { get; }

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

Property Value
Type Description
string

Type

public RestoreVerificationPlanName.ResourceNameType Type { get; }

The RestoreVerificationPlanName.ResourceNameType of the contained resource name.

Property Value
Type Description
RestoreVerificationPlanNameResourceNameType

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 restoreVerificationPlanId)

Formats the IDs into the string representation of this RestoreVerificationPlanName with pattern projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}.

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.

restoreVerificationPlanId string

The RestoreVerificationPlan ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this RestoreVerificationPlanName with pattern projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}.

FormatProjectLocationRestoreVerificationPlan(string, string, string)

public static string FormatProjectLocationRestoreVerificationPlan(string projectId, string locationId, string restoreVerificationPlanId)

Formats the IDs into the string representation of this RestoreVerificationPlanName with pattern projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}.

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.

restoreVerificationPlanId string

The RestoreVerificationPlan ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this RestoreVerificationPlanName with pattern projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}.

FromProjectLocationRestoreVerificationPlan(string, string, string)

public static RestoreVerificationPlanName FromProjectLocationRestoreVerificationPlan(string projectId, string locationId, string restoreVerificationPlanId)

Creates a RestoreVerificationPlanName with the pattern projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}.

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.

restoreVerificationPlanId string

The RestoreVerificationPlan ID. Must not be null or empty.

Returns
Type Description
RestoreVerificationPlanName

A new instance of RestoreVerificationPlanName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RestoreVerificationPlanName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RestoreVerificationPlanName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
RestoreVerificationPlanName

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

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

Parameter
Name Description
restoreVerificationPlanName string

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

Returns
Type Description
RestoreVerificationPlanName

The parsed RestoreVerificationPlanName if successful.

Remarks

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

  • projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}

Parse(string, bool)

public static RestoreVerificationPlanName Parse(string restoreVerificationPlanName, bool allowUnparsed)

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

Parameters
Name Description
restoreVerificationPlanName 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
RestoreVerificationPlanName

The parsed RestoreVerificationPlanName if successful.

Remarks

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

  • projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}

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 RestoreVerificationPlanName)

public static bool TryParse(string restoreVerificationPlanName, out RestoreVerificationPlanName result)

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

Parameters
Name Description
restoreVerificationPlanName string

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

result RestoreVerificationPlanName

When this method returns, the parsed RestoreVerificationPlanName, 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}/restoreVerificationPlans/{restoreVerificationPlan}

TryParse(string, bool, out RestoreVerificationPlanName)

public static bool TryParse(string restoreVerificationPlanName, bool allowUnparsed, out RestoreVerificationPlanName result)

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

Parameters
Name Description
restoreVerificationPlanName 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 RestoreVerificationPlanName

When this method returns, the parsed RestoreVerificationPlanName, 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}/restoreVerificationPlans/{restoreVerificationPlan}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RestoreVerificationPlanName, RestoreVerificationPlanName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RestoreVerificationPlanName

The first resource name to compare, or null.

b RestoreVerificationPlanName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RestoreVerificationPlanName

The first resource name to compare, or null.

b RestoreVerificationPlanName

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.