Google Cloud Translation v3 API - Class GlossaryName (3.1.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

Implements

IResourceName, IEquatable<GlossaryName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`GlossaryName.ResourceNameType`

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
`Int32`

Overrides

Object.GetHashCode()

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, Boolean)

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`	`Boolean` 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

Object.ToString()

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
`Boolean`	`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, Boolean, 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`	`Boolean` 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
`Boolean`	`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

Equality(GlossaryName, GlossaryName)

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

Parameters
Name	Description
`a`	`GlossaryName`
`b`	`GlossaryName`

Returns
Type	Description
`Boolean`

Inequality(GlossaryName, GlossaryName)

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

Parameters
Name	Description
`a`	`GlossaryName`
`b`	`GlossaryName`

Returns
Type	Description
`Boolean`