Cloud AI Platform v1 API - Class AnnotationName (3.11.0) 

public sealed class AnnotationName : IResourceName, IEquatable<AnnotationName>

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

Resource name for the Annotation resource.

Inheritance

object > AnnotationName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

AnnotationName(string, string, string, string, string)

public AnnotationName(string projectId, string locationId, string datasetId, string dataItemId, string annotationId)

Constructs a new instance of a AnnotationName class from the component parts of pattern projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}

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

The DataItem ID. Must not be null or empty.
annotationId string

The Annotation ID. Must not be null or empty.

Properties

AnnotationId

public string AnnotationId { get; }

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

Property Value
Type Description
string

DataItemId

public string DataItemId { get; }

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

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

The AnnotationName.ResourceNameType of the contained resource name.

Property Value
Type Description
AnnotationNameResourceNameType

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

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

Formats the IDs into the string representation of this AnnotationName with pattern projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation} .

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

The DataItem ID. Must not be null or empty.
annotationId string

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

The string representation of this AnnotationName with pattern projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation} .

FormatProjectLocationDatasetDataItemAnnotation(string, string, string, string, string)

public static string FormatProjectLocationDatasetDataItemAnnotation(string projectId, string locationId, string datasetId, string dataItemId, string annotationId)

Formats the IDs into the string representation of this AnnotationName with pattern projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation} .

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

The DataItem ID. Must not be null or empty.
annotationId string

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

The string representation of this AnnotationName with pattern projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation} .

FromProjectLocationDatasetDataItemAnnotation(string, string, string, string, string)

public static AnnotationName FromProjectLocationDatasetDataItemAnnotation(string projectId, string locationId, string datasetId, string dataItemId, string annotationId)

Creates a AnnotationName with the pattern projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation} .

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

The DataItem ID. Must not be null or empty.
annotationId string

The Annotation ID. Must not be null or empty.
Returns
Type Description
AnnotationName

A new instance of AnnotationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AnnotationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AnnotationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
annotationName string

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

The parsed AnnotationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}

Parse(string, bool)

public static AnnotationName Parse(string annotationName, bool allowUnparsed)

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

Parameters
Name Description
annotationName 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
AnnotationName

The parsed AnnotationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}
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 AnnotationName)

public static bool TryParse(string annotationName, out AnnotationName result)

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

Parameters
Name Description
annotationName string

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

When this method returns, the parsed AnnotationName, 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}/dataItems/{data_item}/annotations/{annotation}

TryParse(string, bool, out AnnotationName)

public static bool TryParse(string annotationName, bool allowUnparsed, out AnnotationName result)

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

Parameters
Name Description
annotationName 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 AnnotationName

When this method returns, the parsed AnnotationName, 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}/dataItems/{data_item}/annotations/{annotation}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AnnotationName, AnnotationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AnnotationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AnnotationName

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

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.