Google Cloud Vision v1 API - Class ReferenceImageName (3.2.0)

public sealed class ReferenceImageName : IResourceName, IEquatable<ReferenceImageName>

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

Resource name for the ReferenceImage resource.

Inheritance

Object > ReferenceImageName

Implements

IResourceName, IEquatable<ReferenceImageName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Vision.V1

Assembly

Google.Cloud.Vision.V1.dll

Constructors

ReferenceImageName(String, String, String, String)

public ReferenceImageName(string projectId, string locationId, string productId, string referenceImageId)

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

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.
`productId`	`String` The `Product` ID. Must not be `null` or empty.
`referenceImageId`	`String` The `ReferenceImage` 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`

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`

ReferenceImageId

public string ReferenceImageId { get; }

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

Property Value
Type	Description
`String`

Type

public ReferenceImageName.ResourceNameType Type { get; }

The ReferenceImageName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ReferenceImageName.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, String)

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

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

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.
`productId`	`String` The `Product` ID. Must not be `null` or empty.
`referenceImageId`	`String` The `ReferenceImage` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ReferenceImageName with pattern `projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image}`.

FormatProjectLocationProductReferenceImage(String, String, String, String)

public static string FormatProjectLocationProductReferenceImage(string projectId, string locationId, string productId, string referenceImageId)

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

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.
`productId`	`String` The `Product` ID. Must not be `null` or empty.
`referenceImageId`	`String` The `ReferenceImage` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ReferenceImageName with pattern `projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image}`.

FromProjectLocationProductReferenceImage(String, String, String, String)

public static ReferenceImageName FromProjectLocationProductReferenceImage(string projectId, string locationId, string productId, string referenceImageId)

Creates a ReferenceImageName with the pattern projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image}.

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.
`productId`	`String` The `Product` ID. Must not be `null` or empty.
`referenceImageId`	`String` The `ReferenceImage` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ReferenceImageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReferenceImageName containing an unparsed resource name.

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

Returns
Type	Description
`ReferenceImageName`	A new instance of ReferenceImageName 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 ReferenceImageName Parse(string referenceImageName)

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

Parameter
Name	Description
`referenceImageName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`ReferenceImageName`	The parsed ReferenceImageName if successful.

Remarks

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

projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image}

Parse(String, Boolean)

public static ReferenceImageName Parse(string referenceImageName, bool allowUnparsed)

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

Parameters
Name	Description
`referenceImageName`	`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
`ReferenceImageName`	The parsed ReferenceImageName if successful.

Remarks

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

projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image}

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

public static bool TryParse(string referenceImageName, out ReferenceImageName result)

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

Parameters
Name	Description
`referenceImageName`	`String` The resource name in string form. Must not be `null`.
`result`	`ReferenceImageName` When this method returns, the parsed ReferenceImageName, 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}/products/{product}/referenceImages/{reference_image}

TryParse(String, Boolean, out ReferenceImageName)

public static bool TryParse(string referenceImageName, bool allowUnparsed, out ReferenceImageName result)

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

Parameters
Name	Description
`referenceImageName`	`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`	`ReferenceImageName` When this method returns, the parsed ReferenceImageName, 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}/products/{product}/referenceImages/{reference_image}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ReferenceImageName, ReferenceImageName)

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

Parameters
Name	Description
`a`	`ReferenceImageName`
`b`	`ReferenceImageName`

Returns
Type	Description
`Boolean`

Inequality(ReferenceImageName, ReferenceImageName)

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

Parameters
Name	Description
`a`	`ReferenceImageName`
`b`	`ReferenceImageName`

Returns
Type	Description
`Boolean`