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

public sealed class SearchConfigName : IResourceName, IEquatable<SearchConfigName>

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

Resource name for the SearchConfig resource.

Inheritance

object > SearchConfigName

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

SearchConfigName(string, string, string, string)

public SearchConfigName(string projectNumberId, string locationId, string corpusId, string searchConfigId)

Constructs a new instance of a SearchConfigName class from the component parts of pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

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.
searchConfigId string

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

SearchConfigId

public string SearchConfigId { get; }

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

Property Value
Type Description
string

Type

public SearchConfigName.ResourceNameType Type { get; }

The SearchConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
SearchConfigNameResourceNameType

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

Formats the IDs into the string representation of this SearchConfigName with pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}.

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.
searchConfigId string

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

The string representation of this SearchConfigName with pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}.

FormatProjectNumberLocationCorpusSearchConfig(string, string, string, string)

public static string FormatProjectNumberLocationCorpusSearchConfig(string projectNumberId, string locationId, string corpusId, string searchConfigId)

Formats the IDs into the string representation of this SearchConfigName with pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}.

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.
searchConfigId string

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

The string representation of this SearchConfigName with pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}.

FromProjectNumberLocationCorpusSearchConfig(string, string, string, string)

public static SearchConfigName FromProjectNumberLocationCorpusSearchConfig(string projectNumberId, string locationId, string corpusId, string searchConfigId)

Creates a SearchConfigName with the pattern projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}.

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.
searchConfigId string

The SearchConfig ID. Must not be null or empty.
Returns
Type Description
SearchConfigName

A new instance of SearchConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SearchConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SearchConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
searchConfigName string

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

The parsed SearchConfigName if successful.
Remarks

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

  • projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

Parse(string, bool)

public static SearchConfigName Parse(string searchConfigName, bool allowUnparsed)

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

Parameters
Name Description
searchConfigName 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
SearchConfigName

The parsed SearchConfigName if successful.
Remarks

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

  • projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}
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 SearchConfigName)

public static bool TryParse(string searchConfigName, out SearchConfigName result)

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

Parameters
Name Description
searchConfigName string

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

When this method returns, the parsed SearchConfigName, 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}/searchConfigs/{search_config}

TryParse(string, bool, out SearchConfigName)

public static bool TryParse(string searchConfigName, bool allowUnparsed, out SearchConfigName result)

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

Parameters
Name Description
searchConfigName 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 SearchConfigName

When this method returns, the parsed SearchConfigName, 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}/searchConfigs/{search_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SearchConfigName, SearchConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SearchConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SearchConfigName

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

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.