Package com.google.cloud.aiplatform.v1

Class Annotation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Annotation
All Implemented Interfaces:
AnnotationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Annotation extends com.google.protobuf.GeneratedMessage implements AnnotationOrBuilder
 Used to assign specific AnnotationSpec to a particular area of a DataItem or
 the whole part of the DataItem.
Protobuf type google.cloud.aiplatform.v1.Annotation
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • PAYLOAD_SCHEMA_URI_FIELD_NUMBER

      public static final int PAYLOAD_SCHEMA_URI_FIELD_NUMBER
      See Also:

    • PAYLOAD_FIELD_NUMBER

      public static final int PAYLOAD_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • ANNOTATION_SOURCE_FIELD_NUMBER

      public static final int ANNOTATION_SOURCE_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Output only. Resource name of the Annotation.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface AnnotationOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Resource name of the Annotation.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface AnnotationOrBuilder
      Returns:
      The bytes for name.

    • getPayloadSchemaUri

      public String getPayloadSchemaUri()
       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](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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].
      string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPayloadSchemaUri in interface AnnotationOrBuilder
      Returns:
      The payloadSchemaUri.

    • getPayloadSchemaUriBytes

      public com.google.protobuf.ByteString getPayloadSchemaUriBytes()
       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](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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].
      string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPayloadSchemaUriBytes in interface AnnotationOrBuilder
      Returns:
      The bytes for payloadSchemaUri.

    • hasPayload

      public boolean hasPayload()
       Required. The schema of the payload can be found in
 [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
      .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasPayload in interface AnnotationOrBuilder
      Returns:
      Whether the payload field is set.

    • getPayload

      public com.google.protobuf.Value getPayload()
       Required. The schema of the payload can be found in
 [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
      .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPayload in interface AnnotationOrBuilder
      Returns:
      The payload.

    • getPayloadOrBuilder

      public com.google.protobuf.ValueOrBuilder getPayloadOrBuilder()
       Required. The schema of the payload can be found in
 [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
      .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPayloadOrBuilder in interface AnnotationOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp when this Annotation was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface AnnotationOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp when this Annotation was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface AnnotationOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp when this Annotation was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface AnnotationOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. Timestamp when this Annotation was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface AnnotationOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp when this Annotation was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface AnnotationOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp when this Annotation was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface AnnotationOrBuilder

    • getEtag

      public String getEtag()
       Optional. Used to perform consistent read-modify-write updates. If not set,
 a blind "overwrite" update happens.
      string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtag in interface AnnotationOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       Optional. Used to perform consistent read-modify-write updates. If not set,
 a blind "overwrite" update happens.
      string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtagBytes in interface AnnotationOrBuilder
      Returns:
      The bytes for etag.

    • hasAnnotationSource

      public boolean hasAnnotationSource()
       Output only. The source of the Annotation.
      .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasAnnotationSource in interface AnnotationOrBuilder
      Returns:
      Whether the annotationSource field is set.

    • getAnnotationSource

      public UserActionReference getAnnotationSource()
       Output only. The source of the Annotation.
      .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAnnotationSource in interface AnnotationOrBuilder
      Returns:
      The annotationSource.

    • getAnnotationSourceOrBuilder

      public UserActionReferenceOrBuilder getAnnotationSourceOrBuilder()
       Output only. The source of the Annotation.
      .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAnnotationSourceOrBuilder in interface AnnotationOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: AnnotationOrBuilder
       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.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface AnnotationOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       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.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface AnnotationOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface AnnotationOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       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.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface AnnotationOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       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.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface AnnotationOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       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.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface AnnotationOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Annotation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Annotation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Annotation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Annotation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Annotation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Annotation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Annotation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Annotation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Annotation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Annotation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Annotation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Annotation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Annotation.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Annotation.Builder newBuilder()

    • newBuilder

      public static Annotation.Builder newBuilder(Annotation prototype)

    • toBuilder

      public Annotation.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Annotation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Annotation getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Annotation> parser()

    • getParserForType

      public com.google.protobuf.Parser<Annotation> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Annotation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder