Package com.google.cloud.visionai.v1

Interface CreateAnnotationRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CreateAnnotationRequest, CreateAnnotationRequest.Builder
@Generated public interface CreateAnnotationRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Annotation
    getAnnotation()
    Required.
    String
    getAnnotationId()
    Optional.
    com.google.protobuf.ByteString
    getAnnotationIdBytes()
    Optional.
    AnnotationOrBuilder
    getAnnotationOrBuilder()
    Required.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    boolean
    hasAnnotation()
    Required.
    boolean
    hasAnnotationId()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       Required. The parent resource where this annotation will be created.
 Format:
 `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The parent resource where this annotation will be created.
 Format:
 `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • hasAnnotation

      boolean hasAnnotation()
       Required. The annotation to create.
      .google.cloud.visionai.v1.Annotation annotation = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the annotation field is set.

    • getAnnotation

      Annotation getAnnotation()
       Required. The annotation to create.
      .google.cloud.visionai.v1.Annotation annotation = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The annotation.

    • getAnnotationOrBuilder

      AnnotationOrBuilder getAnnotationOrBuilder()
       Required. The annotation to create.
      .google.cloud.visionai.v1.Annotation annotation = 2 [(.google.api.field_behavior) = REQUIRED];

    • hasAnnotationId

      boolean hasAnnotationId()
       Optional. The ID to use for the annotation, which will become the final
 component of the annotation's resource name if user choose to specify.
 Otherwise, annotation id will be generated by system.

 This value should be up to 63 characters, and valid characters
 are /[a-z][0-9]-/. The first character must be a letter, the last could be
 a letter or a number.
      optional string annotation_id = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the annotationId field is set.

    • getAnnotationId

      String getAnnotationId()
       Optional. The ID to use for the annotation, which will become the final
 component of the annotation's resource name if user choose to specify.
 Otherwise, annotation id will be generated by system.

 This value should be up to 63 characters, and valid characters
 are /[a-z][0-9]-/. The first character must be a letter, the last could be
 a letter or a number.
      optional string annotation_id = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The annotationId.

    • getAnnotationIdBytes

      com.google.protobuf.ByteString getAnnotationIdBytes()
       Optional. The ID to use for the annotation, which will become the final
 component of the annotation's resource name if user choose to specify.
 Otherwise, annotation id will be generated by system.

 This value should be up to 63 characters, and valid characters
 are /[a-z][0-9]-/. The first character must be a letter, the last could be
 a letter or a number.
      optional string annotation_id = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for annotationId.