Struct google_api_proto::google::cloud::aiplatform::v1::Annotation

pub struct Annotation {
    pub name: String,
    pub payload_schema_uri: String,
    pub payload: Option<Value>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub etag: String,
    pub annotation_source: Option<UserActionReference>,
    pub labels: BTreeMap<String, String>,
}

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

Fields

name: String

Output only. Resource name of the Annotation.

payload_schema_uri: String

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].

payload: Option<Value>

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

create_time: Option<Timestamp>

Output only. Timestamp when this Annotation was created.

update_time: Option<Timestamp>

Output only. Timestamp when this Annotation was last updated.

etag: String

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

annotation_source: Option<UserActionReference>

Output only. The source of the Annotation.

labels: BTreeMap<String, String>

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.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Annotation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Annotation

fn default() -> Self

Returns the “default value” for a type.

impl Message for Annotation

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Annotation

fn eq(&self, other: &Annotation) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Annotation