Vision AI v1 API - Class SearchHypernymName (1.0.0-beta01) 

public sealed class SearchHypernymName : IResourceName, IEquatable<SearchHypernymName>

Reference documentation and code samples for the Vision AI v1 API class SearchHypernymName.

Resource name for the SearchHypernym resource.

Inheritance

object > SearchHypernymName

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

SearchHypernymName(string, string, string, string)

public SearchHypernymName(string projectNumberId, string locationId, string corpusId, string searchHypernymId)

Constructs a new instance of a SearchHypernymName class from the component parts of pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}

Parameters
Name Description
projectNumberId string

The ProjectNumber ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
corpusId string

The Corpus ID. Must not be null or empty.
searchHypernymId string

The SearchHypernym ID. Must not be null or empty.

Properties

CorpusId

public string CorpusId { get; }

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

Property Value
Type Description
string

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

ProjectNumberId

public string ProjectNumberId { get; }

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

Property Value
Type Description
string

SearchHypernymId

public string SearchHypernymId { get; }

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

Property Value
Type Description
string

Type

public SearchHypernymName.ResourceNameType Type { get; }

The SearchHypernymName.ResourceNameType of the contained resource name.

Property Value
Type Description
SearchHypernymNameResourceNameType

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 projectNumberId, string locationId, string corpusId, string searchHypernymId)

Formats the IDs into the string representation of this SearchHypernymName with pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}.

Parameters
Name Description
projectNumberId string

The ProjectNumber ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
corpusId string

The Corpus ID. Must not be null or empty.
searchHypernymId string

The SearchHypernym ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SearchHypernymName with pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}.

FormatProjectNumberLocationCorpusSearchHypernym(string, string, string, string)

public static string FormatProjectNumberLocationCorpusSearchHypernym(string projectNumberId, string locationId, string corpusId, string searchHypernymId)

Formats the IDs into the string representation of this SearchHypernymName with pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}.

Parameters
Name Description
projectNumberId string

The ProjectNumber ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
corpusId string

The Corpus ID. Must not be null or empty.
searchHypernymId string

The SearchHypernym ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SearchHypernymName with pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}.

FromProjectNumberLocationCorpusSearchHypernym(string, string, string, string)

public static SearchHypernymName FromProjectNumberLocationCorpusSearchHypernym(string projectNumberId, string locationId, string corpusId, string searchHypernymId)

Creates a SearchHypernymName with the pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}.

Parameters
Name Description
projectNumberId string

The ProjectNumber ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
corpusId string

The Corpus ID. Must not be null or empty.
searchHypernymId string

The SearchHypernym ID. Must not be null or empty.
Returns
Type Description
SearchHypernymName

A new instance of SearchHypernymName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SearchHypernymName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SearchHypernymName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
SearchHypernymName

A new instance of SearchHypernymName 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 SearchHypernymName Parse(string searchHypernymName)

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

Parameter
Name Description
searchHypernymName string

The resource name in string form. Must not be null.
Returns
Type Description
SearchHypernymName

The parsed SearchHypernymName if successful.
Remarks

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

  • projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}

Parse(string, bool)

public static SearchHypernymName Parse(string searchHypernymName, bool allowUnparsed)

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

Parameters
Name Description
searchHypernymName 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
SearchHypernymName

The parsed SearchHypernymName if successful.
Remarks

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

  • projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}
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 SearchHypernymName)

public static bool TryParse(string searchHypernymName, out SearchHypernymName result)

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

Parameters
Name Description
searchHypernymName string

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

When this method returns, the parsed SearchHypernymName, 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_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}

TryParse(string, bool, out SearchHypernymName)

public static bool TryParse(string searchHypernymName, bool allowUnparsed, out SearchHypernymName result)

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

Parameters
Name Description
searchHypernymName 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 SearchHypernymName

When this method returns, the parsed SearchHypernymName, 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_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SearchHypernymName, SearchHypernymName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SearchHypernymName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SearchHypernymName

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

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.