Backup for GKE v1 API - Class RestorePlanBindingName (2.7.0) 

public sealed class RestorePlanBindingName : IResourceName, IEquatable<RestorePlanBindingName>

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

Resource name for the RestorePlanBinding resource.

Inheritance

object > RestorePlanBindingName

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

RestorePlanBindingName(string, string, string, string)

public RestorePlanBindingName(string projectId, string locationId, string restoreChannelId, string restorePlanBindingId)

Constructs a new instance of a RestorePlanBindingName class from the component parts of pattern projects/{project}/locations/{location}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding}

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

The RestoreChannel ID. Must not be null or empty.
restorePlanBindingId string

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

RestoreChannelId

public string RestoreChannelId { get; }

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

Property Value
Type Description
string

RestorePlanBindingId

public string RestorePlanBindingId { get; }

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

Property Value
Type Description
string

Type

public RestorePlanBindingName.ResourceNameType Type { get; }

The RestorePlanBindingName.ResourceNameType of the contained resource name.

Property Value
Type Description
RestorePlanBindingNameResourceNameType

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 restoreChannelId, string restorePlanBindingId)

Formats the IDs into the string representation of this RestorePlanBindingName with pattern projects/{project}/locations/{location}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding} .

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

The RestoreChannel ID. Must not be null or empty.
restorePlanBindingId string

The RestorePlanBinding ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this RestorePlanBindingName with pattern projects/{project}/locations/{location}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding} .

FormatProjectLocationRestoreChannelRestorePlanBinding(string, string, string, string)

public static string FormatProjectLocationRestoreChannelRestorePlanBinding(string projectId, string locationId, string restoreChannelId, string restorePlanBindingId)

Formats the IDs into the string representation of this RestorePlanBindingName with pattern projects/{project}/locations/{location}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding} .

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

The RestoreChannel ID. Must not be null or empty.
restorePlanBindingId string

The RestorePlanBinding ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this RestorePlanBindingName with pattern projects/{project}/locations/{location}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding} .

FromProjectLocationRestoreChannelRestorePlanBinding(string, string, string, string)

public static RestorePlanBindingName FromProjectLocationRestoreChannelRestorePlanBinding(string projectId, string locationId, string restoreChannelId, string restorePlanBindingId)

Creates a RestorePlanBindingName with the pattern projects/{project}/locations/{location}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding} .

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

The RestoreChannel ID. Must not be null or empty.
restorePlanBindingId string

The RestorePlanBinding ID. Must not be null or empty.
Returns
Type Description
RestorePlanBindingName

A new instance of RestorePlanBindingName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RestorePlanBindingName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RestorePlanBindingName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
restorePlanBindingName string

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

The parsed RestorePlanBindingName if successful.
Remarks

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

  • projects/{project}/locations/{location}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding}

Parse(string, bool)

public static RestorePlanBindingName Parse(string restorePlanBindingName, bool allowUnparsed)

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

Parameters
Name Description
restorePlanBindingName 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
RestorePlanBindingName

The parsed RestorePlanBindingName if successful.
Remarks

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

  • projects/{project}/locations/{location}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding}
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 RestorePlanBindingName)

public static bool TryParse(string restorePlanBindingName, out RestorePlanBindingName result)

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

Parameters
Name Description
restorePlanBindingName string

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

When this method returns, the parsed RestorePlanBindingName, 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}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding}

TryParse(string, bool, out RestorePlanBindingName)

public static bool TryParse(string restorePlanBindingName, bool allowUnparsed, out RestorePlanBindingName result)

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

Parameters
Name Description
restorePlanBindingName 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 RestorePlanBindingName

When this method returns, the parsed RestorePlanBindingName, 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}/restoreChannels/{restore_channel}/restorePlanBindings/{restore_plan_binding}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RestorePlanBindingName, RestorePlanBindingName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RestorePlanBindingName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RestorePlanBindingName

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

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.