Cloud Dataplex v1 API - Class DataTaxonomyName (2.14.0)

public sealed class DataTaxonomyName : IResourceName, IEquatable<DataTaxonomyName>

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

Resource name for the DataTaxonomy resource.

Inheritance

object > DataTaxonomyName

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataTaxonomyName(string, string, string)

public DataTaxonomyName(string projectId, string locationId, string dataTaxonomyId)

Constructs a new instance of a DataTaxonomyName class from the component parts of pattern projects/{project}/locations/{location}/dataTaxonomies/{data_taxonomy_id}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

dataTaxonomyIdstring

The DataTaxonomy ID. Must not be null or empty.

Properties

DataTaxonomyId

public string DataTaxonomyId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public DataTaxonomyName.ResourceNameType Type { get; }

The DataTaxonomyName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DataTaxonomyNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string dataTaxonomyId)

Formats the IDs into the string representation of this DataTaxonomyName with pattern projects/{project}/locations/{location}/dataTaxonomies/{data_taxonomy_id}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

dataTaxonomyIdstring

The DataTaxonomy ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this DataTaxonomyName with pattern projects/{project}/locations/{location}/dataTaxonomies/{data_taxonomy_id}.

FormatProjectLocationDataTaxonomy(string, string, string)

public static string FormatProjectLocationDataTaxonomy(string projectId, string locationId, string dataTaxonomyId)

Formats the IDs into the string representation of this DataTaxonomyName with pattern projects/{project}/locations/{location}/dataTaxonomies/{data_taxonomy_id}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

dataTaxonomyIdstring

The DataTaxonomy ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this DataTaxonomyName with pattern projects/{project}/locations/{location}/dataTaxonomies/{data_taxonomy_id}.

FromProjectLocationDataTaxonomy(string, string, string)

public static DataTaxonomyName FromProjectLocationDataTaxonomy(string projectId, string locationId, string dataTaxonomyId)

Creates a DataTaxonomyName with the pattern projects/{project}/locations/{location}/dataTaxonomies/{data_taxonomy_id}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

dataTaxonomyIdstring

The DataTaxonomy ID. Must not be null or empty.

Returns
TypeDescription
DataTaxonomyName

A new instance of DataTaxonomyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataTaxonomyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataTaxonomyName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DataTaxonomyName

A new instance of DataTaxonomyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static DataTaxonomyName Parse(string dataTaxonomyName)

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

Parameter
NameDescription
dataTaxonomyNamestring

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

Returns
TypeDescription
DataTaxonomyName

The parsed DataTaxonomyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/dataTaxonomies/{data_taxonomy_id}

Parse(string, bool)

public static DataTaxonomyName Parse(string dataTaxonomyName, bool allowUnparsed)

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

Parameters
NameDescription
dataTaxonomyNamestring

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

allowUnparsedbool

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

The parsed DataTaxonomyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/dataTaxonomies/{data_taxonomy_id}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out DataTaxonomyName)

public static bool TryParse(string dataTaxonomyName, out DataTaxonomyName result)

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

Parameters
NameDescription
dataTaxonomyNamestring

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

resultDataTaxonomyName

When this method returns, the parsed DataTaxonomyName, or null if parsing failed.

Returns
TypeDescription
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}/dataTaxonomies/{data_taxonomy_id}

TryParse(string, bool, out DataTaxonomyName)

public static bool TryParse(string dataTaxonomyName, bool allowUnparsed, out DataTaxonomyName result)

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

Parameters
NameDescription
dataTaxonomyNamestring

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

allowUnparsedbool

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.

resultDataTaxonomyName

When this method returns, the parsed DataTaxonomyName, or null if parsing failed.

Returns
TypeDescription
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}/dataTaxonomies/{data_taxonomy_id}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataTaxonomyName, DataTaxonomyName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aDataTaxonomyName

The first resource name to compare, or null.

bDataTaxonomyName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(DataTaxonomyName, DataTaxonomyName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aDataTaxonomyName

The first resource name to compare, or null.

bDataTaxonomyName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.