Cloud Dataplex v1 API - Class GlossaryTermName (3.10.0) 

public sealed class GlossaryTermName : IResourceName, IEquatable<GlossaryTermName>

Reference documentation and code samples for the Cloud Dataplex v1 API class GlossaryTermName.

Resource name for the GlossaryTerm resource.

Inheritance

object > GlossaryTermName

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

GlossaryTermName(string, string, string, string)

public GlossaryTermName(string projectId, string locationId, string glossaryId, string glossaryTermId)

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

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

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

GlossaryTermId

public string GlossaryTermId { get; }

The GlossaryTerm 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 GlossaryTermName.ResourceNameType Type { get; }

The GlossaryTermName.ResourceNameType of the contained resource name.

Property Value
Type Description
GlossaryTermNameResourceNameType

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

public static string Format(string projectId, string locationId, string glossaryId, string glossaryTermId)

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

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

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

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

FormatProjectLocationGlossaryGlossaryTerm(string, string, string, string)

public static string FormatProjectLocationGlossaryGlossaryTerm(string projectId, string locationId, string glossaryId, string glossaryTermId)

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

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

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

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

FromProjectLocationGlossaryGlossaryTerm(string, string, string, string)

public static GlossaryTermName FromProjectLocationGlossaryGlossaryTerm(string projectId, string locationId, string glossaryId, string glossaryTermId)

Creates a GlossaryTermName with the pattern projects/{project}/locations/{location}/glossaries/{glossary}/terms/{glossary_term}.

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

The GlossaryTerm ID. Must not be null or empty.
Returns
Type Description
GlossaryTermName

A new instance of GlossaryTermName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GlossaryTermName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GlossaryTermName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
glossaryTermName string

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

The parsed GlossaryTermName if successful.
Remarks

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

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

Parse(string, bool)

public static GlossaryTermName Parse(string glossaryTermName, bool allowUnparsed)

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

Parameters
Name Description
glossaryTermName 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
GlossaryTermName

The parsed GlossaryTermName if successful.
Remarks

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

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

public static bool TryParse(string glossaryTermName, out GlossaryTermName result)

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

Parameters
Name Description
glossaryTermName string

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

When this method returns, the parsed GlossaryTermName, 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}/terms/{glossary_term}

TryParse(string, bool, out GlossaryTermName)

public static bool TryParse(string glossaryTermName, bool allowUnparsed, out GlossaryTermName result)

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

Parameters
Name Description
glossaryTermName 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 GlossaryTermName

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

Operators

operator ==(GlossaryTermName, GlossaryTermName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GlossaryTermName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GlossaryTermName

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

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.