Cloud AI Platform v1 API - Class AnnotatedDatasetName (2.27.0) 

public sealed class AnnotatedDatasetName : IResourceName, IEquatable<AnnotatedDatasetName>

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

Resource name for the AnnotatedDataset resource.

Inheritance

object > AnnotatedDatasetName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

AnnotatedDatasetName(string, string, string)

public AnnotatedDatasetName(string projectId, string datasetId, string annotatedDatasetId)

Constructs a new instance of a AnnotatedDatasetName class from the component parts of pattern projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
annotatedDatasetId string

The AnnotatedDataset ID. Must not be null or empty.

Properties

AnnotatedDatasetId

public string AnnotatedDatasetId { get; }

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

Property Value
Type Description
string

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

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

The AnnotatedDatasetName.ResourceNameType of the contained resource name.

Property Value
Type Description
AnnotatedDatasetNameResourceNameType

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

Formats the IDs into the string representation of this AnnotatedDatasetName with pattern projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
annotatedDatasetId string

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

The string representation of this AnnotatedDatasetName with pattern projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}.

FormatProjectDatasetAnnotatedDataset(string, string, string)

public static string FormatProjectDatasetAnnotatedDataset(string projectId, string datasetId, string annotatedDatasetId)

Formats the IDs into the string representation of this AnnotatedDatasetName with pattern projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
annotatedDatasetId string

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

The string representation of this AnnotatedDatasetName with pattern projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}.

FromProjectDatasetAnnotatedDataset(string, string, string)

public static AnnotatedDatasetName FromProjectDatasetAnnotatedDataset(string projectId, string datasetId, string annotatedDatasetId)

Creates a AnnotatedDatasetName with the pattern projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
annotatedDatasetId string

The AnnotatedDataset ID. Must not be null or empty.
Returns
Type Description
AnnotatedDatasetName

A new instance of AnnotatedDatasetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AnnotatedDatasetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AnnotatedDatasetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
annotatedDatasetName string

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

The parsed AnnotatedDatasetName if successful.
Remarks

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

  • projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}

Parse(string, bool)

public static AnnotatedDatasetName Parse(string annotatedDatasetName, bool allowUnparsed)

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

Parameters
Name Description
annotatedDatasetName 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
AnnotatedDatasetName

The parsed AnnotatedDatasetName if successful.
Remarks

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

  • projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_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 AnnotatedDatasetName)

public static bool TryParse(string annotatedDatasetName, out AnnotatedDatasetName result)

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

Parameters
Name Description
annotatedDatasetName string

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

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

TryParse(string, bool, out AnnotatedDatasetName)

public static bool TryParse(string annotatedDatasetName, bool allowUnparsed, out AnnotatedDatasetName result)

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

Parameters
Name Description
annotatedDatasetName 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 AnnotatedDatasetName

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

Operators

operator ==(AnnotatedDatasetName, AnnotatedDatasetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AnnotatedDatasetName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AnnotatedDatasetName

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

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.