Google Cloud Vision v1 API - Class ProductSetName (3.3.0-beta01)

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, IEquatable<ProductSetName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`ProductSetName.ResourceNameType`

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
`Int32`

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, Boolean)

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`	`Boolean` 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
`Boolean`	`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, Boolean, 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`	`Boolean` 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
`Boolean`	`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

Equality(ProductSetName, ProductSetName)

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

Parameters
Name	Description
`a`	`ProductSetName`
`b`	`ProductSetName`

Returns
Type	Description
`Boolean`

Inequality(ProductSetName, ProductSetName)

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

Parameters
Name	Description
`a`	`ProductSetName`
`b`	`ProductSetName`

Returns
Type	Description
`Boolean`