Cloud Speech-to-Text v2 API - Class RecognizerName (1.5.0) 

public sealed class RecognizerName : IResourceName, IEquatable<RecognizerName>

Reference documentation and code samples for the Cloud Speech-to-Text v2 API class RecognizerName.

Resource name for the Recognizer resource.

Inheritance

object > RecognizerName

Namespace

Google.Cloud.Speech.V2

Assembly

Google.Cloud.Speech.V2.dll

Constructors

RecognizerName(string, string, string)

public RecognizerName(string projectId, string locationId, string recognizerId)

Constructs a new instance of a RecognizerName class from the component parts of pattern projects/{project}/locations/{location}/recognizers/{recognizer}

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

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

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

RecognizerId

public string RecognizerId { get; }

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

Property Value
Type Description
string

Type

public RecognizerName.ResourceNameType Type { get; }

The RecognizerName.ResourceNameType of the contained resource name.

Property Value
Type Description
RecognizerNameResourceNameType

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 projectId, string locationId, string recognizerId)

Formats the IDs into the string representation of this RecognizerName with pattern projects/{project}/locations/{location}/recognizers/{recognizer}.

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

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

The string representation of this RecognizerName with pattern projects/{project}/locations/{location}/recognizers/{recognizer}.

FormatProjectLocationRecognizer(string, string, string)

public static string FormatProjectLocationRecognizer(string projectId, string locationId, string recognizerId)

Formats the IDs into the string representation of this RecognizerName with pattern projects/{project}/locations/{location}/recognizers/{recognizer}.

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

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

The string representation of this RecognizerName with pattern projects/{project}/locations/{location}/recognizers/{recognizer}.

FromProjectLocationRecognizer(string, string, string)

public static RecognizerName FromProjectLocationRecognizer(string projectId, string locationId, string recognizerId)

Creates a RecognizerName with the pattern projects/{project}/locations/{location}/recognizers/{recognizer}.

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

The Recognizer ID. Must not be null or empty.
Returns
Type Description
RecognizerName

A new instance of RecognizerName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RecognizerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RecognizerName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
recognizerName string

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

The parsed RecognizerName if successful.
Remarks

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

  • projects/{project}/locations/{location}/recognizers/{recognizer}

Parse(string, bool)

public static RecognizerName Parse(string recognizerName, bool allowUnparsed)

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

Parameters
Name Description
recognizerName 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
RecognizerName

The parsed RecognizerName if successful.
Remarks

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

  • projects/{project}/locations/{location}/recognizers/{recognizer}
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 RecognizerName)

public static bool TryParse(string recognizerName, out RecognizerName result)

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

Parameters
Name Description
recognizerName string

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

When this method returns, the parsed RecognizerName, 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}/recognizers/{recognizer}

TryParse(string, bool, out RecognizerName)

public static bool TryParse(string recognizerName, bool allowUnparsed, out RecognizerName result)

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

Parameters
Name Description
recognizerName 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 RecognizerName

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

Operators

operator ==(RecognizerName, RecognizerName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RecognizerName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RecognizerName

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

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.