Cloud Commerce Producer v1beta API - Class StandardOfferName (1.0.0-beta01) 

public sealed class StandardOfferName : IResourceName, IEquatable<StandardOfferName>

Reference documentation and code samples for the Cloud Commerce Producer v1beta API class StandardOfferName.

Resource name for the StandardOffer resource.

Inheritance

object > StandardOfferName

Namespace

Google.Cloud.CommerceProducer.V1Beta

Assembly

Google.Cloud.CommerceProducer.V1Beta.dll

Constructors

StandardOfferName(string, string, string, string)

public StandardOfferName(string projectId, string locationId, string serviceId, string standardOfferId)

Constructs a new instance of a StandardOfferName class from the component parts of pattern projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceId string

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

The StandardOffer ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
string

ServiceId

public string ServiceId { get; }

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

Property Value
Type Description
string

StandardOfferId

public string StandardOfferId { get; }

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

Property Value
Type Description
string

Type

public StandardOfferName.ResourceNameType Type { get; }

The StandardOfferName.ResourceNameType of the contained resource name.

Property Value
Type Description
StandardOfferNameResourceNameType

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

public static string Format(string projectId, string locationId, string serviceId, string standardOfferId)

Formats the IDs into the string representation of this StandardOfferName with pattern projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceId string

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

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

The string representation of this StandardOfferName with pattern projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}.

FormatProjectLocationServiceStandardOffer(string, string, string, string)

public static string FormatProjectLocationServiceStandardOffer(string projectId, string locationId, string serviceId, string standardOfferId)

Formats the IDs into the string representation of this StandardOfferName with pattern projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceId string

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

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

The string representation of this StandardOfferName with pattern projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}.

FromProjectLocationServiceStandardOffer(string, string, string, string)

public static StandardOfferName FromProjectLocationServiceStandardOffer(string projectId, string locationId, string serviceId, string standardOfferId)

Creates a StandardOfferName with the pattern projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceId string

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

The StandardOffer ID. Must not be null or empty.
Returns
Type Description
StandardOfferName

A new instance of StandardOfferName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static StandardOfferName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a StandardOfferName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
standardOfferName string

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

The parsed StandardOfferName if successful.
Remarks

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

  • projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}

Parse(string, bool)

public static StandardOfferName Parse(string standardOfferName, bool allowUnparsed)

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

Parameters
Name Description
standardOfferName 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
StandardOfferName

The parsed StandardOfferName if successful.
Remarks

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

  • projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_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 StandardOfferName)

public static bool TryParse(string standardOfferName, out StandardOfferName result)

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

Parameters
Name Description
standardOfferName string

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

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

  • projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}

TryParse(string, bool, out StandardOfferName)

public static bool TryParse(string standardOfferName, bool allowUnparsed, out StandardOfferName result)

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

Parameters
Name Description
standardOfferName 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 StandardOfferName

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

  • projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(StandardOfferName, StandardOfferName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a StandardOfferName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a StandardOfferName

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

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.