Cloud Dataplex v1 API - Class GlossaryCategoryName (3.12.0) 

public sealed class GlossaryCategoryName : IResourceName, IEquatable<GlossaryCategoryName>

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

Resource name for the GlossaryCategory resource.

Inheritance

object > GlossaryCategoryName

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

GlossaryCategoryName(string, string, string, string)

public GlossaryCategoryName(string projectId, string locationId, string glossaryId, string glossaryCategoryId)

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

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

The GlossaryCategory ID. Must not be null or empty.

Properties

GlossaryCategoryId

public string GlossaryCategoryId { get; }

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

Property Value
Type Description
string

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

The GlossaryCategoryName.ResourceNameType of the contained resource name.

Property Value
Type Description
GlossaryCategoryNameResourceNameType

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

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

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

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

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

FormatProjectLocationGlossaryGlossaryCategory(string, string, string, string)

public static string FormatProjectLocationGlossaryGlossaryCategory(string projectId, string locationId, string glossaryId, string glossaryCategoryId)

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

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

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

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

FromProjectLocationGlossaryGlossaryCategory(string, string, string, string)

public static GlossaryCategoryName FromProjectLocationGlossaryGlossaryCategory(string projectId, string locationId, string glossaryId, string glossaryCategoryId)

Creates a GlossaryCategoryName with the pattern projects/{project}/locations/{location}/glossaries/{glossary}/categories/{glossary_category}.

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

The GlossaryCategory ID. Must not be null or empty.
Returns
Type Description
GlossaryCategoryName

A new instance of GlossaryCategoryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GlossaryCategoryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GlossaryCategoryName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
glossaryCategoryName string

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

The parsed GlossaryCategoryName if successful.
Remarks

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

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

Parse(string, bool)

public static GlossaryCategoryName Parse(string glossaryCategoryName, bool allowUnparsed)

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

Parameters
Name Description
glossaryCategoryName 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
GlossaryCategoryName

The parsed GlossaryCategoryName if successful.
Remarks

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

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

public static bool TryParse(string glossaryCategoryName, out GlossaryCategoryName result)

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

Parameters
Name Description
glossaryCategoryName string

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

When this method returns, the parsed GlossaryCategoryName, 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}/categories/{glossary_category}

TryParse(string, bool, out GlossaryCategoryName)

public static bool TryParse(string glossaryCategoryName, bool allowUnparsed, out GlossaryCategoryName result)

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

Parameters
Name Description
glossaryCategoryName 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 GlossaryCategoryName

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

Operators

operator ==(GlossaryCategoryName, GlossaryCategoryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GlossaryCategoryName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GlossaryCategoryName

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

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.