Class Annotation

public sealed class Annotation : IMessage<Annotation>, IEquatable<Annotation>, IDeepCloneable<Annotation>, IBufferMessage, IMessage

Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.

Inheritance

Object > Annotation

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

Annotation()

public Annotation()

Annotation(Annotation)

public Annotation(Annotation other)
Parameter
NameDescription
otherAnnotation

Properties

AnnotationName

public AnnotationName AnnotationName { get; set; }

AnnotationName-typed view over the Name resource name property.

Property Value
TypeDescription
AnnotationName

AnnotationSource

public UserActionReference AnnotationSource { get; set; }

Output only. The source of the Annotation.

Property Value
TypeDescription
UserActionReference

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when this Annotation was created.

Property Value
TypeDescription
Timestamp

Etag

public string Etag { get; set; }

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Property Value
TypeDescription
String

Labels

public MapField<string, string> Labels { get; }

Optional. The labels with user-defined metadata to organize your Annotations.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Annotation(System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Annotation:

  • "aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.

  • "aiplatform.googleapis.com/payload_schema": output only, its value is the [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri] title.

Property Value
TypeDescription
MapField<String, String>

Name

public string Name { get; set; }

Output only. Resource name of the Annotation.

Property Value
TypeDescription
String

Payload

public Value Payload { get; set; }

Required. The schema of the payload can be found in [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].

Property Value
TypeDescription
Value

PayloadSchemaUri

public string PayloadSchemaUri { get; set; }

Required. Google Cloud Storage URI points to a YAML file describing [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with the parent Dataset's [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri].

Property Value
TypeDescription
String

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp when this Annotation was last updated.

Property Value
TypeDescription
Timestamp