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

public sealed class CorpusName : IResourceName, IEquatable<CorpusName>

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

Resource name for the Corpus resource.

Inheritance

object > CorpusName

Implements

IResourceName, IEquatableCorpusName

Inherited Members

object.GetType()

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

CorpusName(string, string, string)

public CorpusName(string projectNumberId, string locationId, string corpusId)

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

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.

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

Type

public CorpusName.ResourceNameType Type { get; }

The CorpusName.ResourceNameType of the contained resource name.

Property Value
Type	Description
CorpusNameResourceNameType

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

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

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.

Returns
Type	Description
string	The string representation of this CorpusName with pattern projects/{project_number}/locations/{location}/corpora/{corpus}.

FormatProjectNumberLocationCorpus(string, string, string)

public static string FormatProjectNumberLocationCorpus(string projectNumberId, string locationId, string corpusId)

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

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.

Returns
Type	Description
string	The string representation of this CorpusName with pattern projects/{project_number}/locations/{location}/corpora/{corpus}.

FromProjectNumberLocationCorpus(string, string, string)

public static CorpusName FromProjectNumberLocationCorpus(string projectNumberId, string locationId, string corpusId)

Creates a CorpusName with the pattern projects/{project_number}/locations/{location}/corpora/{corpus}.

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.

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

FromUnparsed(UnparsedResourceName)

public static CorpusName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CorpusName containing an unparsed resource name.

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

Returns
Type	Description
CorpusName	A new instance of CorpusName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static CorpusName Parse(string corpusName)

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

Parameter
Name	Description
corpusName	string The resource name in string form. Must not be null.

Returns
Type	Description
CorpusName	The parsed CorpusName if successful.

Remarks

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

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

Parse(string, bool)

public static CorpusName Parse(string corpusName, bool allowUnparsed)

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

Parameters
Name	Description
corpusName	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
CorpusName	The parsed CorpusName if successful.

Remarks

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

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

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

public static bool TryParse(string corpusName, out CorpusName result)

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

Parameters
Name	Description
corpusName	string The resource name in string form. Must not be null.
result	CorpusName When this method returns, the parsed CorpusName, 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}

TryParse(string, bool, out CorpusName)

public static bool TryParse(string corpusName, bool allowUnparsed, out CorpusName result)

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

Parameters
Name	Description
corpusName	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	CorpusName When this method returns, the parsed CorpusName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CorpusName, CorpusName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	CorpusName The first resource name to compare, or null.
b	CorpusName 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 !=(CorpusName, CorpusName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	CorpusName The first resource name to compare, or null.
b	CorpusName 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.