Cloud Commerce Consumer Procurement v1 API - Class LicensePoolName (1.6.0) 

public sealed class LicensePoolName : IResourceName, IEquatable<LicensePoolName>

Reference documentation and code samples for the Cloud Commerce Consumer Procurement v1 API class LicensePoolName.

Resource name for the LicensePool resource.

Inheritance

object > LicensePoolName

Namespace

Google.Cloud.Commerce.Consumer.Procurement.V1

Assembly

Google.Cloud.Commerce.Consumer.Procurement.V1.dll

Constructors

LicensePoolName(string, string)

public LicensePoolName(string billingAccountId, string orderId)

Constructs a new instance of a LicensePoolName class from the component parts of pattern billingAccounts/{billing_account}/orders/{order}/licensePool

Parameters
Name Description
billingAccountId string

The BillingAccount ID. Must not be null or empty.
orderId string

The Order ID. Must not be null or empty.

Properties

BillingAccountId

public string BillingAccountId { get; }

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

OrderId

public string OrderId { get; }

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

Property Value
Type Description
string

Type

public LicensePoolName.ResourceNameType Type { get; }

The LicensePoolName.ResourceNameType of the contained resource name.

Property Value
Type Description
LicensePoolNameResourceNameType

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 billingAccountId, string orderId)

Formats the IDs into the string representation of this LicensePoolName with pattern billingAccounts/{billing_account}/orders/{order}/licensePool.

Parameters
Name Description
billingAccountId string

The BillingAccount ID. Must not be null or empty.
orderId string

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

The string representation of this LicensePoolName with pattern billingAccounts/{billing_account}/orders/{order}/licensePool.

FormatBillingAccountOrder(string, string)

public static string FormatBillingAccountOrder(string billingAccountId, string orderId)

Formats the IDs into the string representation of this LicensePoolName with pattern billingAccounts/{billing_account}/orders/{order}/licensePool.

Parameters
Name Description
billingAccountId string

The BillingAccount ID. Must not be null or empty.
orderId string

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

The string representation of this LicensePoolName with pattern billingAccounts/{billing_account}/orders/{order}/licensePool.

FromBillingAccountOrder(string, string)

public static LicensePoolName FromBillingAccountOrder(string billingAccountId, string orderId)

Creates a LicensePoolName with the pattern billingAccounts/{billing_account}/orders/{order}/licensePool.

Parameters
Name Description
billingAccountId string

The BillingAccount ID. Must not be null or empty.
orderId string

The Order ID. Must not be null or empty.
Returns
Type Description
LicensePoolName

A new instance of LicensePoolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LicensePoolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LicensePoolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
licensePoolName string

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

The parsed LicensePoolName if successful.
Remarks

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

  • billingAccounts/{billing_account}/orders/{order}/licensePool

Parse(string, bool)

public static LicensePoolName Parse(string licensePoolName, bool allowUnparsed)

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

Parameters
Name Description
licensePoolName 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
LicensePoolName

The parsed LicensePoolName if successful.
Remarks

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

  • billingAccounts/{billing_account}/orders/{order}/licensePool
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 LicensePoolName)

public static bool TryParse(string licensePoolName, out LicensePoolName result)

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

Parameters
Name Description
licensePoolName string

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

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

  • billingAccounts/{billing_account}/orders/{order}/licensePool

TryParse(string, bool, out LicensePoolName)

public static bool TryParse(string licensePoolName, bool allowUnparsed, out LicensePoolName result)

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

Parameters
Name Description
licensePoolName 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 LicensePoolName

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

  • billingAccounts/{billing_account}/orders/{order}/licensePool
Or may be in any format if allowUnparsed is true.

Operators

operator ==(LicensePoolName, LicensePoolName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LicensePoolName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LicensePoolName

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

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.