Class EntitlementName

public sealed class EntitlementName : IResourceName, IEquatable<EntitlementName>

Resource name for the Entitlement resource.

Inheritance

Object > EntitlementName

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Constructors

EntitlementName(String, String, String)

public EntitlementName(string accountId, string customerId, string entitlementId)

Constructs a new instance of a EntitlementName class from the component parts of pattern accounts/{account}/customers/{customer}/entitlements/{entitlement}

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

customerIdString

The Customer ID. Must not be null or empty.

entitlementIdString

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

CustomerId

public string CustomerId { get; }

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

Property Value
TypeDescription
String

EntitlementId

public string EntitlementId { get; }

The Entitlement 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 EntitlementName.ResourceNameType Type { get; }

The EntitlementName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
EntitlementName.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, String)

public static string Format(string accountId, string customerId, string entitlementId)

Formats the IDs into the string representation of this EntitlementName with pattern accounts/{account}/customers/{customer}/entitlements/{entitlement}.

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

customerIdString

The Customer ID. Must not be null or empty.

entitlementIdString

The Entitlement ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this EntitlementName with pattern accounts/{account}/customers/{customer}/entitlements/{entitlement}.

FormatAccountCustomerEntitlement(String, String, String)

public static string FormatAccountCustomerEntitlement(string accountId, string customerId, string entitlementId)

Formats the IDs into the string representation of this EntitlementName with pattern accounts/{account}/customers/{customer}/entitlements/{entitlement}.

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

customerIdString

The Customer ID. Must not be null or empty.

entitlementIdString

The Entitlement ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this EntitlementName with pattern accounts/{account}/customers/{customer}/entitlements/{entitlement}.

FromAccountCustomerEntitlement(String, String, String)

public static EntitlementName FromAccountCustomerEntitlement(string accountId, string customerId, string entitlementId)

Creates a EntitlementName with the pattern accounts/{account}/customers/{customer}/entitlements/{entitlement}.

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

customerIdString

The Customer ID. Must not be null or empty.

entitlementIdString

The Entitlement ID. Must not be null or empty.

Returns
TypeDescription
EntitlementName

A new instance of EntitlementName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EntitlementName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EntitlementName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
EntitlementName

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

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

Parameter
NameDescription
entitlementNameString

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

Returns
TypeDescription
EntitlementName

The parsed EntitlementName if successful.

Remarks

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

  • accounts/{account}/customers/{customer}/entitlements/{entitlement}

Parse(String, Boolean)

public static EntitlementName Parse(string entitlementName, bool allowUnparsed)

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

Parameters
NameDescription
entitlementNameString

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
EntitlementName

The parsed EntitlementName if successful.

Remarks

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

  • accounts/{account}/customers/{customer}/entitlements/{entitlement}
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 EntitlementName)

public static bool TryParse(string entitlementName, out EntitlementName result)

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

Parameters
NameDescription
entitlementNameString

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

resultEntitlementName

When this method returns, the parsed EntitlementName, 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}/customers/{customer}/entitlements/{entitlement}

TryParse(String, Boolean, out EntitlementName)

public static bool TryParse(string entitlementName, bool allowUnparsed, out EntitlementName result)

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

Parameters
NameDescription
entitlementNameString

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.

resultEntitlementName

When this method returns, the parsed EntitlementName, 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}/customers/{customer}/entitlements/{entitlement}
Or may be in any format if allowUnparsed is true.

Operators

Equality(EntitlementName, EntitlementName)

public static bool operator ==(EntitlementName a, EntitlementName b)
Parameters
NameDescription
aEntitlementName
bEntitlementName
Returns
TypeDescription
Boolean

Inequality(EntitlementName, EntitlementName)

public static bool operator !=(EntitlementName a, EntitlementName b)
Parameters
NameDescription
aEntitlementName
bEntitlementName
Returns
TypeDescription
Boolean