Backup for GKE v1 API - Class BackupChannelName (2.7.0) 

public sealed class BackupChannelName : IResourceName, IEquatable<BackupChannelName>

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

Resource name for the BackupChannel resource.

Inheritance

object > BackupChannelName

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

BackupChannelName(string, string, string)

public BackupChannelName(string projectId, string locationId, string backupChannelId)

Constructs a new instance of a BackupChannelName class from the component parts of pattern projects/{project}/locations/{location}/backupChannels/{backup_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.
backupChannelId string

The BackupChannel ID. Must not be null or empty.

Properties

BackupChannelId

public string BackupChannelId { get; }

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

Property Value
Type Description
string

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

Type

public BackupChannelName.ResourceNameType Type { get; }

The BackupChannelName.ResourceNameType of the contained resource name.

Property Value
Type Description
BackupChannelNameResourceNameType

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

Formats the IDs into the string representation of this BackupChannelName with pattern projects/{project}/locations/{location}/backupChannels/{backup_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.
backupChannelId string

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

The string representation of this BackupChannelName with pattern projects/{project}/locations/{location}/backupChannels/{backup_channel}.

FormatProjectLocationBackupChannel(string, string, string)

public static string FormatProjectLocationBackupChannel(string projectId, string locationId, string backupChannelId)

Formats the IDs into the string representation of this BackupChannelName with pattern projects/{project}/locations/{location}/backupChannels/{backup_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.
backupChannelId string

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

The string representation of this BackupChannelName with pattern projects/{project}/locations/{location}/backupChannels/{backup_channel}.

FromProjectLocationBackupChannel(string, string, string)

public static BackupChannelName FromProjectLocationBackupChannel(string projectId, string locationId, string backupChannelId)

Creates a BackupChannelName with the pattern projects/{project}/locations/{location}/backupChannels/{backup_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.
backupChannelId string

The BackupChannel ID. Must not be null or empty.
Returns
Type Description
BackupChannelName

A new instance of BackupChannelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BackupChannelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BackupChannelName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
backupChannelName string

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

The parsed BackupChannelName if successful.
Remarks

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

  • projects/{project}/locations/{location}/backupChannels/{backup_channel}

Parse(string, bool)

public static BackupChannelName Parse(string backupChannelName, bool allowUnparsed)

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

Parameters
Name Description
backupChannelName 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
BackupChannelName

The parsed BackupChannelName if successful.
Remarks

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

  • projects/{project}/locations/{location}/backupChannels/{backup_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 BackupChannelName)

public static bool TryParse(string backupChannelName, out BackupChannelName result)

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

Parameters
Name Description
backupChannelName string

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

When this method returns, the parsed BackupChannelName, 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}/backupChannels/{backup_channel}

TryParse(string, bool, out BackupChannelName)

public static bool TryParse(string backupChannelName, bool allowUnparsed, out BackupChannelName result)

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

Parameters
Name Description
backupChannelName 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 BackupChannelName

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

Operators

operator ==(BackupChannelName, BackupChannelName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BackupChannelName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BackupChannelName

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

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.