Class DataLabelingDatasetName

public sealed class DataLabelingDatasetName : IResourceName, IEquatable<DataLabelingDatasetName>

Resource name for the DataLabelingDataset resource.

Inheritance

Object > DataLabelingDatasetName

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

datasetIdString

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

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

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

The DataLabelingDatasetName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DataLabelingDatasetName.ResourceNameType

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)

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

datasetIdString

The Dataset ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

datasetIdString

The Dataset ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

datasetIdString

The Dataset ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DataLabelingDatasetName

A new instance of DataLabelingDatasetName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static DataLabelingDatasetName Parse(string dataLabelingDatasetName)

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

Parameter
NameDescription
dataLabelingDatasetNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
dataLabelingDatasetNameString

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

allowUnparsedBoolean

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

The string representation of the resource name.

Overrides

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
NameDescription
dataLabelingDatasetNameString

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

resultDataLabelingDatasetName

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

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
dataLabelingDatasetNameString

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

allowUnparsedBoolean

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.

resultDataLabelingDatasetName

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

Returns
TypeDescription
Boolean

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

Equality(DataLabelingDatasetName, DataLabelingDatasetName)

public static bool operator ==(DataLabelingDatasetName a, DataLabelingDatasetName b)
Parameters
NameDescription
aDataLabelingDatasetName
bDataLabelingDatasetName
Returns
TypeDescription
Boolean

Inequality(DataLabelingDatasetName, DataLabelingDatasetName)

public static bool operator !=(DataLabelingDatasetName a, DataLabelingDatasetName b)
Parameters
NameDescription
aDataLabelingDatasetName
bDataLabelingDatasetName
Returns
TypeDescription
Boolean