Cloud Channel v1 API - Class EntitlementName (2.7.0)

public sealed class EntitlementName : IResourceName, IEquatable<EntitlementName>

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

Resource name for the Entitlement resource.

Inheritance

object > EntitlementName

Implements

IResourceName, IEquatable EntitlementName

Inherited Members

object.GetType()

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
Name	Description
`accountId`	`string` The `Account` ID. Must not be `null` or empty.
`customerId`	`string` The `Customer` ID. Must not be `null` or empty.
`entitlementId`	`string` 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
Type	Description
`string`

CustomerId

public string CustomerId { get; }

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

Property Value
Type	Description
`string`

EntitlementId

public string EntitlementId { get; }

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

The EntitlementName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`EntitlementNameResourceNameType`

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 accountId, string customerId, string entitlementId)

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

Parameters
Name	Description
`accountId`	`string` The `Account` ID. Must not be `null` or empty.
`customerId`	`string` The `Customer` ID. Must not be `null` or empty.
`entitlementId`	`string` The `Entitlement` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`accountId`	`string` The `Account` ID. Must not be `null` or empty.
`customerId`	`string` The `Customer` ID. Must not be `null` or empty.
`entitlementId`	`string` The `Entitlement` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`accountId`	`string` The `Account` ID. Must not be `null` or empty.
`customerId`	`string` The `Customer` ID. Must not be `null` or empty.
`entitlementId`	`string` The `Entitlement` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`EntitlementName`	A new instance of EntitlementName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static EntitlementName Parse(string entitlementName)

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

Parameter
Name	Description
`entitlementName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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, bool)

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
Name	Description
`entitlementName`	`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
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
`entitlementName`	`string` The resource name in string form. Must not be `null`.
`result`	`EntitlementName` When this method returns, the parsed EntitlementName, 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}/customers/{customer}/entitlements/{entitlement}

TryParse(string, bool, 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
Name	Description
`entitlementName`	`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`	`EntitlementName` When this method returns, the parsed EntitlementName, 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}/customers/{customer}/entitlements/{entitlement}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EntitlementName, EntitlementName)

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

Parameters
Name	Description
`a`	`EntitlementName`
`b`	`EntitlementName`

Returns
Type	Description
`bool`

operator !=(EntitlementName, EntitlementName)

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

Parameters
Name	Description
`a`	`EntitlementName`
`b`	`EntitlementName`

Returns
Type	Description
`bool`