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.
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 |
bool |
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 |
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 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 |
int |
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, 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 |
allowUnparsed |
bool 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 |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
accounts/{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 |
allowUnparsed |
bool If |
result |
OfferName When this method returns, the parsed OfferName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
accounts/{account}/offers/{offer}
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 |
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 |