<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/firestore/v1/firestore.proto

namespace Google\Cloud\Firestore\V1;

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

/**
 * The response for
 * [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
 *
 * Generated from protobuf message <code>google.firestore.v1.RunQueryResponse</code>
 */
class RunQueryResponse extends \Google\Protobuf\Internal\Message
{
    /**
     * The transaction that was started as part of this request.
     * Can only be set in the first response, and only if
     * [RunQueryRequest.new_transaction][google.firestore.v1.RunQueryRequest.new_transaction]
     * was set in the request. If set, no other fields will be set in this
     * response.
     *
     * Generated from protobuf field <code>bytes transaction = 2;</code>
     */
    private $transaction = '';
    /**
     * A query result, not set when reporting partial progress.
     *
     * Generated from protobuf field <code>.google.firestore.v1.Document document = 1;</code>
     */
    private $document = null;
    /**
     * The time at which the document was read. This may be monotonically
     * increasing; in this case, the previous documents in the result stream are
     * guaranteed not to have changed between their `read_time` and this one.
     * If the query returns no results, a response with `read_time` and no
     * `document` will be sent, and this represents the time at which the query
     * was run.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp read_time = 3;</code>
     */
    private $read_time = null;
    /**
     * The number of results that have been skipped due to an offset between
     * the last response and the current response.
     *
     * Generated from protobuf field <code>int32 skipped_results = 4;</code>
     */
    private $skipped_results = 0;
    /**
     * Query explain metrics. This is only present when the
     * [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
     * is provided, and it is sent only once with the last response in the stream.
     *
     * Generated from protobuf field <code>.google.firestore.v1.ExplainMetrics explain_metrics = 11;</code>
     */
    private $explain_metrics = null;
    protected $continuation_selector;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $transaction
     *           The transaction that was started as part of this request.
     *           Can only be set in the first response, and only if
     *           [RunQueryRequest.new_transaction][google.firestore.v1.RunQueryRequest.new_transaction]
     *           was set in the request. If set, no other fields will be set in this
     *           response.
     *     @type \Google\Cloud\Firestore\V1\Document $document
     *           A query result, not set when reporting partial progress.
     *     @type \Google\Protobuf\Timestamp $read_time
     *           The time at which the document was read. This may be monotonically
     *           increasing; in this case, the previous documents in the result stream are
     *           guaranteed not to have changed between their `read_time` and this one.
     *           If the query returns no results, a response with `read_time` and no
     *           `document` will be sent, and this represents the time at which the query
     *           was run.
     *     @type int $skipped_results
     *           The number of results that have been skipped due to an offset between
     *           the last response and the current response.
     *     @type bool $done
     *           If present, Firestore has completely finished the request and no more
     *           documents will be returned.
     *     @type \Google\Cloud\Firestore\V1\ExplainMetrics $explain_metrics
     *           Query explain metrics. This is only present when the
     *           [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
     *           is provided, and it is sent only once with the last response in the stream.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Firestore\V1\Firestore::initOnce();
        parent::__construct($data);
    }

    /**
     * The transaction that was started as part of this request.
     * Can only be set in the first response, and only if
     * [RunQueryRequest.new_transaction][google.firestore.v1.RunQueryRequest.new_transaction]
     * was set in the request. If set, no other fields will be set in this
     * response.
     *
     * Generated from protobuf field <code>bytes transaction = 2;</code>
     * @return string
     */
    public function getTransaction()
    {
        return $this->transaction;
    }

    /**
     * The transaction that was started as part of this request.
     * Can only be set in the first response, and only if
     * [RunQueryRequest.new_transaction][google.firestore.v1.RunQueryRequest.new_transaction]
     * was set in the request. If set, no other fields will be set in this
     * response.
     *
     * Generated from protobuf field <code>bytes transaction = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setTransaction($var)
    {
        GPBUtil::checkString($var, False);
        $this->transaction = $var;

        return $this;
    }

    /**
     * A query result, not set when reporting partial progress.
     *
     * Generated from protobuf field <code>.google.firestore.v1.Document document = 1;</code>
     * @return \Google\Cloud\Firestore\V1\Document|null
     */
    public function getDocument()
    {
        return $this->document;
    }

