<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/datalabeling/v1beta1/annotation.proto

namespace Google\Cloud\DataLabeling\V1beta1;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;

/**
 * Annotation for Example. Each example may have one or more annotations. For
 * example in image classification problem, each image might have one or more
 * labels. We call labels binded with this image an Annotation.
 *
 * Generated from protobuf message <code>google.cloud.datalabeling.v1beta1.Annotation</code>
 */
class Annotation extends \Google\Protobuf\Internal\Message
{
    /**
     * Output only. Unique name of this annotation, format is:
     * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
     *
     * Generated from protobuf field <code>string name = 1;</code>
     */
    private $name = '';
    /**
     * Output only. The source of the annotation.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;</code>
     */
    private $annotation_source = 0;
    /**
     * Output only. This is the actual annotation value, e.g classification,
     * bounding box values are stored here.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;</code>
     */
    private $annotation_value = null;
    /**
     * Output only. Annotation metadata, including information like votes
     * for labels.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;</code>
     */
    private $annotation_metadata = null;
    /**
     * Output only. Sentiment for this annotation.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;</code>
     */
    private $annotation_sentiment = 0;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           Output only. Unique name of this annotation, format is:
     *           projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
     *     @type int $annotation_source
     *           Output only. The source of the annotation.
     *     @type \Google\Cloud\DataLabeling\V1beta1\AnnotationValue $annotation_value
     *           Output only. This is the actual annotation value, e.g classification,
     *           bounding box values are stored here.
     *     @type \Google\Cloud\DataLabeling\V1beta1\AnnotationMetadata $annotation_metadata
     *           Output only. Annotation metadata, including information like votes
     *           for labels.
     *     @type int $annotation_sentiment
     *           Output only. Sentiment for this annotation.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Datalabeling\V1Beta1\Annotation::initOnce();
        parent::__construct($data);
    }

    /**
     * Output only. Unique name of this annotation, format is:
     * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
     *
     * Generated from protobuf field <code>string name = 1;</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Output only. Unique name of this annotation, format is:
     * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}
     *
     * Generated from protobuf field <code>string name = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * Output only. The source of the annotation.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;</code>
     * @return int
     */
    public function getAnnotationSource()
    {
        return $this->annotation_source;
    }

    /**
     * Output only. The source of the annotation.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;</code>
     * @param int $var
     * @return $this
     */
    public function setAnnotationSource($var)
    {
        GPBUtil::checkEnum($var, \Google\Cloud\DataLabeling\V1beta1\AnnotationSource::class);
        $this->annotation_source = $var;

        return $this;
    }

    /**
     * Output only. This is the actual annotation value, e.g classification,
     * bounding box values are stored here.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;</code>
     * @return \Google\Cloud\DataLabeling\V1beta1\AnnotationValue|null
     */
    public function getAnnotationValue()
    {
        return $this->annotation_value;
    }

    public function hasAnnotationValue()
    {
        return isset($this->annotation_value);
    }

    public function clearAnnotationValue()
    {
        unset($this->annotation_value);
    }

    /**
     * Output only. This is the actual annotation value, e.g classification,
     * bounding box values are stored here.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;</code>
     * @param \Google\Cloud\DataLabeling\V1beta1\AnnotationValue $var
     * @return $this
     */
    public function setAnnotationValue($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\DataLabeling\V1beta1\AnnotationValue::class);
        $this->annotation_value = $var;

        return $this;
    }

    /**
     * Output only. Annotation metadata, including information like votes
     * for labels.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;</code>
     * @return \Google\Cloud\DataLabeling\V1beta1\AnnotationMetadata|null
     */
    public function getAnnotationMetadata()
    {
        return $this->annotation_metadata;
    }

    public function hasAnnotationMetadata()
    {
        return isset($this->annotation_metadata);
    }

    public function clearAnnotationMetadata()
    {
        unset($this->annotation_metadata);
    }

    /**
     * Output only. Annotation metadata, including information like votes
     * for labels.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;</code>
     * @param \Google\Cloud\DataLabeling\V1beta1\AnnotationMetadata $var
     * @return $this
     */
    public function setAnnotationMetadata($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\DataLabeling\V1beta1\AnnotationMetadata::class);
        $this->annotation_metadata = $var;

        return $this;
    }

    /**
     * Output only. Sentiment for this annotation.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;</code>
     * @return int
     */
    public function getAnnotationSentiment()
    {
        return $this->annotation_sentiment;
    }

    /**
     * Output only. Sentiment for this annotation.
     *
     * Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;</code>
     * @param int $var
     * @return $this
     */
    public function setAnnotationSentiment($var)
    {
        GPBUtil::checkEnum($var, \Google\Cloud\DataLabeling\V1beta1\AnnotationSentiment::class);
        $this->annotation_sentiment = $var;

        return $this;
    }

}