Cloud Dataplex v1 API - Class DataAssetName (3.13.0)

3.13.0 (latest) 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.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.0.0

public sealed class DataAssetName : IResourceName, IEquatable<DataAssetName>

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

Resource name for the DataAsset resource.

Inheritance

object > DataAssetName

Implements

IResourceName, IEquatableDataAssetName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataAssetName(string, string, string, string)

public DataAssetName(string projectId, string locationId, string dataProductId, string dataAssetId)

Constructs a new instance of a DataAssetName class from the component parts of pattern projects/{project}/locations/{location}/dataProducts/{data_product}/dataAssets/{data_asset}

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.
dataProductId	string The DataProduct ID. Must not be null or empty.
dataAssetId	string The DataAsset ID. Must not be null or empty.

Properties

DataAssetId

public string DataAssetId { get; }

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

Property Value
Type	Description
string

DataProductId

public string DataProductId { get; }

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

The DataAssetName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DataAssetNameResourceNameType

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 dataProductId, string dataAssetId)

Formats the IDs into the string representation of this DataAssetName with pattern projects/{project}/locations/{location}/dataProducts/{data_product}/dataAssets/{data_asset}.

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.
dataProductId	string The DataProduct ID. Must not be null or empty.
dataAssetId	string The DataAsset ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DataAssetName with pattern projects/{project}/locations/{location}/dataProducts/{data_product}/dataAssets/{data_asset}.

FormatProjectLocationDataProductDataAsset(string, string, string, string)

public static string FormatProjectLocationDataProductDataAsset(string projectId, string locationId, string dataProductId, string dataAssetId)

Formats the IDs into the string representation of this DataAssetName with pattern projects/{project}/locations/{location}/dataProducts/{data_product}/dataAssets/{data_asset}.

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.
dataProductId	string The DataProduct ID. Must not be null or empty.
dataAssetId	string The DataAsset ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DataAssetName with pattern projects/{project}/locations/{location}/dataProducts/{data_product}/dataAssets/{data_asset}.

FromProjectLocationDataProductDataAsset(string, string, string, string)

public static DataAssetName FromProjectLocationDataProductDataAsset(string projectId, string locationId, string dataProductId, string dataAssetId)

Creates a DataAssetName with the pattern projects/{project}/locations/{location}/dataProducts/{data_product}/dataAssets/{data_asset}.

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.
dataProductId	string The DataProduct ID. Must not be null or empty.
dataAssetId	string The DataAsset ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static DataAssetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataAssetName containing an unparsed resource name.

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

Returns
Type	Description
DataAssetName	A new instance of DataAssetName 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 DataAssetName Parse(string dataAssetName)

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

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

Returns
Type	Description
DataAssetName	The parsed DataAssetName if successful.

Remarks

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

• projects/{project}/locations/{location}/dataProducts/{data_product}/dataAssets/{data_asset}

Parse(string, bool)

public static DataAssetName Parse(string dataAssetName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/dataProducts/{data_product}/dataAssets/{data_asset}

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

public static bool TryParse(string dataAssetName, out DataAssetName result)

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

Parameters
Name	Description
dataAssetName	string The resource name in string form. Must not be null.
result	DataAssetName When this method returns, the parsed DataAssetName, 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}/dataProducts/{data_product}/dataAssets/{data_asset}

TryParse(string, bool, out DataAssetName)

public static bool TryParse(string dataAssetName, bool allowUnparsed, out DataAssetName result)

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

Parameters
Name	Description
dataAssetName	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	DataAssetName When this method returns, the parsed DataAssetName, 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}/dataProducts/{data_product}/dataAssets/{data_asset}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataAssetName, DataAssetName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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