Google Cloud Vision v1 API - Class ReferenceImageName (3.7.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

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

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
ReferenceImageNameResourceNameType

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
int
Overrides

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

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

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
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}/products/{product}/referenceImages/{reference_image}

TryParse(string, bool, 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 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 ReferenceImageName

When this method returns, the parsed ReferenceImageName, 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}/products/{product}/referenceImages/{reference_image}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReferenceImageName, ReferenceImageName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ReferenceImageName

The first resource name to compare, or null.
b ReferenceImageName

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 !=(ReferenceImageName, ReferenceImageName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ReferenceImageName

The first resource name to compare, or null.
b ReferenceImageName

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.