Class Annotation (1.1.1)

Annotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

NameDescription
name str
Output only. Resource name of the Annotation.
payload_schema_uri str
Required. Google Cloud Storage URI points to a YAML file describing payload. The schema is defined as an `OpenAPI 3.0.2 Schema Object
payload google.protobuf.struct_pb2.Value
Required. The schema of the payload can be found in payload_schema.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this Annotation was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this Annotation was last updated.
etag str
Optional. Used to perform consistent read- odify-write updates. If not set, a blind "overwrite" update happens.
annotation_source google.cloud.aiplatform_v1beta1.types.UserActionReference
Output only. The source of the Annotation.
labels Sequence[google.cloud.aiplatform_v1beta1.types.Annotation.LabelsEntry]
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.v1beta1.Annotation.payload_schema_uri] title.

Inheritance

builtins.object > proto.message.Message > Annotation

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, `.Message`]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.