Cloud Product Registry v1 API - Class LogicalProductVariantName (1.0.0-beta01) 

public sealed class LogicalProductVariantName : IResourceName, IEquatable<LogicalProductVariantName>

Reference documentation and code samples for the Cloud Product Registry v1 API class LogicalProductVariantName.

Resource name for the LogicalProductVariant resource.

Inheritance

object > LogicalProductVariantName

Namespace

Google.Cloud.ProductRegistry.V1

Assembly

Google.Cloud.ProductRegistry.V1.dll

Constructors

LogicalProductVariantName(string, string)

public LogicalProductVariantName(string logicalProductId, string variantId)

Constructs a new instance of a LogicalProductVariantName class from the component parts of pattern logicalProducts/{logical_product}/variants/{variant}

Parameters
Name Description
logicalProductId string

The LogicalProduct ID. Must not be null or empty.
variantId string

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

LogicalProductId

public string LogicalProductId { get; }

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

Property Value
Type Description
string

Type

public LogicalProductVariantName.ResourceNameType Type { get; }

The LogicalProductVariantName.ResourceNameType of the contained resource name.

Property Value
Type Description
LogicalProductVariantNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

VariantId

public string VariantId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string)

public static string Format(string logicalProductId, string variantId)

Formats the IDs into the string representation of this LogicalProductVariantName with pattern logicalProducts/{logical_product}/variants/{variant}.

Parameters
Name Description
logicalProductId string

The LogicalProduct ID. Must not be null or empty.
variantId string

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

The string representation of this LogicalProductVariantName with pattern logicalProducts/{logical_product}/variants/{variant}.

FormatLogicalProductVariant(string, string)

public static string FormatLogicalProductVariant(string logicalProductId, string variantId)

Formats the IDs into the string representation of this LogicalProductVariantName with pattern logicalProducts/{logical_product}/variants/{variant}.

Parameters
Name Description
logicalProductId string

The LogicalProduct ID. Must not be null or empty.
variantId string

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

The string representation of this LogicalProductVariantName with pattern logicalProducts/{logical_product}/variants/{variant}.

FromLogicalProductVariant(string, string)

public static LogicalProductVariantName FromLogicalProductVariant(string logicalProductId, string variantId)

Creates a LogicalProductVariantName with the pattern logicalProducts/{logical_product}/variants/{variant}.

Parameters
Name Description
logicalProductId string

The LogicalProduct ID. Must not be null or empty.
variantId string

The Variant ID. Must not be null or empty.
Returns
Type Description
LogicalProductVariantName

A new instance of LogicalProductVariantName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LogicalProductVariantName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LogicalProductVariantName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
logicalProductVariantName string

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

The parsed LogicalProductVariantName if successful.
Remarks

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

  • logicalProducts/{logical_product}/variants/{variant}

Parse(string, bool)

public static LogicalProductVariantName Parse(string logicalProductVariantName, bool allowUnparsed)

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

Parameters
Name Description
logicalProductVariantName 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
LogicalProductVariantName

The parsed LogicalProductVariantName if successful.
Remarks

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

  • logicalProducts/{logical_product}/variants/{variant}

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

public static bool TryParse(string logicalProductVariantName, out LogicalProductVariantName result)

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

Parameters
Name Description
logicalProductVariantName string

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

When this method returns, the parsed LogicalProductVariantName, 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:

  • logicalProducts/{logical_product}/variants/{variant}

TryParse(string, bool, out LogicalProductVariantName)

public static bool TryParse(string logicalProductVariantName, bool allowUnparsed, out LogicalProductVariantName result)

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

Parameters
Name Description
logicalProductVariantName 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 LogicalProductVariantName

When this method returns, the parsed LogicalProductVariantName, 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:

  • logicalProducts/{logical_product}/variants/{variant}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LogicalProductVariantName, LogicalProductVariantName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LogicalProductVariantName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LogicalProductVariantName

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

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.