Google Cloud Vision v1 API - Class ProductName (3.2.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ProductName : IResourceName, IEquatable<ProductName>

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

Resource name for the Product resource.

Inheritance

Object > ProductName

Namespace

Google.Cloud.Vision.V1

Assembly

Google.Cloud.Vision.V1.dll

Constructors

ProductName(String, String, String)

public ProductName(string projectId, string locationId, string productId)

Constructs a new instance of a ProductName class from the component parts of pattern projects/{project}/locations/{location}/products/{product}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

productIdString

The Product 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
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProductId

public string ProductId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public ProductName.ResourceNameType Type { get; }

The ProductName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ProductName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String)

public static string Format(string projectId, string locationId, string productId)

Formats the IDs into the string representation of this ProductName with pattern projects/{project}/locations/{location}/products/{product}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

productIdString

The Product ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ProductName with pattern projects/{project}/locations/{location}/products/{product}.

FormatProjectLocationProduct(String, String, String)

public static string FormatProjectLocationProduct(string projectId, string locationId, string productId)

Formats the IDs into the string representation of this ProductName with pattern projects/{project}/locations/{location}/products/{product}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

productIdString

The Product ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ProductName with pattern projects/{project}/locations/{location}/products/{product}.

FromProjectLocationProduct(String, String, String)

public static ProductName FromProjectLocationProduct(string projectId, string locationId, string productId)

Creates a ProductName with the pattern projects/{project}/locations/{location}/products/{product}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

productIdString

The Product ID. Must not be null or empty.

Returns
TypeDescription
ProductName

A new instance of ProductName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProductName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProductName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ProductName

A new instance of ProductName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ProductName Parse(string productName)

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

Parameter
NameDescription
productNameString

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

Returns
TypeDescription
ProductName

The parsed ProductName if successful.

Remarks

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

  • projects/{project}/locations/{location}/products/{product}

Parse(String, Boolean)

public static ProductName Parse(string productName, bool allowUnparsed)

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

Parameters
NameDescription
productNameString

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

allowUnparsedBoolean

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
TypeDescription
ProductName

The parsed ProductName if successful.

Remarks

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

  • projects/{project}/locations/{location}/products/{product}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out ProductName)

public static bool TryParse(string productName, out ProductName result)

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

Parameters
NameDescription
productNameString

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

resultProductName

When this method returns, the parsed ProductName, or null if parsing failed.

Returns
TypeDescription
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}/products/{product}

TryParse(String, Boolean, out ProductName)

public static bool TryParse(string productName, bool allowUnparsed, out ProductName result)

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

Parameters
NameDescription
productNameString

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

allowUnparsedBoolean

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.

resultProductName

When this method returns, the parsed ProductName, or null if parsing failed.

Returns
TypeDescription
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}/products/{product}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ProductName, ProductName)

public static bool operator ==(ProductName a, ProductName b)
Parameters
NameDescription
aProductName
bProductName
Returns
TypeDescription
Boolean

Inequality(ProductName, ProductName)

public static bool operator !=(ProductName a, ProductName b)
Parameters
NameDescription
aProductName
bProductName
Returns
TypeDescription
Boolean