Cloud Channel v1 API - Class ChannelPartnerLinkName (2.15.0) 

public sealed class ChannelPartnerLinkName : IResourceName, IEquatable<ChannelPartnerLinkName>

Reference documentation and code samples for the Cloud Channel v1 API class ChannelPartnerLinkName.

Resource name for the ChannelPartnerLink resource.

Inheritance

object > ChannelPartnerLinkName

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Constructors

ChannelPartnerLinkName(string, string)

public ChannelPartnerLinkName(string accountId, string channelPartnerLinkId)

Constructs a new instance of a ChannelPartnerLinkName class from the component parts of pattern accounts/{account}/channelPartnerLinks/{channel_partner_link}

Parameters
Name Description
accountId string

The Account ID. Must not be null or empty.
channelPartnerLinkId string

The ChannelPartnerLink ID. Must not be null or empty.

Properties

AccountId

public string AccountId { get; }

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

Property Value
Type Description
string

ChannelPartnerLinkId

public string ChannelPartnerLinkId { get; }

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

Type

public ChannelPartnerLinkName.ResourceNameType Type { get; }

The ChannelPartnerLinkName.ResourceNameType of the contained resource name.

Property Value
Type Description
ChannelPartnerLinkNameResourceNameType

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)

public static string Format(string accountId, string channelPartnerLinkId)

Formats the IDs into the string representation of this ChannelPartnerLinkName with pattern accounts/{account}/channelPartnerLinks/{channel_partner_link}.

Parameters
Name Description
accountId string

The Account ID. Must not be null or empty.
channelPartnerLinkId string

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

The string representation of this ChannelPartnerLinkName with pattern accounts/{account}/channelPartnerLinks/{channel_partner_link}.

FormatAccountChannelPartnerLink(string, string)

public static string FormatAccountChannelPartnerLink(string accountId, string channelPartnerLinkId)

Formats the IDs into the string representation of this ChannelPartnerLinkName with pattern accounts/{account}/channelPartnerLinks/{channel_partner_link}.

Parameters
Name Description
accountId string

The Account ID. Must not be null or empty.
channelPartnerLinkId string

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

The string representation of this ChannelPartnerLinkName with pattern accounts/{account}/channelPartnerLinks/{channel_partner_link}.

FromAccountChannelPartnerLink(string, string)

public static ChannelPartnerLinkName FromAccountChannelPartnerLink(string accountId, string channelPartnerLinkId)

Creates a ChannelPartnerLinkName with the pattern accounts/{account}/channelPartnerLinks/{channel_partner_link}.

Parameters
Name Description
accountId string

The Account ID. Must not be null or empty.
channelPartnerLinkId string

The ChannelPartnerLink ID. Must not be null or empty.
Returns
Type Description
ChannelPartnerLinkName

A new instance of ChannelPartnerLinkName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ChannelPartnerLinkName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ChannelPartnerLinkName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
channelPartnerLinkName string

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

The parsed ChannelPartnerLinkName if successful.
Remarks

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

  • accounts/{account}/channelPartnerLinks/{channel_partner_link}

Parse(string, bool)

public static ChannelPartnerLinkName Parse(string channelPartnerLinkName, bool allowUnparsed)

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

Parameters
Name Description
channelPartnerLinkName 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
ChannelPartnerLinkName

The parsed ChannelPartnerLinkName if successful.
Remarks

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

  • accounts/{account}/channelPartnerLinks/{channel_partner_link}
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 ChannelPartnerLinkName)

public static bool TryParse(string channelPartnerLinkName, out ChannelPartnerLinkName result)

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

Parameters
Name Description
channelPartnerLinkName string

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

When this method returns, the parsed ChannelPartnerLinkName, 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:

  • accounts/{account}/channelPartnerLinks/{channel_partner_link}

TryParse(string, bool, out ChannelPartnerLinkName)

public static bool TryParse(string channelPartnerLinkName, bool allowUnparsed, out ChannelPartnerLinkName result)

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

Parameters
Name Description
channelPartnerLinkName 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 ChannelPartnerLinkName

When this method returns, the parsed ChannelPartnerLinkName, 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:

  • accounts/{account}/channelPartnerLinks/{channel_partner_link}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ChannelPartnerLinkName, ChannelPartnerLinkName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ChannelPartnerLinkName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ChannelPartnerLinkName

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

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.