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

public sealed class PrivateOfferDocumentName : IResourceName, IEquatable<PrivateOfferDocumentName>

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

Resource name for the PrivateOfferDocument resource.

Inheritance

object > PrivateOfferDocumentName

Namespace

Google.Cloud.CommerceProducer.V1Beta

Assembly

Google.Cloud.CommerceProducer.V1Beta.dll

Constructors

PrivateOfferDocumentName(string, string, string, string)

public PrivateOfferDocumentName(string projectId, string locationId, string privateOfferId, string documentId)

Constructs a new instance of a PrivateOfferDocumentName class from the component parts of pattern projects/{project}/locations/{location}/privateOffers/{private_offer}/documents/{document}

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.
privateOfferId string

The PrivateOffer ID. Must not be null or empty.
documentId string

The Document ID. Must not be null or empty.

Properties

DocumentId

public string DocumentId { get; }

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

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

PrivateOfferId

public string PrivateOfferId { get; }

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

Type

public PrivateOfferDocumentName.ResourceNameType Type { get; }

The PrivateOfferDocumentName.ResourceNameType of the contained resource name.

Property Value
Type Description
PrivateOfferDocumentNameResourceNameType

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

Formats the IDs into the string representation of this PrivateOfferDocumentName with pattern projects/{project}/locations/{location}/privateOffers/{private_offer}/documents/{document}.

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.
privateOfferId string

The PrivateOffer ID. Must not be null or empty.
documentId string

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

The string representation of this PrivateOfferDocumentName with pattern projects/{project}/locations/{location}/privateOffers/{private_offer}/documents/{document}.

FormatProjectLocationPrivateOfferDocument(string, string, string, string)

public static string FormatProjectLocationPrivateOfferDocument(string projectId, string locationId, string privateOfferId, string documentId)

Formats the IDs into the string representation of this PrivateOfferDocumentName with pattern projects/{project}/locations/{location}/privateOffers/{private_offer}/documents/{document}.

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.
privateOfferId string

The PrivateOffer ID. Must not be null or empty.
documentId string

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

The string representation of this PrivateOfferDocumentName with pattern projects/{project}/locations/{location}/privateOffers/{private_offer}/documents/{document}.

FromProjectLocationPrivateOfferDocument(string, string, string, string)

public static PrivateOfferDocumentName FromProjectLocationPrivateOfferDocument(string projectId, string locationId, string privateOfferId, string documentId)

Creates a PrivateOfferDocumentName with the pattern projects/{project}/locations/{location}/privateOffers/{private_offer}/documents/{document}.

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.
privateOfferId string

The PrivateOffer ID. Must not be null or empty.
documentId string

The Document ID. Must not be null or empty.
Returns
Type Description
PrivateOfferDocumentName

A new instance of PrivateOfferDocumentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PrivateOfferDocumentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PrivateOfferDocumentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
privateOfferDocumentName string

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

The parsed PrivateOfferDocumentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/privateOffers/{private_offer}/documents/{document}

Parse(string, bool)

public static PrivateOfferDocumentName Parse(string privateOfferDocumentName, bool allowUnparsed)

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

Parameters
Name Description
privateOfferDocumentName 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
PrivateOfferDocumentName

The parsed PrivateOfferDocumentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/privateOffers/{private_offer}/documents/{document}

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 PrivateOfferDocumentName)

public static bool TryParse(string privateOfferDocumentName, out PrivateOfferDocumentName result)

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

Parameters
Name Description
privateOfferDocumentName string

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

When this method returns, the parsed PrivateOfferDocumentName, 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}/privateOffers/{private_offer}/documents/{document}

TryParse(string, bool, out PrivateOfferDocumentName)

public static bool TryParse(string privateOfferDocumentName, bool allowUnparsed, out PrivateOfferDocumentName result)

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

Parameters
Name Description
privateOfferDocumentName 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 PrivateOfferDocumentName

When this method returns, the parsed PrivateOfferDocumentName, 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}/privateOffers/{private_offer}/documents/{document}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PrivateOfferDocumentName, PrivateOfferDocumentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PrivateOfferDocumentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PrivateOfferDocumentName

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

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.