Cloud AI Platform v1beta1 API - Class DatasetVersionName (1.0.0-beta12) 

public sealed class DatasetVersionName : IResourceName, IEquatable<DatasetVersionName>

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class DatasetVersionName.

Resource name for the DatasetVersion resource.

Inheritance

object > DatasetVersionName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

DatasetVersionName(string, string, string, string)

public DatasetVersionName(string projectId, string locationId, string datasetId, string datasetVersionId)

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

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

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

DatasetVersionId

public string DatasetVersionId { get; }

The DatasetVersion 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 DatasetVersionName.ResourceNameType Type { get; }

The DatasetVersionName.ResourceNameType of the contained resource name.

Property Value
Type Description
DatasetVersionNameResourceNameType

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, string)

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

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

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

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

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

FormatProjectLocationDatasetDatasetVersion(string, string, string, string)

public static string FormatProjectLocationDatasetDatasetVersion(string projectId, string locationId, string datasetId, string datasetVersionId)

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

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

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

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

FromProjectLocationDatasetDatasetVersion(string, string, string, string)

public static DatasetVersionName FromProjectLocationDatasetDatasetVersion(string projectId, string locationId, string datasetId, string datasetVersionId)

Creates a DatasetVersionName with the pattern projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}.

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

The DatasetVersion ID. Must not be null or empty.
Returns
Type Description
DatasetVersionName

A new instance of DatasetVersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DatasetVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DatasetVersionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
datasetVersionName string

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

The parsed DatasetVersionName if successful.
Remarks

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

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

Parse(string, bool)

public static DatasetVersionName Parse(string datasetVersionName, bool allowUnparsed)

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

Parameters
Name Description
datasetVersionName 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
DatasetVersionName

The parsed DatasetVersionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
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 DatasetVersionName)

public static bool TryParse(string datasetVersionName, out DatasetVersionName result)

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

Parameters
Name Description
datasetVersionName string

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

When this method returns, the parsed DatasetVersionName, 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}/datasetVersions/{dataset_version}

TryParse(string, bool, out DatasetVersionName)

public static bool TryParse(string datasetVersionName, bool allowUnparsed, out DatasetVersionName result)

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

Parameters
Name Description
datasetVersionName 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 DatasetVersionName

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

Operators

operator ==(DatasetVersionName, DatasetVersionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DatasetVersionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DatasetVersionName

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

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.