Cloud AI Platform v1 API - Class DataLabelingDatasetName (2.15.0)

Version 2.15.0

• 3.10.0 (latest)
• 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.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.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.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class DataLabelingDatasetName : IResourceName, IEquatable<DataLabelingDatasetName>

Reference documentation and code samples for the Cloud AI Platform v1 API class DataLabelingDatasetName.

Resource name for the DataLabelingDataset resource.

Inheritance

object > DataLabelingDatasetName

Implements

IResourceName, IEquatableDataLabelingDatasetName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

DataLabelingDatasetName(string, string)

public DataLabelingDatasetName(string projectId, string datasetId)

Constructs a new instance of a DataLabelingDatasetName class from the component parts of pattern projects/{project}/datasets/{dataset}

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
datasetId	string The Dataset ID. Must not be null or empty.

Properties

DatasetId

public string DatasetId { get; }

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

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

The DataLabelingDatasetName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DataLabelingDatasetNameResourceNameType

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)

public static string Format(string projectId, string datasetId)

Formats the IDs into the string representation of this DataLabelingDatasetName with pattern projects/{project}/datasets/{dataset}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
datasetId	string The Dataset ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DataLabelingDatasetName with pattern projects/{project}/datasets/{dataset}.

FormatProjectDataset(string, string)

public static string FormatProjectDataset(string projectId, string datasetId)

Formats the IDs into the string representation of this DataLabelingDatasetName with pattern projects/{project}/datasets/{dataset}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
datasetId	string The Dataset ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DataLabelingDatasetName with pattern projects/{project}/datasets/{dataset}.

FromProjectDataset(string, string)

public static DataLabelingDatasetName FromProjectDataset(string projectId, string datasetId)

Creates a DataLabelingDatasetName with the pattern projects/{project}/datasets/{dataset} .

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
datasetId	string The Dataset ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static DataLabelingDatasetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataLabelingDatasetName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
DataLabelingDatasetName	The parsed DataLabelingDatasetName if successful.

Remarks

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

• projects/{project}/datasets/{dataset}

Parse(string, bool)

public static DataLabelingDatasetName Parse(string dataLabelingDatasetName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/datasets/{dataset}

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

public static bool TryParse(string dataLabelingDatasetName, out DataLabelingDatasetName result)

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

Parameters
Name	Description
dataLabelingDatasetName	string The resource name in string form. Must not be null.
result	DataLabelingDatasetName When this method returns, the parsed DataLabelingDatasetName, 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}/datasets/{dataset}

TryParse(string, bool, out DataLabelingDatasetName)

public static bool TryParse(string dataLabelingDatasetName, bool allowUnparsed, out DataLabelingDatasetName result)

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

Parameters
Name	Description
dataLabelingDatasetName	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	DataLabelingDatasetName When this method returns, the parsed DataLabelingDatasetName, 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}/datasets/{dataset}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataLabelingDatasetName, DataLabelingDatasetName)

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

Parameters
Name	Description
a	DataLabelingDatasetName
b	DataLabelingDatasetName

Returns
Type	Description
bool

operator !=(DataLabelingDatasetName, DataLabelingDatasetName)

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

Parameters
Name	Description
a	DataLabelingDatasetName
b	DataLabelingDatasetName

Returns
Type	Description
bool