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

public sealed class SkuGroupName : IResourceName, IEquatable<SkuGroupName>

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

Resource name for the SkuGroup resource.

Inheritance

object > SkuGroupName

Namespace

Google.Cloud.CommerceProducer.V1Beta

Assembly

Google.Cloud.CommerceProducer.V1Beta.dll

Constructors

SkuGroupName(string, string, string)

public SkuGroupName(string projectId, string locationId, string skuGroupId)

Constructs a new instance of a SkuGroupName class from the component parts of pattern projects/{project}/locations/{location}/skuGroups/{sku_group}

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

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

SkuGroupId

public string SkuGroupId { get; }

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

Property Value
Type Description
string

Type

public SkuGroupName.ResourceNameType Type { get; }

The SkuGroupName.ResourceNameType of the contained resource name.

Property Value
Type Description
SkuGroupNameResourceNameType

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)

public static string Format(string projectId, string locationId, string skuGroupId)

Formats the IDs into the string representation of this SkuGroupName with pattern projects/{project}/locations/{location}/skuGroups/{sku_group}.

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

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

The string representation of this SkuGroupName with pattern projects/{project}/locations/{location}/skuGroups/{sku_group}.

FormatProjectLocationSkuGroup(string, string, string)

public static string FormatProjectLocationSkuGroup(string projectId, string locationId, string skuGroupId)

Formats the IDs into the string representation of this SkuGroupName with pattern projects/{project}/locations/{location}/skuGroups/{sku_group}.

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

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

The string representation of this SkuGroupName with pattern projects/{project}/locations/{location}/skuGroups/{sku_group}.

FromProjectLocationSkuGroup(string, string, string)

public static SkuGroupName FromProjectLocationSkuGroup(string projectId, string locationId, string skuGroupId)

Creates a SkuGroupName with the pattern projects/{project}/locations/{location}/skuGroups/{sku_group}.

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

The SkuGroup ID. Must not be null or empty.
Returns
Type Description
SkuGroupName

A new instance of SkuGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SkuGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SkuGroupName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
skuGroupName string

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

The parsed SkuGroupName if successful.
Remarks

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

  • projects/{project}/locations/{location}/skuGroups/{sku_group}

Parse(string, bool)

public static SkuGroupName Parse(string skuGroupName, bool allowUnparsed)

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

Parameters
Name Description
skuGroupName 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
SkuGroupName

The parsed SkuGroupName if successful.
Remarks

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

  • projects/{project}/locations/{location}/skuGroups/{sku_group}

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

public static bool TryParse(string skuGroupName, out SkuGroupName result)

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

Parameters
Name Description
skuGroupName string

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

When this method returns, the parsed SkuGroupName, 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}/skuGroups/{sku_group}

TryParse(string, bool, out SkuGroupName)

public static bool TryParse(string skuGroupName, bool allowUnparsed, out SkuGroupName result)

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

Parameters
Name Description
skuGroupName 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 SkuGroupName

When this method returns, the parsed SkuGroupName, 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}/skuGroups/{sku_group}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SkuGroupName, SkuGroupName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SkuGroupName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SkuGroupName

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

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.