GDC Hardware Management v1alpha API - Class SkuName (1.0.0-alpha02) 

public sealed class SkuName : IResourceName, IEquatable<SkuName>

Reference documentation and code samples for the GDC Hardware Management v1alpha API class SkuName.

Resource name for the Sku resource.

Inheritance

object > SkuName

Namespace

Google.Cloud.GdcHardwareManagement.V1Alpha

Assembly

Google.Cloud.GdcHardwareManagement.V1Alpha.dll

Constructors

SkuName(string, string, string)

public SkuName(string projectId, string locationId, string skuId)

Constructs a new instance of a SkuName class from the component parts of pattern projects/{project}/locations/{location}/skus/{sku}

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

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

SkuId

public string SkuId { get; }

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

Property Value
Type Description
string

Type

public SkuName.ResourceNameType Type { get; }

The SkuName.ResourceNameType of the contained resource name.

Property Value
Type Description
SkuNameResourceNameType

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

Formats the IDs into the string representation of this SkuName with pattern projects/{project}/locations/{location}/skus/{sku}.

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

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

The string representation of this SkuName with pattern projects/{project}/locations/{location}/skus/{sku}.

FormatProjectLocationSku(string, string, string)

public static string FormatProjectLocationSku(string projectId, string locationId, string skuId)

Formats the IDs into the string representation of this SkuName with pattern projects/{project}/locations/{location}/skus/{sku}.

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

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

The string representation of this SkuName with pattern projects/{project}/locations/{location}/skus/{sku}.

FromProjectLocationSku(string, string, string)

public static SkuName FromProjectLocationSku(string projectId, string locationId, string skuId)

Creates a SkuName with the pattern projects/{project}/locations/{location}/skus/{sku}.

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

The Sku ID. Must not be null or empty.
Returns
Type Description
SkuName

A new instance of SkuName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SkuName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SkuName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
skuName string

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

The parsed SkuName if successful.
Remarks

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

  • projects/{project}/locations/{location}/skus/{sku}

Parse(string, bool)

public static SkuName Parse(string skuName, bool allowUnparsed)

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

Parameters
Name Description
skuName 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
SkuName

The parsed SkuName if successful.
Remarks

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

  • projects/{project}/locations/{location}/skus/{sku}
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 SkuName)

public static bool TryParse(string skuName, out SkuName result)

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

Parameters
Name Description
skuName string

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

When this method returns, the parsed SkuName, 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}/skus/{sku}

TryParse(string, bool, out SkuName)

public static bool TryParse(string skuName, bool allowUnparsed, out SkuName result)

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

Parameters
Name Description
skuName 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 SkuName

When this method returns, the parsed SkuName, 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}/skus/{sku}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SkuName, SkuName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SkuName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SkuName

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

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.