Class ChannelPartnerLinkName (2.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ChannelPartnerLinkName : IResourceName, IEquatable<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
NameDescription
accountIdString

The Account ID. Must not be null or empty.

channelPartnerLinkIdString

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
TypeDescription
String

ChannelPartnerLinkId

public string ChannelPartnerLinkId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

Type

public ChannelPartnerLinkName.ResourceNameType Type { get; }

The ChannelPartnerLinkName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ChannelPartnerLinkName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
accountIdString

The Account ID. Must not be null or empty.

channelPartnerLinkIdString

The ChannelPartnerLink ID. Must not be null or empty.

Returns
TypeDescription
String

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

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
NameDescription
accountIdString

The Account ID. Must not be null or empty.

channelPartnerLinkIdString

The ChannelPartnerLink ID. Must not be null or empty.

Returns
TypeDescription
String

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

public static ChannelPartnerLinkName FromAccountChannelPartnerLink(string accountId, string channelPartnerLinkId)

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

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

channelPartnerLinkIdString

The ChannelPartnerLink ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ChannelPartnerLinkName

A new instance of ChannelPartnerLinkName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ChannelPartnerLinkName Parse(string channelPartnerLinkName)

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

Parameter
NameDescription
channelPartnerLinkNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
channelPartnerLinkNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
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
NameDescription
channelPartnerLinkNameString

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

resultChannelPartnerLinkName

When this method returns, the parsed ChannelPartnerLinkName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
channelPartnerLinkNameString

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

allowUnparsedBoolean

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.

resultChannelPartnerLinkName

When this method returns, the parsed ChannelPartnerLinkName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(ChannelPartnerLinkName, ChannelPartnerLinkName)

public static bool operator ==(ChannelPartnerLinkName a, ChannelPartnerLinkName b)
Parameters
NameDescription
aChannelPartnerLinkName
bChannelPartnerLinkName
Returns
TypeDescription
Boolean

Inequality(ChannelPartnerLinkName, ChannelPartnerLinkName)

public static bool operator !=(ChannelPartnerLinkName a, ChannelPartnerLinkName b)
Parameters
NameDescription
aChannelPartnerLinkName
bChannelPartnerLinkName
Returns
TypeDescription
Boolean