    public function hasDocument()
    {
        return isset($this->document);
    }

    public function clearDocument()
    {
        unset($this->document);
    }

    /**
     * A query result, not set when reporting partial progress.
     *
     * Generated from protobuf field <code>.google.firestore.v1.Document document = 1;</code>
     * @param \Google\Cloud\Firestore\V1\Document $var
     * @return $this
     */
    public function setDocument($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Firestore\V1\Document::class);
        $this->document = $var;

        return $this;
    }

    /**
     * The time at which the document was read. This may be monotonically
     * increasing; in this case, the previous documents in the result stream are
     * guaranteed not to have changed between their `read_time` and this one.
     * If the query returns no results, a response with `read_time` and no
     * `document` will be sent, and this represents the time at which the query
     * was run.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp read_time = 3;</code>
     * @return \Google\Protobuf\Timestamp|null
     */
    public function getReadTime()
    {
        return $this->read_time;
    }

    public function hasReadTime()
    {
        return isset($this->read_time);
    }

    public function clearReadTime()
    {
        unset($this->read_time);
    }

    /**
     * The time at which the document was read. This may be monotonically
     * increasing; in this case, the previous documents in the result stream are
     * guaranteed not to have changed between their `read_time` and this one.
     * If the query returns no results, a response with `read_time` and no
     * `document` will be sent, and this represents the time at which the query
     * was run.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp read_time = 3;</code>
     * @param \Google\Protobuf\Timestamp $var
     * @return $this
     */
    public function setReadTime($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
        $this->read_time = $var;

        return $this;
    }

    /**
     * The number of results that have been skipped due to an offset between
     * the last response and the current response.
     *
     * Generated from protobuf field <code>int32 skipped_results = 4;</code>
     * @return int
     */
    public function getSkippedResults()
    {
        return $this->skipped_results;
    }

    /**
     * The number of results that have been skipped due to an offset between
     * the last response and the current response.
     *
     * Generated from protobuf field <code>int32 skipped_results = 4;</code>
     * @param int $var
     * @return $this
     */
    public function setSkippedResults($var)
    {
        GPBUtil::checkInt32($var);
        $this->skipped_results = $var;

        return $this;
    }

    /**
     * If present, Firestore has completely finished the request and no more
     * documents will be returned.
     *
     * Generated from protobuf field <code>bool done = 6;</code>
     * @return bool
     */
    public function getDone()
    {
        return $this->readOneof(6);
    }

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

    /**
     * If present, Firestore has completely finished the request and no more
     * documents will be returned.
     *
     * Generated from protobuf field <code>bool done = 6;</code>
     * @param bool $var
     * @return $this
     */
    public function setDone($var)
    {
        GPBUtil::checkBool($var);
        $this->writeOneof(6, $var);

        return $this;
    }

    /**
     * Query explain metrics. This is only present when the
     * [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
     * is provided, and it is sent only once with the last response in the stream.
     *
     * Generated from protobuf field <code>.google.firestore.v1.ExplainMetrics explain_metrics = 11;</code>
     * @return \Google\Cloud\Firestore\V1\ExplainMetrics|null
     */
    public function getExplainMetrics()
    {
        return $this->explain_metrics;
    }

    public function hasExplainMetrics()
    {
        return isset($this->explain_metrics);
    }

    public function clearExplainMetrics()
    {
        unset($this->explain_metrics);
    }

    /**
     * Query explain metrics. This is only present when the
     * [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
     * is provided, and it is sent only once with the last response in the stream.
     *
     * Generated from protobuf field <code>.google.firestore.v1.ExplainMetrics explain_metrics = 11;</code>
     * @param \Google\Cloud\Firestore\V1\ExplainMetrics $var
     * @return $this
     */
    public function setExplainMetrics($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Firestore\V1\ExplainMetrics::class);
        $this->explain_metrics = $var;

        return $this;
    }

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

}

