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

namespace Google\Analytics\Data\V1alpha;

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

/**
 * If funnel report results are
 * [sampled](https://support.google.com/analytics/answer/13331292), this
 * metadata describes what percentage of events were used in this funnel
 * report for a date range. Sampling is the practice of analyzing a subset of
 * all data in order to uncover the meaningful information in the larger data
 * set.
 *
 * Generated from protobuf message <code>google.analytics.data.v1alpha.SamplingMetadata</code>
 */
class SamplingMetadata extends \Google\Protobuf\Internal\Message
{
    /**
     * The total number of events read in this sampled report for a date range.
     * This is the size of the subset this property's data that was analyzed in
     * this funnel report.
     *
     * Generated from protobuf field <code>int64 samples_read_count = 1;</code>
     */
    protected $samples_read_count = 0;
    /**
     * The total number of events present in this property's data that could
     * have been analyzed in this funnel report for a date range. Sampling
     * uncovers the meaningful information about the larger data set, and this
     * is the size of the larger data set.
     * To calculate the percentage of available data that was used in this
     * funnel report, compute `samplesReadCount/samplingSpaceSize`.
     *
     * Generated from protobuf field <code>int64 sampling_space_size = 2;</code>
     */
    protected $sampling_space_size = 0;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type int|string $samples_read_count
     *           The total number of events read in this sampled report for a date range.
     *           This is the size of the subset this property's data that was analyzed in
     *           this funnel report.
     *     @type int|string $sampling_space_size
     *           The total number of events present in this property's data that could
     *           have been analyzed in this funnel report for a date range. Sampling
     *           uncovers the meaningful information about the larger data set, and this
     *           is the size of the larger data set.
     *           To calculate the percentage of available data that was used in this
     *           funnel report, compute `samplesReadCount/samplingSpaceSize`.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Analytics\Data\V1Alpha\Data::initOnce();
        parent::__construct($data);
    }

    /**
     * The total number of events read in this sampled report for a date range.
     * This is the size of the subset this property's data that was analyzed in
     * this funnel report.
     *
     * Generated from protobuf field <code>int64 samples_read_count = 1;</code>
     * @return int|string
     */
    public function getSamplesReadCount()
    {
        return $this->samples_read_count;
    }

    /**
     * The total number of events read in this sampled report for a date range.
     * This is the size of the subset this property's data that was analyzed in
     * this funnel report.
     *
     * Generated from protobuf field <code>int64 samples_read_count = 1;</code>
     * @param int|string $var
     * @return $this
     */
    public function setSamplesReadCount($var)
    {
        GPBUtil::checkInt64($var);
        $this->samples_read_count = $var;

        return $this;
    }

    /**
     * The total number of events present in this property's data that could
     * have been analyzed in this funnel report for a date range. Sampling
     * uncovers the meaningful information about the larger data set, and this
     * is the size of the larger data set.
     * To calculate the percentage of available data that was used in this
     * funnel report, compute `samplesReadCount/samplingSpaceSize`.
     *
     * Generated from protobuf field <code>int64 sampling_space_size = 2;</code>
     * @return int|string
     */
    public function getSamplingSpaceSize()
    {
        return $this->sampling_space_size;
    }

    /**
     * The total number of events present in this property's data that could
     * have been analyzed in this funnel report for a date range. Sampling
     * uncovers the meaningful information about the larger data set, and this
     * is the size of the larger data set.
     * To calculate the percentage of available data that was used in this
     * funnel report, compute `samplesReadCount/samplingSpaceSize`.
     *
     * Generated from protobuf field <code>int64 sampling_space_size = 2;</code>
     * @param int|string $var
     * @return $this
     */
    public function setSamplingSpaceSize($var)
    {
        GPBUtil::checkInt64($var);
        $this->sampling_space_size = $var;

        return $this;
    }

}

