public sealed class OfferName : IResourceName, IEquatable<OfferName>
Resource name for the Offer
resource.
Namespace
Google.Cloud.Channel.V1Assembly
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 |
offerId | String The |
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 |
offerId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this OfferName with pattern |
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 |
offerId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this OfferName with pattern |
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 |
offerId | String The |
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 |
Returns | |
---|---|
Type | Description |
OfferName | A new instance of OfferName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
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 |
Returns | |
---|---|
Type | Description |
OfferName | The parsed OfferName if successful. |
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 |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
OfferName | The parsed OfferName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
accounts/{account}/offers/{offer}
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. |
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 |
result | OfferName When this method returns, the parsed OfferName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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 |
allowUnparsed | Boolean If |
result | OfferName When this method returns, the parsed OfferName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
accounts/{account}/offers/{offer}
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 |