Cloud AI Platform v1 API - Class AutoMLDatasetName (2.10.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

GoogleCloudGoogle.Cloud.AIPlatformV1

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

The Project ID. Must not be null or empty.

locationIdstring

The Location 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
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

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

The AutoMLDatasetName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AutoMLDatasetNameResourceNameType

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, 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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location 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 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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location 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 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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

datasetIdstring

The Dataset ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
AutoMLDatasetName

A new instance of AutoMLDatasetName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static AutoMLDatasetName Parse(string autoMLDatasetName)

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

Parameter
NameDescription
autoMLDatasetNamestring

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

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

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

allowUnparsedbool

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
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
TypeDescription
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
NameDescription
autoMLDatasetNamestring

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

resultAutoMLDatasetName

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

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

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

allowUnparsedbool

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.

resultAutoMLDatasetName

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

Returns
TypeDescription
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)
Parameters
NameDescription
aAutoMLDatasetName
bAutoMLDatasetName
Returns
TypeDescription
bool

operator !=(AutoMLDatasetName, AutoMLDatasetName)

public static bool operator !=(AutoMLDatasetName a, AutoMLDatasetName b)
Parameters
NameDescription
aAutoMLDatasetName
bAutoMLDatasetName
Returns
TypeDescription
bool