<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/dialogflow/v2/generator_evaluation.proto

namespace Google\Cloud\Dialogflow\V2;

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

/**
 * Represents evaluation result of a generator.
 *
 * Generated from protobuf message <code>google.cloud.dialogflow.v2.GeneratorEvaluation</code>
 */
class GeneratorEvaluation extends \Google\Protobuf\Internal\Message
{
    /**
     * Output only. Identifier. The resource name of the evaluation. Format:
     * `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/
     * evaluations/<Evaluation ID>`
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $name = '';
    /**
     * Optional. The display name of the generator evaluation. At most 64 bytes
     * long.
     *
     * Generated from protobuf field <code>string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $display_name = '';
    /**
     * Required. The configuration of the evaluation task.
     *
     * Generated from protobuf field <code>.google.cloud.dialogflow.v2.GeneratorEvaluationConfig generator_evaluation_config = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $generator_evaluation_config = null;
    /**
     * Output only. Creation time of this generator evaluation.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $create_time = null;
    /**
     * Output only. Completion time of this generator evaluation.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp complete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $complete_time = null;
    /**
     * Required. The initial generator that was used when creating this
     * evaluation. This is a copy of the generator read from storage when creating
     * the evaluation.
     *
     * Generated from protobuf field <code>.google.cloud.dialogflow.v2.Generator initial_generator = 5 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $initial_generator = null;
    /**
     * Output only. The result status of the evaluation pipeline. Provides the
     * status information including if the evaluation is still in progress,
     * completed or failed with certain error and user actionable message.
     *
     * Generated from protobuf field <code>.google.cloud.dialogflow.v2.EvaluationStatus evaluation_status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $evaluation_status = null;
    /**
     * Output only. A read only boolean field reflecting Zone Separation
     * status of the model. The field is an aggregated
     * value of ZS status of its underlying dependencies. See more details in
     * go/zicy-resource-placement#resource-status
     *
     * Generated from protobuf field <code>optional bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $satisfies_pzs = null;
    /**
     * Output only. A read only boolean field reflecting Zone Isolation status
     * of the model. The field is an aggregated value of
     * ZI status of its underlying dependencies. See more details in
     * go/zicy-resource-placement#resource-status
     *
     * Generated from protobuf field <code>optional bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $satisfies_pzi = null;
    protected $metrics;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           Output only. Identifier. The resource name of the evaluation. Format:
     *           `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/
     *           evaluations/<Evaluation ID>`
     *     @type string $display_name
     *           Optional. The display name of the generator evaluation. At most 64 bytes
     *           long.
     *     @type \Google\Cloud\Dialogflow\V2\GeneratorEvaluationConfig $generator_evaluation_config
     *           Required. The configuration of the evaluation task.
     *     @type \Google\Protobuf\Timestamp $create_time
     *           Output only. Creation time of this generator evaluation.
     *     @type \Google\Protobuf\Timestamp $complete_time
     *           Output only. Completion time of this generator evaluation.
     *     @type \Google\Cloud\Dialogflow\V2\Generator $initial_generator
     *           Required. The initial generator that was used when creating this
     *           evaluation. This is a copy of the generator read from storage when creating
     *           the evaluation.
     *     @type \Google\Cloud\Dialogflow\V2\SummarizationEvaluationMetrics $summarization_metrics
     *           Output only. Only available when the summarization generator is provided.
     *     @type \Google\Cloud\Dialogflow\V2\EvaluationStatus $evaluation_status
     *           Output only. The result status of the evaluation pipeline. Provides the
     *           status information including if the evaluation is still in progress,
     *           completed or failed with certain error and user actionable message.
     *     @type bool $satisfies_pzs
     *           Output only. A read only boolean field reflecting Zone Separation
     *           status of the model. The field is an aggregated
     *           value of ZS status of its underlying dependencies. See more details in
     *           go/zicy-resource-placement#resource-status
     *     @type bool $satisfies_pzi
     *           Output only. A read only boolean field reflecting Zone Isolation status
     *           of the model. The field is an aggregated value of
     *           ZI status of its underlying dependencies. See more details in
     *           go/zicy-resource-placement#resource-status
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Dialogflow\V2\GeneratorEvaluation::initOnce();
        parent::__construct($data);
    }

    /**
     * Output only. Identifier. The resource name of the evaluation. Format:
     * `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/
     * evaluations/<Evaluation ID>`
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Output only. Identifier. The resource name of the evaluation. Format:
     * `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/
     * evaluations/<Evaluation ID>`
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * Optional. The display name of the generator evaluation. At most 64 bytes
     * long.
     *
     * Generated from protobuf field <code>string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getDisplayName()
    {
        return $this->display_name;
    }

    /**
     * Optional. The display name of the generator evaluation. At most 64 bytes
     * long.
     *
     * Generated from protobuf field <code>string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setDisplayName($var)
    {
        GPBUtil::checkString($var, True);
        $this->display_name = $var;

        return $this;
    }

    /**
     * Required. The configuration of the evaluation task.
     *
     * Generated from protobuf field <code>.google.cloud.dialogflow.v2.GeneratorEvaluationConfig generator_evaluation_config = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return \Google\Cloud\Dialogflow\V2\GeneratorEvaluationConfig|null
     */
    public function getGeneratorEvaluationConfig()
    {
        return $this->generator_evaluation_config;
    }

