Data Catalog v1 API - Class TaxonomyName (2.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

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

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
TaxonomyName.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 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
Int32
Overrides

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

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

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
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}/taxonomies/{taxonomy}

TryParse(String, Boolean, 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
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
TaxonomyName

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

Operators

Equality(TaxonomyName, TaxonomyName)

 public static bool operator ==(TaxonomyName a, TaxonomyName b)
Parameters
Name
Description
a
TaxonomyName
b
TaxonomyName
Returns
Type
Description
Boolean

Inequality(TaxonomyName, TaxonomyName)

 public static bool operator !=(TaxonomyName a, TaxonomyName b)
Parameters
Name
Description
a
TaxonomyName
b
TaxonomyName
Returns
Type
Description
Boolean