Class DatasetName (1.1.0)

public sealed class DatasetName : IResourceName, IEquatable<DatasetName>

Resource name for the Dataset resource.

Inheritance

Object > DatasetName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

DatasetName(String, String, String)

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

Constructs a new instance of a DatasetName 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
Boolean

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

The DatasetName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DatasetName.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, String)

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

Formats the IDs into the string representation of this DatasetName 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 DatasetName 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 DatasetName 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 DatasetName with pattern projects/{project}/locations/{location}/datasets/{dataset}.

FromProjectLocationDataset(String, String, String)

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

Creates a DatasetName 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
DatasetName

A new instance of DatasetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DatasetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DatasetName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DatasetName

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

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

Parameter
NameDescription
datasetNameString

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

Returns
TypeDescription
DatasetName

The parsed DatasetName 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, Boolean)

public static DatasetName Parse(string datasetName, bool allowUnparsed)

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

Parameters
NameDescription
datasetNameString

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
DatasetName

The parsed DatasetName 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 DatasetName)

public static bool TryParse(string datasetName, out DatasetName result)

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

Parameters
NameDescription
datasetNameString

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

resultDatasetName

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

TryParse(String, Boolean, out DatasetName)

public static bool TryParse(string datasetName, bool allowUnparsed, out DatasetName result)

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

Parameters
NameDescription
datasetNameString

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.

resultDatasetName

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

Operators

Equality(DatasetName, DatasetName)

public static bool operator ==(DatasetName a, DatasetName b)
Parameters
NameDescription
aDatasetName
bDatasetName
Returns
TypeDescription
Boolean

Inequality(DatasetName, DatasetName)

public static bool operator !=(DatasetName a, DatasetName b)
Parameters
NameDescription
aDatasetName
bDatasetName
Returns
TypeDescription
Boolean