Data Catalog v1 API - Class TaxonomyName (2.17.0)

Version latest

• 2.17.0 (latest)
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0

public sealed class TaxonomyName : IResourceName, IEquatable<TaxonomyName>

Reference documentation and code samples for the Data Catalog v1 API class TaxonomyName.

Resource name for the Taxonomy resource.

Inheritance

object > TaxonomyName

Implements

IResourceName, IEquatableTaxonomyName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

TaxonomyName(string, string, string)

public TaxonomyName(string projectId, string locationId, string taxonomyId)

Constructs a new instance of a TaxonomyName class from the component parts of pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}

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.
taxonomyId	string The Taxonomy 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

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

TaxonomyId

public string TaxonomyId { get; }

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

Property Value
Type	Description
string

Type

public TaxonomyName.ResourceNameType Type { get; }

The TaxonomyName.ResourceNameType of the contained resource name.

Property Value
Type	Description
TaxonomyNameResourceNameType

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

Formats the IDs into the string representation of this TaxonomyName with pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}.

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.
taxonomyId	string The Taxonomy ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this TaxonomyName with pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}.

FormatProjectLocationTaxonomy(string, string, string)

public static string FormatProjectLocationTaxonomy(string projectId, string locationId, string taxonomyId)

Formats the IDs into the string representation of this TaxonomyName with pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}.

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.
taxonomyId	string The Taxonomy ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this TaxonomyName with pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}.

FromProjectLocationTaxonomy(string, string, string)

public static TaxonomyName FromProjectLocationTaxonomy(string projectId, string locationId, string taxonomyId)

Creates a TaxonomyName with the pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}.

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.
taxonomyId	string The Taxonomy ID. Must not be null or empty.

Returns
Type	Description
TaxonomyName	A new instance of TaxonomyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TaxonomyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TaxonomyName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
TaxonomyName	A new instance of TaxonomyName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static TaxonomyName Parse(string taxonomyName)

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

Parameter
Name	Description
taxonomyName	string The resource name in string form. Must not be null.

Returns
Type	Description
TaxonomyName	The parsed TaxonomyName if successful.

Remarks

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

• projects/{project}/locations/{location}/taxonomies/{taxonomy}

Parse(string, bool)

public static TaxonomyName Parse(string taxonomyName, bool allowUnparsed)

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

Parameters
Name	Description
taxonomyName	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
TaxonomyName	The parsed TaxonomyName if successful.

Remarks

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

• projects/{project}/locations/{location}/taxonomies/{taxonomy}

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

public static bool TryParse(string taxonomyName, out TaxonomyName result)

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

Parameters
Name	Description
taxonomyName	string The resource name in string form. Must not be null.
result	TaxonomyName When this method returns, the parsed TaxonomyName, 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}/taxonomies/{taxonomy}

TryParse(string, bool, out TaxonomyName)

public static bool TryParse(string taxonomyName, bool allowUnparsed, out TaxonomyName result)

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

Parameters
Name	Description
taxonomyName	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	TaxonomyName When this method returns, the parsed TaxonomyName, 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}/taxonomies/{taxonomy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TaxonomyName, TaxonomyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	TaxonomyName The first resource name to compare, or null.
b	TaxonomyName 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 !=(TaxonomyName, TaxonomyName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	TaxonomyName The first resource name to compare, or null.
b	TaxonomyName 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.