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.
Namespace
Google.Cloud.Vision.V1Assembly
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 | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
productId | String The |
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 |
ProductId
public string ProductId { get; }
The Product
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 ProductName.ResourceNameType Type { get; }
The ProductName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
ProductName.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 productId)
Formats the IDs into the string representation of this ProductName with pattern
projects/{project}/locations/{location}/products/{product}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
productId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this ProductName with pattern
|
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 | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
productId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this ProductName with pattern
|
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 | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
productId | String The |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
ProductName | A new instance of ProductName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
Parse(String)
public static ProductName Parse(string productName)
Parses the given resource name string into a new ProductName instance.
Parameter | |
---|---|
Name | Description |
productName | String The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
ProductName | The parsed ProductName if successful. |
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 | |
---|---|
Name | Description |
productName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
ProductName | The parsed ProductName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/products/{product}
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. |
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 | |
---|---|
Name | Description |
productName | String The resource name in string form. Must not be |
result | ProductName When this method returns, the parsed ProductName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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 | |
---|---|
Name | Description |
productName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
result | ProductName When this method returns, the parsed ProductName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/products/{product}
allowUnparsed
is true
.
Operators
Equality(ProductName, ProductName)
public static bool operator ==(ProductName a, ProductName b)
Parameters | |
---|---|
Name | Description |
a | ProductName |
b | ProductName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(ProductName, ProductName)
public static bool operator !=(ProductName a, ProductName b)
Parameters | |
---|---|
Name | Description |
a | ProductName |
b | ProductName |
Returns | |
---|---|
Type | Description |
Boolean |