Backup for GKE v1 API - Class RestoreChannelName (2.7.0) 

public sealed class RestoreChannelName : IResourceName, IEquatable<RestoreChannelName>

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

Resource name for the RestoreChannel resource.

Inheritance

object > RestoreChannelName

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

RestoreChannelName(string, string, string)

public RestoreChannelName(string projectId, string locationId, string restoreChannelId)

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

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.

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

Type

public RestoreChannelName.ResourceNameType Type { get; }

The RestoreChannelName.ResourceNameType of the contained resource name.

Property Value
Type Description
RestoreChannelNameResourceNameType

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

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

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

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

FormatProjectLocationRestoreChannel(string, string, string)

public static string FormatProjectLocationRestoreChannel(string projectId, string locationId, string restoreChannelId)

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

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

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

FromProjectLocationRestoreChannel(string, string, string)

public static RestoreChannelName FromProjectLocationRestoreChannel(string projectId, string locationId, string restoreChannelId)

Creates a RestoreChannelName with the pattern projects/{project}/locations/{location}/restoreChannels/{restore_channel}.

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

A new instance of RestoreChannelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RestoreChannelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RestoreChannelName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
restoreChannelName string

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

The parsed RestoreChannelName if successful.
Remarks

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

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

Parse(string, bool)

public static RestoreChannelName Parse(string restoreChannelName, bool allowUnparsed)

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

Parameters
Name Description
restoreChannelName 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
RestoreChannelName

The parsed RestoreChannelName if successful.
Remarks

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

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

public static bool TryParse(string restoreChannelName, out RestoreChannelName result)

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

Parameters
Name Description
restoreChannelName string

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

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

TryParse(string, bool, out RestoreChannelName)

public static bool TryParse(string restoreChannelName, bool allowUnparsed, out RestoreChannelName result)

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

Parameters
Name Description
restoreChannelName 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 RestoreChannelName

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

Operators

operator ==(RestoreChannelName, RestoreChannelName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RestoreChannelName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RestoreChannelName

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

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.