Google Cloud Speech v1p1beta1 API - Class PhraseSetName (3.0.0-beta07) 

public sealed class PhraseSetName : IResourceName, IEquatable<PhraseSetName>

Reference documentation and code samples for the Google Cloud Speech v1p1beta1 API class PhraseSetName.

Resource name for the PhraseSet resource.

Inheritance

object > PhraseSetName

Namespace

Google.Cloud.Speech.V1P1Beta1

Assembly

Google.Cloud.Speech.V1P1Beta1.dll

Constructors

PhraseSetName(string, string, string)

public PhraseSetName(string projectId, string locationId, string phraseSetId)

Constructs a new instance of a PhraseSetName class from the component parts of pattern projects/{project}/locations/{location}/phraseSets/{phrase_set}

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

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

PhraseSetId

public string PhraseSetId { get; }

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

Type

public PhraseSetName.ResourceNameType Type { get; }

The PhraseSetName.ResourceNameType of the contained resource name.

Property Value
Type Description
PhraseSetNameResourceNameType

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

Formats the IDs into the string representation of this PhraseSetName with pattern projects/{project}/locations/{location}/phraseSets/{phrase_set}.

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

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

The string representation of this PhraseSetName with pattern projects/{project}/locations/{location}/phraseSets/{phrase_set}.

FormatProjectLocationPhraseSet(string, string, string)

public static string FormatProjectLocationPhraseSet(string projectId, string locationId, string phraseSetId)

Formats the IDs into the string representation of this PhraseSetName with pattern projects/{project}/locations/{location}/phraseSets/{phrase_set}.

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

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

The string representation of this PhraseSetName with pattern projects/{project}/locations/{location}/phraseSets/{phrase_set}.

FromProjectLocationPhraseSet(string, string, string)

public static PhraseSetName FromProjectLocationPhraseSet(string projectId, string locationId, string phraseSetId)

Creates a PhraseSetName with the pattern projects/{project}/locations/{location}/phraseSets/{phrase_set}.

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

The PhraseSet ID. Must not be null or empty.
Returns
Type Description
PhraseSetName

A new instance of PhraseSetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PhraseSetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PhraseSetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
phraseSetName string

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

The parsed PhraseSetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/phraseSets/{phrase_set}

Parse(string, bool)

public static PhraseSetName Parse(string phraseSetName, bool allowUnparsed)

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

Parameters
Name Description
phraseSetName 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
PhraseSetName

The parsed PhraseSetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/phraseSets/{phrase_set}
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 PhraseSetName)

public static bool TryParse(string phraseSetName, out PhraseSetName result)

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

Parameters
Name Description
phraseSetName string

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

When this method returns, the parsed PhraseSetName, 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}/phraseSets/{phrase_set}

TryParse(string, bool, out PhraseSetName)

public static bool TryParse(string phraseSetName, bool allowUnparsed, out PhraseSetName result)

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

Parameters
Name Description
phraseSetName 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 PhraseSetName

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

Operators

operator ==(PhraseSetName, PhraseSetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PhraseSetName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PhraseSetName

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

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.