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

public sealed class ProductSuiteName : IResourceName, IEquatable<ProductSuiteName>

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

Resource name for the ProductSuite resource.

Inheritance

object > ProductSuiteName

Namespace

Google.Cloud.ProductRegistry.V1

Assembly

Google.Cloud.ProductRegistry.V1.dll

Constructors

ProductSuiteName(string)

public ProductSuiteName(string productSuiteId)

Constructs a new instance of a ProductSuiteName class from the component parts of pattern productSuites/{product_suite}

Parameter
Name Description
productSuiteId string

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

ProductSuiteId

public string ProductSuiteId { get; }

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

Property Value
Type Description
string

Type

public ProductSuiteName.ResourceNameType Type { get; }

The ProductSuiteName.ResourceNameType of the contained resource name.

Property Value
Type Description
ProductSuiteNameResourceNameType

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

Formats the IDs into the string representation of this ProductSuiteName with pattern productSuites/{product_suite}.

Parameter
Name Description
productSuiteId string

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

The string representation of this ProductSuiteName with pattern productSuites/{product_suite}.

FormatProductSuite(string)

public static string FormatProductSuite(string productSuiteId)

Formats the IDs into the string representation of this ProductSuiteName with pattern productSuites/{product_suite}.

Parameter
Name Description
productSuiteId string

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

The string representation of this ProductSuiteName with pattern productSuites/{product_suite}.

FromProductSuite(string)

public static ProductSuiteName FromProductSuite(string productSuiteId)

Creates a ProductSuiteName with the pattern productSuites/{product_suite}.

Parameter
Name Description
productSuiteId string

The ProductSuite ID. Must not be null or empty.
Returns
Type Description
ProductSuiteName

A new instance of ProductSuiteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProductSuiteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProductSuiteName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
productSuiteName string

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

The parsed ProductSuiteName if successful.
Remarks

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

  • productSuites/{product_suite}

Parse(string, bool)

public static ProductSuiteName Parse(string productSuiteName, bool allowUnparsed)

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

Parameters
Name Description
productSuiteName 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
ProductSuiteName

The parsed ProductSuiteName if successful.
Remarks

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

  • productSuites/{product_suite}

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

public static bool TryParse(string productSuiteName, out ProductSuiteName result)

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

Parameters
Name Description
productSuiteName string

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

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

  • productSuites/{product_suite}

TryParse(string, bool, out ProductSuiteName)

public static bool TryParse(string productSuiteName, bool allowUnparsed, out ProductSuiteName result)

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

Parameters
Name Description
productSuiteName 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 ProductSuiteName

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

  • productSuites/{product_suite}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProductSuiteName, ProductSuiteName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ProductSuiteName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ProductSuiteName

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

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.