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

public sealed class LogicalProductName : IResourceName, IEquatable<LogicalProductName>

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

Resource name for the LogicalProduct resource.

Inheritance

object > LogicalProductName

Namespace

Google.Cloud.ProductRegistry.V1

Assembly

Google.Cloud.ProductRegistry.V1.dll

Constructors

LogicalProductName(string)

public LogicalProductName(string logicalProductId)

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

Parameter
Name Description
logicalProductId string

The LogicalProduct 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 LogicalProductName.ResourceNameType Type { get; }

The LogicalProductName.ResourceNameType of the contained resource name.

Property Value
Type Description
LogicalProductNameResourceNameType

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)

public static string Format(string logicalProductId)

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

Parameter
Name Description
logicalProductId string

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

The string representation of this LogicalProductName with pattern logicalProducts/{logical_product}.

FormatLogicalProduct(string)

public static string FormatLogicalProduct(string logicalProductId)

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

Parameter
Name Description
logicalProductId string

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

The string representation of this LogicalProductName with pattern logicalProducts/{logical_product}.

FromLogicalProduct(string)

public static LogicalProductName FromLogicalProduct(string logicalProductId)

Creates a LogicalProductName with the pattern logicalProducts/{logical_product}.

Parameter
Name Description
logicalProductId string

The LogicalProduct ID. Must not be null or empty.
Returns
Type Description
LogicalProductName

A new instance of LogicalProductName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LogicalProductName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LogicalProductName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
logicalProductName string

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

The parsed LogicalProductName if successful.
Remarks

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

  • logicalProducts/{logical_product}

Parse(string, bool)

public static LogicalProductName Parse(string logicalProductName, bool allowUnparsed)

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

Parameters
Name Description
logicalProductName 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
LogicalProductName

The parsed LogicalProductName if successful.
Remarks

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

  • logicalProducts/{logical_product}

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

public static bool TryParse(string logicalProductName, out LogicalProductName result)

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

Parameters
Name Description
logicalProductName string

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

When this method returns, the parsed LogicalProductName, 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}

TryParse(string, bool, out LogicalProductName)

public static bool TryParse(string logicalProductName, bool allowUnparsed, out LogicalProductName result)

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

Parameters
Name Description
logicalProductName 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 LogicalProductName

When this method returns, the parsed LogicalProductName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LogicalProductName, LogicalProductName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LogicalProductName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LogicalProductName

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

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.