Cloud Channel v1 API - Class OfferName (2.4.0)

public sealed class OfferName : IResourceName, IEquatable<OfferName>

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

Resource name for the Offer resource.

Inheritance

Object > OfferName

Implements

IResourceName, IEquatable<OfferName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Constructors

OfferName(String, String)

public OfferName(string accountId, string offerId)

Constructs a new instance of a OfferName class from the component parts of pattern accounts/{account}/offers/{offer}

Parameters
Name	Description
`accountId`	`String` The `Account` ID. Must not be `null` or empty.
`offerId`	`String` The `Offer` 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`

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
`Boolean`

OfferId

public string OfferId { get; }

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

Property Value
Type	Description
`String`

Type

public OfferName.ResourceNameType Type { get; }

The OfferName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`OfferName.ResourceNameType`

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

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

Parameters
Name	Description
`accountId`	`String` The `Account` 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 `accounts/{account}/offers/{offer}` .

FormatAccountOffer(String, String)

public static string FormatAccountOffer(string accountId, string offerId)

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

Parameters
Name	Description
`accountId`	`String` The `Account` 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 `accounts/{account}/offers/{offer}` .

FromAccountOffer(String, String)

public static OfferName FromAccountOffer(string accountId, string offerId)

Creates a OfferName with the pattern accounts/{account}/offers/{offer}.

Parameters
Name	Description
`accountId`	`String` The `Account` 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
`Int32`

Overrides

Object.GetHashCode()

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:

accounts/{account}/offers/{offer}

Parse(String, Boolean)

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`	`Boolean` 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:

accounts/{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

Object.ToString()

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
`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}/offers/{offer}

TryParse(String, Boolean, 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`	`Boolean` 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
`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}/offers/{offer}

Or may be in any format if allowUnparsed is true.

Operators

Equality(OfferName, OfferName)

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

Parameters
Name	Description
`a`	`OfferName`
`b`	`OfferName`

Returns
Type	Description
`Boolean`

Inequality(OfferName, OfferName)

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

Parameters
Name	Description
`a`	`OfferName`
`b`	`OfferName`

Returns
Type	Description
`Boolean`