Google Cloud Vision v1 API - Class ProductSetName (3.8.0)

Version latest

• 3.8.0 (latest)
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.5.0
• 2.4.0
• 2.3.0

public sealed class ProductSetName : IResourceName, IEquatable<ProductSetName>

Reference documentation and code samples for the Google Cloud Vision v1 API class ProductSetName.

Resource name for the ProductSet resource.

Inheritance

object > ProductSetName

Implements

IResourceName, IEquatableProductSetName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Vision.V1

Assembly

Google.Cloud.Vision.V1.dll

Constructors

ProductSetName(string, string, string)

public ProductSetName(string projectId, string locationId, string productSetId)

Constructs a new instance of a ProductSetName class from the component parts of pattern projects/{project}/locations/{location}/productSets/{product_set}

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.
productSetId	string The ProductSet 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

ProductSetId

public string ProductSetId { get; }

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

Type

public ProductSetName.ResourceNameType Type { get; }

The ProductSetName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ProductSetNameResourceNameType

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

Formats the IDs into the string representation of this ProductSetName with pattern projects/{project}/locations/{location}/productSets/{product_set}.

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.
productSetId	string The ProductSet ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ProductSetName with pattern projects/{project}/locations/{location}/productSets/{product_set}.

FormatProjectLocationProductSet(string, string, string)

public static string FormatProjectLocationProductSet(string projectId, string locationId, string productSetId)

Formats the IDs into the string representation of this ProductSetName with pattern projects/{project}/locations/{location}/productSets/{product_set}.

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.
productSetId	string The ProductSet ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ProductSetName with pattern projects/{project}/locations/{location}/productSets/{product_set}.

FromProjectLocationProductSet(string, string, string)

public static ProductSetName FromProjectLocationProductSet(string projectId, string locationId, string productSetId)

Creates a ProductSetName with the pattern projects/{project}/locations/{location}/productSets/{product_set}.

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.
productSetId	string The ProductSet ID. Must not be null or empty.

Returns
Type	Description
ProductSetName	A new instance of ProductSetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProductSetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProductSetName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
ProductSetName	A new instance of ProductSetName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static ProductSetName Parse(string productSetName)

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

Parameter
Name	Description
productSetName	string The resource name in string form. Must not be null.

Returns
Type	Description
ProductSetName	The parsed ProductSetName if successful.

Remarks

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

• projects/{project}/locations/{location}/productSets/{product_set}

Parse(string, bool)

public static ProductSetName Parse(string productSetName, bool allowUnparsed)

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

Parameters
Name	Description
productSetName	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
ProductSetName	The parsed ProductSetName if successful.

Remarks

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

• projects/{project}/locations/{location}/productSets/{product_set}

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

object.ToString()

TryParse(string, out ProductSetName)

public static bool TryParse(string productSetName, out ProductSetName result)

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

Parameters
Name	Description
productSetName	string The resource name in string form. Must not be null.
result	ProductSetName When this method returns, the parsed ProductSetName, 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}/productSets/{product_set}

TryParse(string, bool, out ProductSetName)

public static bool TryParse(string productSetName, bool allowUnparsed, out ProductSetName result)

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

Parameters
Name	Description
productSetName	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	ProductSetName When this method returns, the parsed ProductSetName, 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}/productSets/{product_set}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProductSetName, ProductSetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	ProductSetName The first resource name to compare, or null.
b	ProductSetName 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 !=(ProductSetName, ProductSetName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	ProductSetName The first resource name to compare, or null.
b	ProductSetName 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.