/*
 * Copyright 2023 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/datalabeling/v1beta1/annotation.proto

package com.google.cloud.datalabeling.v1beta1;

public interface AnnotationOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.datalabeling.v1beta1.Annotation)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * Output only. Unique name of this annotation, format is:
   *
   * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
   * </pre>
   *
   * <code>string name = 1;</code>
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   * <pre>
   * Output only. Unique name of this annotation, format is:
   *
   * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
   * </pre>
   *
   * <code>string name = 1;</code>
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   * <pre>
   * Output only. The source of the annotation.
   * </pre>
   *
   * <code>.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;</code>
   *
   * @return The enum numeric value on the wire for annotationSource.
   */
  int getAnnotationSourceValue();
  /**
   *
   *
   * <pre>
   * Output only. The source of the annotation.
   * </pre>
   *
   * <code>.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;</code>
   *
   * @return The annotationSource.
   */
  com.google.cloud.datalabeling.v1beta1.AnnotationSource getAnnotationSource();

  /**
   *
   *
   * <pre>
   * Output only. This is the actual annotation value, e.g classification,
   * bounding box values are stored here.
   * </pre>
   *
   * <code>.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;</code>
   *
   * @return Whether the annotationValue field is set.
   */
  boolean hasAnnotationValue();
  /**
   *
   *
   * <pre>
   * Output only. This is the actual annotation value, e.g classification,
   * bounding box values are stored here.
   * </pre>
   *
   * <code>.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;</code>
   *
   * @return The annotationValue.
   */
  com.google.cloud.datalabeling.v1beta1.AnnotationValue getAnnotationValue();
  /**
   *
   *
   * <pre>
   * Output only. This is the actual annotation value, e.g classification,
   * bounding box values are stored here.
   * </pre>
   *
   * <code>.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;</code>
   */
  com.google.cloud.datalabeling.v1beta1.AnnotationValueOrBuilder getAnnotationValueOrBuilder();

  /**
   *
   *
   * <pre>
   * Output only. Annotation metadata, including information like votes
   * for labels.
   * </pre>
   *
   * <code>.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;</code>
   *
   * @return Whether the annotationMetadata field is set.
   */
  boolean hasAnnotationMetadata();
  /**
   *
   *
   * <pre>
   * Output only. Annotation metadata, including information like votes
   * for labels.
   * </pre>
   *
   * <code>.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;</code>
   *
   * @return The annotationMetadata.
   */
  com.google.cloud.datalabeling.v1beta1.AnnotationMetadata getAnnotationMetadata();
  /**
   *
   *
   * <pre>
   * Output only. Annotation metadata, including information like votes
   * for labels.
   * </pre>
   *
   * <code>.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;</code>
   */
  com.google.cloud.datalabeling.v1beta1.AnnotationMetadataOrBuilder
      getAnnotationMetadataOrBuilder();

  /**
   *
   *
   * <pre>
   * Output only. Sentiment for this annotation.
   * </pre>
   *
   * <code>.google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;</code>
   *
   * @return The enum numeric value on the wire for annotationSentiment.
   */
  int getAnnotationSentimentValue();
  /**
   *
   *
   * <pre>
   * Output only. Sentiment for this annotation.
   * </pre>
   *
   * <code>.google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;</code>
   *
   * @return The annotationSentiment.
   */
  com.google.cloud.datalabeling.v1beta1.AnnotationSentiment getAnnotationSentiment();
}
