Package com.google.cloud.aiplatform.v1

Interface AnnotationOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Annotation, Annotation.Builder
    public interface AnnotationOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

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

      • getNameBytes

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

      • getPayloadSchemaUri

        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];
        Returns:
        The payloadSchemaUri.

      • getPayloadSchemaUriBytes

        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];
        Returns:
        The bytes for payloadSchemaUri.

      • hasPayload

        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];
        Returns:
        Whether the payload field is set.

      • getPayload

        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];
        Returns:
        The payload.

      • getPayloadOrBuilder

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

      • hasCreateTime

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

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

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

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

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

      • getEtag

        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];
        Returns:
        The etag.

      • getEtagBytes

        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];
        Returns:
        The bytes for etag.

      • hasAnnotationSource

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

      • getAnnotationSource

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

      • getAnnotationSourceOrBuilder

        UserActionReferenceOrBuilder getAnnotationSourceOrBuilder()
         Output only. The source of the Annotation.
        .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsCount

        int getLabelsCount()
         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];

      • containsLabels

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

      • getLabelsMap

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

      • getLabelsOrDefault

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

      • getLabelsOrThrow

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