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

public sealed class OfferName : IResourceName, IEquatable<OfferName>

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

Resource name for the Offer resource.

Inheritance

object > OfferName

Namespace

Google.Cloud.Commerce.Consumer.Procurement.V1

Assembly

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

Constructors

OfferName(string, string)

public OfferName(string serviceId, string offerId)

Constructs a new instance of a OfferName class from the component parts of pattern services/{service}/standardOffers/{offer}

Parameters
Name Description
serviceId string

The Service ID. Must not be null or empty.
offerId string

The Offer ID. Must not be null or empty.

Properties

ConsumerBillingAccountId

public string ConsumerBillingAccountId { get; }

The ConsumerBillingAccount ID. May be null, depending on which resource name is contained by this instance.

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

OfferId

public string OfferId { get; }

The Offer ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ServiceId

public string ServiceId { get; }

The Service ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public OfferName.ResourceNameType Type { get; }

The OfferName.ResourceNameType of the contained resource name.

Property Value
Type Description
OfferNameResourceNameType

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 serviceId, string offerId)

Formats the IDs into the string representation of this OfferName with pattern services/{service}/standardOffers/{offer}.

Parameters
Name Description
serviceId string

The Service ID. Must not be null or empty.
offerId string

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

The string representation of this OfferName with pattern services/{service}/standardOffers/{offer}.

FormatConsumerBillingAccountOffer(string, string)

public static string FormatConsumerBillingAccountOffer(string consumerBillingAccountId, string offerId)

Formats the IDs into the string representation of this OfferName with pattern billingAccounts/{consumer_billing_account}/offers/{offer}.

Parameters
Name Description
consumerBillingAccountId string

The ConsumerBillingAccount ID. Must not be null or empty.
offerId string

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

The string representation of this OfferName with pattern billingAccounts/{consumer_billing_account}/offers/{offer}.

FormatServiceOffer(string, string)

public static string FormatServiceOffer(string serviceId, string offerId)

Formats the IDs into the string representation of this OfferName with pattern services/{service}/standardOffers/{offer}.

Parameters
Name Description
serviceId string

The Service ID. Must not be null or empty.
offerId string

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

The string representation of this OfferName with pattern services/{service}/standardOffers/{offer}.

FromConsumerBillingAccountOffer(string, string)

public static OfferName FromConsumerBillingAccountOffer(string consumerBillingAccountId, string offerId)

Creates a OfferName with the pattern billingAccounts/{consumer_billing_account}/offers/{offer}.

Parameters
Name Description
consumerBillingAccountId string

The ConsumerBillingAccount ID. Must not be null or empty.
offerId string

The Offer ID. Must not be null or empty.
Returns
Type Description
OfferName

A new instance of OfferName constructed from the provided ids.

FromServiceOffer(string, string)

public static OfferName FromServiceOffer(string serviceId, string offerId)

Creates a OfferName with the pattern services/{service}/standardOffers/{offer}.

Parameters
Name Description
serviceId string

The Service ID. Must not be null or empty.
offerId string

The Offer ID. Must not be null or empty.
Returns
Type Description
OfferName

A new instance of OfferName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OfferName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OfferName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
offerName string

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

The parsed OfferName if successful.
Remarks

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

  • services/{service}/standardOffers/{offer}
  • billingAccounts/{consumer_billing_account}/offers/{offer}

Parse(string, bool)

public static OfferName Parse(string offerName, bool allowUnparsed)

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

Parameters
Name Description
offerName 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
OfferName

The parsed OfferName if successful.
Remarks

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

  • services/{service}/standardOffers/{offer}
  • billingAccounts/{consumer_billing_account}/offers/{offer}
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 OfferName)

public static bool TryParse(string offerName, out OfferName result)

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

Parameters
Name Description
offerName string

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

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

  • services/{service}/standardOffers/{offer}
  • billingAccounts/{consumer_billing_account}/offers/{offer}

TryParse(string, bool, out OfferName)

public static bool TryParse(string offerName, bool allowUnparsed, out OfferName result)

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

Parameters
Name Description
offerName 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 OfferName

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

  • services/{service}/standardOffers/{offer}
  • billingAccounts/{consumer_billing_account}/offers/{offer}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(OfferName, OfferName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OfferName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OfferName

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

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.