Cloud Dataplex v1 API - Class DataProductName (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 DataProductName : IResourceName, IEquatable<DataProductName>

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

Resource name for the DataProduct resource.

Inheritance

object > DataProductName

Implements

IResourceName, IEquatableDataProductName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataProductName(string, string, string)

public DataProductName(string projectId, string locationId, string dataProductId)

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

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.

Properties

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 DataProductName.ResourceNameType Type { get; }

The DataProductName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DataProductNameResourceNameType

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

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

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.

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

FormatProjectLocationDataProduct(string, string, string)

public static string FormatProjectLocationDataProduct(string projectId, string locationId, string dataProductId)

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

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.

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

FromProjectLocationDataProduct(string, string, string)

public static DataProductName FromProjectLocationDataProduct(string projectId, string locationId, string dataProductId)

Creates a DataProductName with the pattern projects/{project}/locations/{location}/dataProducts/{data_product}.

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.

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

FromUnparsed(UnparsedResourceName)

public static DataProductName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataProductName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
DataProductName	The parsed DataProductName if successful.

Remarks

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

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

Parse(string, bool)

public static DataProductName Parse(string dataProductName, bool allowUnparsed)

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

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

Remarks

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

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

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

public static bool TryParse(string dataProductName, out DataProductName result)

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

Parameters
Name	Description
dataProductName	string The resource name in string form. Must not be null.
result	DataProductName When this method returns, the parsed DataProductName, 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}

TryParse(string, bool, out DataProductName)

public static bool TryParse(string dataProductName, bool allowUnparsed, out DataProductName result)

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

Parameters
Name	Description
dataProductName	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	DataProductName When this method returns, the parsed DataProductName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataProductName, DataProductName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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