Cloud Dataplex v1 API - Class DataAttributeName (3.0.0) 

public sealed class DataAttributeName : IResourceName, IEquatable<DataAttributeName>

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

Resource name for the DataAttribute resource.

Inheritance

object > DataAttributeName

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataAttributeName(string, string, string, string)

public DataAttributeName(string projectId, string locationId, string dataTaxonomyId, string dataAttributeId)

Constructs a new instance of a DataAttributeName class from the component parts of pattern projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}

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

The DataTaxonomy ID. Must not be null or empty.
dataAttributeId string

The DataAttribute ID. Must not be null or empty.

Properties

DataAttributeId

public string DataAttributeId { get; }

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

Property Value
Type Description
string

DataTaxonomyId

public string DataTaxonomyId { get; }

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

The DataAttributeName.ResourceNameType of the contained resource name.

Property Value
Type Description
DataAttributeNameResourceNameType

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

Formats the IDs into the string representation of this DataAttributeName with pattern projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.

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

The DataTaxonomy ID. Must not be null or empty.
dataAttributeId string

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

The string representation of this DataAttributeName with pattern projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.

FormatProjectLocationDataTaxonomyDataAttribute(string, string, string, string)

public static string FormatProjectLocationDataTaxonomyDataAttribute(string projectId, string locationId, string dataTaxonomyId, string dataAttributeId)

Formats the IDs into the string representation of this DataAttributeName with pattern projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.

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

The DataTaxonomy ID. Must not be null or empty.
dataAttributeId string

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

The string representation of this DataAttributeName with pattern projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.

FromProjectLocationDataTaxonomyDataAttribute(string, string, string, string)

public static DataAttributeName FromProjectLocationDataTaxonomyDataAttribute(string projectId, string locationId, string dataTaxonomyId, string dataAttributeId)

Creates a DataAttributeName with the pattern projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.

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

The DataTaxonomy ID. Must not be null or empty.
dataAttributeId string

The DataAttribute ID. Must not be null or empty.
Returns
Type Description
DataAttributeName

A new instance of DataAttributeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataAttributeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataAttributeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
dataAttributeName string

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

The parsed DataAttributeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}

Parse(string, bool)

public static DataAttributeName Parse(string dataAttributeName, bool allowUnparsed)

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

Parameters
Name Description
dataAttributeName 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
DataAttributeName

The parsed DataAttributeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
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 DataAttributeName)

public static bool TryParse(string dataAttributeName, out DataAttributeName result)

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

Parameters
Name Description
dataAttributeName string

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

When this method returns, the parsed DataAttributeName, 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}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}

TryParse(string, bool, out DataAttributeName)

public static bool TryParse(string dataAttributeName, bool allowUnparsed, out DataAttributeName result)

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

Parameters
Name Description
dataAttributeName 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 DataAttributeName

When this method returns, the parsed DataAttributeName, 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}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataAttributeName, DataAttributeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DataAttributeName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DataAttributeName

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

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.