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

namespace Google\Cloud\Datastore\Admin\V1;

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

/**
 * Metadata for ExportEntities operations.
 *
 * Generated from protobuf message <code>google.datastore.admin.v1.ExportEntitiesMetadata</code>
 */
class ExportEntitiesMetadata extends \Google\Protobuf\Internal\Message
{
    /**
     * Metadata common to all Datastore Admin operations.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.CommonMetadata common = 1;</code>
     */
    private $common = null;
    /**
     * An estimate of the number of entities processed.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.Progress progress_entities = 2;</code>
     */
    private $progress_entities = null;
    /**
     * An estimate of the number of bytes processed.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.Progress progress_bytes = 3;</code>
     */
    private $progress_bytes = null;
    /**
     * Description of which entities are being exported.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.EntityFilter entity_filter = 4;</code>
     */
    private $entity_filter = null;
    /**
     * Location for the export metadata and data files. This will be the same
     * value as the
     * [google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix][google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix]
     * field. The final output location is provided in
     * [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url].
     *
     * Generated from protobuf field <code>string output_url_prefix = 5;</code>
     */
    private $output_url_prefix = '';

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type \Google\Cloud\Datastore\Admin\V1\CommonMetadata $common
     *           Metadata common to all Datastore Admin operations.
     *     @type \Google\Cloud\Datastore\Admin\V1\Progress $progress_entities
     *           An estimate of the number of entities processed.
     *     @type \Google\Cloud\Datastore\Admin\V1\Progress $progress_bytes
     *           An estimate of the number of bytes processed.
     *     @type \Google\Cloud\Datastore\Admin\V1\EntityFilter $entity_filter
     *           Description of which entities are being exported.
     *     @type string $output_url_prefix
     *           Location for the export metadata and data files. This will be the same
     *           value as the
     *           [google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix][google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix]
     *           field. The final output location is provided in
     *           [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url].
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Datastore\Admin\V1\DatastoreAdmin::initOnce();
        parent::__construct($data);
    }

    /**
     * Metadata common to all Datastore Admin operations.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.CommonMetadata common = 1;</code>
     * @return \Google\Cloud\Datastore\Admin\V1\CommonMetadata
     */
    public function getCommon()
    {
        return isset($this->common) ? $this->common : null;
    }

    public function hasCommon()
    {
        return isset($this->common);
    }

    public function clearCommon()
    {
        unset($this->common);
    }

    /**
     * Metadata common to all Datastore Admin operations.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.CommonMetadata common = 1;</code>
     * @param \Google\Cloud\Datastore\Admin\V1\CommonMetadata $var
     * @return $this
     */
    public function setCommon($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Datastore\Admin\V1\CommonMetadata::class);
        $this->common = $var;

        return $this;
    }

    /**
     * An estimate of the number of entities processed.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.Progress progress_entities = 2;</code>
     * @return \Google\Cloud\Datastore\Admin\V1\Progress
     */
    public function getProgressEntities()
    {
        return isset($this->progress_entities) ? $this->progress_entities : null;
    }

    public function hasProgressEntities()
    {
        return isset($this->progress_entities);
    }

    public function clearProgressEntities()
    {
        unset($this->progress_entities);
    }

    /**
     * An estimate of the number of entities processed.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.Progress progress_entities = 2;</code>
     * @param \Google\Cloud\Datastore\Admin\V1\Progress $var
     * @return $this
     */
    public function setProgressEntities($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Datastore\Admin\V1\Progress::class);
        $this->progress_entities = $var;

        return $this;
    }

    /**
     * An estimate of the number of bytes processed.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.Progress progress_bytes = 3;</code>
     * @return \Google\Cloud\Datastore\Admin\V1\Progress
     */
    public function getProgressBytes()
    {
        return isset($this->progress_bytes) ? $this->progress_bytes : null;
    }

    public function hasProgressBytes()
    {
        return isset($this->progress_bytes);
    }

    public function clearProgressBytes()
    {
        unset($this->progress_bytes);
    }

    /**
     * An estimate of the number of bytes processed.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.Progress progress_bytes = 3;</code>
     * @param \Google\Cloud\Datastore\Admin\V1\Progress $var
     * @return $this
     */
    public function setProgressBytes($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Datastore\Admin\V1\Progress::class);
        $this->progress_bytes = $var;

        return $this;
    }

    /**
     * Description of which entities are being exported.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.EntityFilter entity_filter = 4;</code>
     * @return \Google\Cloud\Datastore\Admin\V1\EntityFilter
     */
    public function getEntityFilter()
    {
        return isset($this->entity_filter) ? $this->entity_filter : null;
    }

    public function hasEntityFilter()
    {
        return isset($this->entity_filter);
    }

    public function clearEntityFilter()
    {
        unset($this->entity_filter);
    }

    /**
     * Description of which entities are being exported.
     *
     * Generated from protobuf field <code>.google.datastore.admin.v1.EntityFilter entity_filter = 4;</code>
     * @param \Google\Cloud\Datastore\Admin\V1\EntityFilter $var
     * @return $this
     */
    public function setEntityFilter($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Datastore\Admin\V1\EntityFilter::class);
        $this->entity_filter = $var;

        return $this;
    }

    /**
     * Location for the export metadata and data files. This will be the same
     * value as the
     * [google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix][google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix]
     * field. The final output location is provided in
     * [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url].
     *
     * Generated from protobuf field <code>string output_url_prefix = 5;</code>
     * @return string
     */
    public function getOutputUrlPrefix()
    {
        return $this->output_url_prefix;
    }

    /**
     * Location for the export metadata and data files. This will be the same
     * value as the
     * [google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix][google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix]
     * field. The final output location is provided in
     * [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url].
     *
     * Generated from protobuf field <code>string output_url_prefix = 5;</code>
     * @param string $var
     * @return $this
     */
    public function setOutputUrlPrefix($var)
    {
        GPBUtil::checkString($var, True);
        $this->output_url_prefix = $var;

        return $this;
    }

}

