Google Cloud Translation v3 API - Class GlossaryName (3.6.0)

public sealed class GlossaryName : IResourceName, IEquatable<GlossaryName>

Reference documentation and code samples for the Google Cloud Translation v3 API class GlossaryName.

Resource name for the Glossary resource.

Inheritance

object > GlossaryName

Namespace

Google.Cloud.Translate.V3

Assembly

Google.Cloud.Translate.V3.dll

Constructors

GlossaryName(string, string, string)

public GlossaryName(string projectId, string locationId, string glossaryId)

Constructs a new instance of a GlossaryName class from the component parts of pattern projects/{project}/locations/{location}/glossaries/{glossary}

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.

glossaryId string

The Glossary ID. Must not be null or empty.

Properties

GlossaryId

public string GlossaryId { get; }

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

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 GlossaryName.ResourceNameType Type { get; }

The GlossaryName.ResourceNameType of the contained resource name.

Property Value
Type Description
GlossaryNameResourceNameType

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

Formats the IDs into the string representation of this GlossaryName with pattern projects/{project}/locations/{location}/glossaries/{glossary}.

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.

glossaryId string

The Glossary ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this GlossaryName with pattern projects/{project}/locations/{location}/glossaries/{glossary}.

FormatProjectLocationGlossary(string, string, string)

public static string FormatProjectLocationGlossary(string projectId, string locationId, string glossaryId)

Formats the IDs into the string representation of this GlossaryName with pattern projects/{project}/locations/{location}/glossaries/{glossary}.

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.

glossaryId string

The Glossary ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this GlossaryName with pattern projects/{project}/locations/{location}/glossaries/{glossary}.

FromProjectLocationGlossary(string, string, string)

public static GlossaryName FromProjectLocationGlossary(string projectId, string locationId, string glossaryId)

Creates a GlossaryName with the pattern projects/{project}/locations/{location}/glossaries/{glossary}.

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.

glossaryId string

The Glossary ID. Must not be null or empty.

Returns
Type Description
GlossaryName

A new instance of GlossaryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GlossaryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GlossaryName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
GlossaryName

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

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

Parameter
Name Description
glossaryName string

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

Returns
Type Description
GlossaryName

The parsed GlossaryName if successful.

Remarks

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

  • projects/{project}/locations/{location}/glossaries/{glossary}

Parse(string, bool)

public static GlossaryName Parse(string glossaryName, bool allowUnparsed)

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

Parameters
Name Description
glossaryName 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
GlossaryName

The parsed GlossaryName if successful.

Remarks

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

  • projects/{project}/locations/{location}/glossaries/{glossary}
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 GlossaryName)

public static bool TryParse(string glossaryName, out GlossaryName result)

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

Parameters
Name Description
glossaryName string

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

result GlossaryName

When this method returns, the parsed GlossaryName, 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}/glossaries/{glossary}

TryParse(string, bool, out GlossaryName)

public static bool TryParse(string glossaryName, bool allowUnparsed, out GlossaryName result)

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

Parameters
Name Description
glossaryName 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 GlossaryName

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

Operators

operator ==(GlossaryName, GlossaryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GlossaryName

The first resource name to compare, or null.

b GlossaryName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GlossaryName

The first resource name to compare, or null.

b GlossaryName

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.