Cloud AI Platform v1 API - Class AutoMLDatasetName (3.0.0) 

public sealed class AutoMLDatasetName : IResourceName, IEquatable<AutoMLDatasetName>

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

Resource name for the AutoMLDataset resource.

Inheritance

object > AutoMLDatasetName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

AutoMLDatasetName(string, string, string)

public AutoMLDatasetName(string projectId, string locationId, string datasetId)

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

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

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

The AutoMLDatasetName.ResourceNameType of the contained resource name.

Property Value
Type Description
AutoMLDatasetNameResourceNameType

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

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

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

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

The string representation of this AutoMLDatasetName with pattern projects/{project}/locations/{location}/datasets/{dataset}.

FormatProjectLocationDataset(string, string, string)

public static string FormatProjectLocationDataset(string projectId, string locationId, string datasetId)

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

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

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

The string representation of this AutoMLDatasetName with pattern projects/{project}/locations/{location}/datasets/{dataset}.

FromProjectLocationDataset(string, string, string)

public static AutoMLDatasetName FromProjectLocationDataset(string projectId, string locationId, string datasetId)

Creates a AutoMLDatasetName with the pattern projects/{project}/locations/{location}/datasets/{dataset}.

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

The Dataset ID. Must not be null or empty.
Returns
Type Description
AutoMLDatasetName

A new instance of AutoMLDatasetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AutoMLDatasetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AutoMLDatasetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
autoMLDatasetName string

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

The parsed AutoMLDatasetName if successful.
Remarks

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

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

Parse(string, bool)

public static AutoMLDatasetName Parse(string autoMLDatasetName, bool allowUnparsed)

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

Parameters
Name Description
autoMLDatasetName 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
AutoMLDatasetName

The parsed AutoMLDatasetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/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

TryParse(string, out AutoMLDatasetName)

public static bool TryParse(string autoMLDatasetName, out AutoMLDatasetName result)

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

Parameters
Name Description
autoMLDatasetName string

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

When this method returns, the parsed AutoMLDatasetName, 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}/datasets/{dataset}

TryParse(string, bool, out AutoMLDatasetName)

public static bool TryParse(string autoMLDatasetName, bool allowUnparsed, out AutoMLDatasetName result)

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

Parameters
Name Description
autoMLDatasetName 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 AutoMLDatasetName

When this method returns, the parsed AutoMLDatasetName, 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}/datasets/{dataset}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AutoMLDatasetName, AutoMLDatasetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AutoMLDatasetName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AutoMLDatasetName

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

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.