    public function hasGeneratorEvaluationConfig()
    {
        return isset($this->generator_evaluation_config);
    }

    public function clearGeneratorEvaluationConfig()
    {
        unset($this->generator_evaluation_config);
    }

    /**
     * Required. The configuration of the evaluation task.
     *
     * Generated from protobuf field <code>.google.cloud.dialogflow.v2.GeneratorEvaluationConfig generator_evaluation_config = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param \Google\Cloud\Dialogflow\V2\GeneratorEvaluationConfig $var
     * @return $this
     */
    public function setGeneratorEvaluationConfig($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\V2\GeneratorEvaluationConfig::class);
        $this->generator_evaluation_config = $var;

        return $this;
    }

    /**
     * Output only. Creation time of this generator evaluation.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return \Google\Protobuf\Timestamp|null
     */
    public function getCreateTime()
    {
        return $this->create_time;
    }

    public function hasCreateTime()
    {
        return isset($this->create_time);
    }

    public function clearCreateTime()
    {
        unset($this->create_time);
    }

    /**
     * Output only. Creation time of this generator evaluation.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param \Google\Protobuf\Timestamp $var
     * @return $this
     */
    public function setCreateTime($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
        $this->create_time = $var;

        return $this;
    }

    /**
     * Output only. Completion time of this generator evaluation.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp complete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return \Google\Protobuf\Timestamp|null
     */
    public function getCompleteTime()
    {
        return $this->complete_time;
    }

    public function hasCompleteTime()
    {
        return isset($this->complete_time);
    }

    public function clearCompleteTime()
    {
        unset($this->complete_time);
    }

    /**
     * Output only. Completion time of this generator evaluation.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp complete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param \Google\Protobuf\Timestamp $var
     * @return $this
     */
    public function setCompleteTime($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
        $this->complete_time = $var;

        return $this;
    }

    /**
     * Required. The initial generator that was used when creating this
     * evaluation. This is a copy of the generator read from storage when creating
     * the evaluation.
     *
     * Generated from protobuf field <code>.google.cloud.dialogflow.v2.Generator initial_generator = 5 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return \Google\Cloud\Dialogflow\V2\Generator|null
     */
    public function getInitialGenerator()
    {
        return $this->initial_generator;
    }

    public function hasInitialGenerator()
    {
        return isset($this->initial_generator);
    }

    public function clearInitialGenerator()
    {
        unset($this->initial_generator);
    }

    /**
     * Required. The initial generator that was used when creating this
     * evaluation. This is a copy of the generator read from storage when creating
     * the evaluation.
     *
     * Generated from protobuf field <code>.google.cloud.dialogflow.v2.Generator initial_generator = 5 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param \Google\Cloud\Dialogflow\V2\Generator $var
     * @return $this
     */
    public function setInitialGenerator($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\V2\Generator::class);
        $this->initial_generator = $var;

        return $this;
    }

    /**
     * Output only. Only available when the summarization generator is provided.
     *
     * Generated from protobuf field <code>.google.cloud.dialogflow.v2.SummarizationEvaluationMetrics summarization_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return \Google\Cloud\Dialogflow\V2\SummarizationEvaluationMetrics|null
     */
    public function getSummarizationMetrics()
    {
        return $this->readOneof(6);
    }

    public function hasSummarizationMetrics()
    {
        return $this->hasOneof(6);
    }

    /**
     * Output only. Only available when the summarization generator is provided.
     *
     * Generated from protobuf field <code>.google.cloud.dialogflow.v2.SummarizationEvaluationMetrics summarization_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param \Google\Cloud\Dialogflow\V2\SummarizationEvaluationMetrics $var
     * @return $this
     */
    public function setSummarizationMetrics($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\V2\SummarizationEvaluationMetrics::class);
        $this->writeOneof(6, $var);

        return $this;
    }

    /**
     * Output only. The result status of the evaluation pipeline. Provides the
     * status information including if the evaluation is still in progress,
     * completed or failed with certain error and user actionable message.
     *
     * Generated from protobuf field <code>.google.cloud.dialogflow.v2.EvaluationStatus evaluation_status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return \Google\Cloud\Dialogflow\V2\EvaluationStatus|null
     */
    public function getEvaluationStatus()
    {
        return $this->evaluation_status;
    }

    public function hasEvaluationStatus()
    {
        return isset($this->evaluation_status);
    }

    public function clearEvaluationStatus()
    {
        unset($this->evaluation_status);
    }

    /**
     * Output only. The result status of the evaluation pipeline. Provides the
     * status information including if the evaluation is still in progress,
     * completed or failed with certain error and user actionable message.
     *
     * Generated from protobuf field <code>.google.cloud.dialogflow.v2.EvaluationStatus evaluation_status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param \Google\Cloud\Dialogflow\V2\EvaluationStatus $var
     * @return $this
     */
    public function setEvaluationStatus($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\V2\EvaluationStatus::class);
        $this->evaluation_status = $var;

        return $this;
    }

    /**
     * Output only. A read only boolean field reflecting Zone Separation
     * status of the model. The field is an aggregated
     * value of ZS status of its underlying dependencies. See more details in
     * go/zicy-resource-placement#resource-status
     *
     * Generated from protobuf field <code>optional bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return bool
     */
    public function getSatisfiesPzs()
    {
        return isset($this->satisfies_pzs) ? $this->satisfies_pzs : false;
    }

    public function hasSatisfiesPzs()
    {
        return isset($this->satisfies_pzs);
    }

    public function clearSatisfiesPzs()
    {
        unset($this->satisfies_pzs);
    }

    /**
     * Output only. A read only boolean field reflecting Zone Separation
     * status of the model. The field is an aggregated
     * value of ZS status of its underlying dependencies. See more details in
     * go/zicy-resource-placement#resource-status
     *
     * Generated from protobuf field <code>optional bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param bool $var
     * @return $this
     */
    public function setSatisfiesPzs($var)
    {
        GPBUtil::checkBool($var);
        $this->satisfies_pzs = $var;

        return $this;
    }

    /**
     * Output only. A read only boolean field reflecting Zone Isolation status
     * of the model. The field is an aggregated value of
     * ZI status of its underlying dependencies. See more details in
     * go/zicy-resource-placement#resource-status
     *
     * Generated from protobuf field <code>optional bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return bool
     */
    public function getSatisfiesPzi()
    {
        return isset($this->satisfies_pzi) ? $this->satisfies_pzi : false;
    }

    public function hasSatisfiesPzi()
    {
        return isset($this->satisfies_pzi);
    }

    public function clearSatisfiesPzi()
    {
        unset($this->satisfies_pzi);
    }

    /**
     * Output only. A read only boolean field reflecting Zone Isolation status
     * of the model. The field is an aggregated value of
     * ZI status of its underlying dependencies. See more details in
     * go/zicy-resource-placement#resource-status
     *
     * Generated from protobuf field <code>optional bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param bool $var
     * @return $this
     */
    public function setSatisfiesPzi($var)
    {
        GPBUtil::checkBool($var);
        $this->satisfies_pzi = $var;

        return $this;
    }

    /**
     * @return string
     */
    public function getMetrics()
    {
        return $this->whichOneof("metrics");
    }

}

