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

namespace Google\Analytics\Data\V1alpha;

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

/**
 * The funnel report response contains two sub reports. The two sub reports are
 * different combinations of dimensions and metrics.
 *
 * Generated from protobuf message <code>google.analytics.data.v1alpha.RunFunnelReportResponse</code>
 */
class RunFunnelReportResponse extends \Google\Protobuf\Internal\Message
{
    /**
     * The funnel table is a report with the funnel step, segment, breakdown
     * dimension, active users, completion rate, abandonments, and abandonments
     * rate.
     * The segment dimension is only present in this response if a segment was
     * requested. The breakdown dimension is only present in this response if it
     * was requested.
     *
     * Generated from protobuf field <code>.google.analytics.data.v1alpha.FunnelSubReport funnel_table = 1;</code>
     */
    private $funnel_table = null;
    /**
     * The funnel visualization is a report with the funnel step, segment, date,
     * next action dimension, and active users.
     * The segment dimension is only present in this response if a segment was
     * requested. The date dimension is only present in this response if it was
     * requested through the `TRENDED_FUNNEL` funnel type. The next action
     * dimension is only present in the response if it was requested.
     *
     * Generated from protobuf field <code>.google.analytics.data.v1alpha.FunnelSubReport funnel_visualization = 2;</code>
     */
    private $funnel_visualization = null;
    /**
     * This Analytics Property's quota state including this request.
     *
     * Generated from protobuf field <code>.google.analytics.data.v1alpha.PropertyQuota property_quota = 3;</code>
     */
    private $property_quota = null;
    /**
     * Identifies what kind of resource this message is. This `kind` is always the
     * fixed string "analyticsData#runFunnelReport". Useful to distinguish between
     * response types in JSON.
     *
     * Generated from protobuf field <code>string kind = 4;</code>
     */
    private $kind = '';

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type \Google\Analytics\Data\V1alpha\FunnelSubReport $funnel_table
     *           The funnel table is a report with the funnel step, segment, breakdown
     *           dimension, active users, completion rate, abandonments, and abandonments
     *           rate.
     *           The segment dimension is only present in this response if a segment was
     *           requested. The breakdown dimension is only present in this response if it
     *           was requested.
     *     @type \Google\Analytics\Data\V1alpha\FunnelSubReport $funnel_visualization
     *           The funnel visualization is a report with the funnel step, segment, date,
     *           next action dimension, and active users.
     *           The segment dimension is only present in this response if a segment was
     *           requested. The date dimension is only present in this response if it was
     *           requested through the `TRENDED_FUNNEL` funnel type. The next action
     *           dimension is only present in the response if it was requested.
     *     @type \Google\Analytics\Data\V1alpha\PropertyQuota $property_quota
     *           This Analytics Property's quota state including this request.
     *     @type string $kind
     *           Identifies what kind of resource this message is. This `kind` is always the
     *           fixed string "analyticsData#runFunnelReport". Useful to distinguish between
     *           response types in JSON.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Analytics\Data\V1Alpha\AnalyticsDataApi::initOnce();
        parent::__construct($data);
    }

    /**
     * The funnel table is a report with the funnel step, segment, breakdown
     * dimension, active users, completion rate, abandonments, and abandonments
     * rate.
     * The segment dimension is only present in this response if a segment was
     * requested. The breakdown dimension is only present in this response if it
     * was requested.
     *
     * Generated from protobuf field <code>.google.analytics.data.v1alpha.FunnelSubReport funnel_table = 1;</code>
     * @return \Google\Analytics\Data\V1alpha\FunnelSubReport|null
     */
    public function getFunnelTable()
    {
        return $this->funnel_table;
    }

    public function hasFunnelTable()
    {
        return isset($this->funnel_table);
    }

    public function clearFunnelTable()
    {
        unset($this->funnel_table);
    }

    /**
     * The funnel table is a report with the funnel step, segment, breakdown
     * dimension, active users, completion rate, abandonments, and abandonments
     * rate.
     * The segment dimension is only present in this response if a segment was
     * requested. The breakdown dimension is only present in this response if it
     * was requested.
     *
     * Generated from protobuf field <code>.google.analytics.data.v1alpha.FunnelSubReport funnel_table = 1;</code>
     * @param \Google\Analytics\Data\V1alpha\FunnelSubReport $var
     * @return $this
     */
    public function setFunnelTable($var)
    {
        GPBUtil::checkMessage($var, \Google\Analytics\Data\V1alpha\FunnelSubReport::class);
        $this->funnel_table = $var;

        return $this;
    }

    /**
     * The funnel visualization is a report with the funnel step, segment, date,
     * next action dimension, and active users.
     * The segment dimension is only present in this response if a segment was
     * requested. The date dimension is only present in this response if it was
     * requested through the `TRENDED_FUNNEL` funnel type. The next action
     * dimension is only present in the response if it was requested.
     *
     * Generated from protobuf field <code>.google.analytics.data.v1alpha.FunnelSubReport funnel_visualization = 2;</code>
     * @return \Google\Analytics\Data\V1alpha\FunnelSubReport|null
     */
    public function getFunnelVisualization()
    {
        return $this->funnel_visualization;
    }

    public function hasFunnelVisualization()
    {
        return isset($this->funnel_visualization);
    }

    public function clearFunnelVisualization()
    {
        unset($this->funnel_visualization);
    }

    /**
     * The funnel visualization is a report with the funnel step, segment, date,
     * next action dimension, and active users.
     * The segment dimension is only present in this response if a segment was
     * requested. The date dimension is only present in this response if it was
     * requested through the `TRENDED_FUNNEL` funnel type. The next action
     * dimension is only present in the response if it was requested.
     *
     * Generated from protobuf field <code>.google.analytics.data.v1alpha.FunnelSubReport funnel_visualization = 2;</code>
     * @param \Google\Analytics\Data\V1alpha\FunnelSubReport $var
     * @return $this
     */
    public function setFunnelVisualization($var)
    {
        GPBUtil::checkMessage($var, \Google\Analytics\Data\V1alpha\FunnelSubReport::class);
        $this->funnel_visualization = $var;

        return $this;
    }

    /**
     * This Analytics Property's quota state including this request.
     *
     * Generated from protobuf field <code>.google.analytics.data.v1alpha.PropertyQuota property_quota = 3;</code>
     * @return \Google\Analytics\Data\V1alpha\PropertyQuota|null
     */
    public function getPropertyQuota()
    {
        return $this->property_quota;
    }

    public function hasPropertyQuota()
    {
        return isset($this->property_quota);
    }

    public function clearPropertyQuota()
    {
        unset($this->property_quota);
    }

    /**
     * This Analytics Property's quota state including this request.
     *
     * Generated from protobuf field <code>.google.analytics.data.v1alpha.PropertyQuota property_quota = 3;</code>
     * @param \Google\Analytics\Data\V1alpha\PropertyQuota $var
     * @return $this
     */
    public function setPropertyQuota($var)
    {
        GPBUtil::checkMessage($var, \Google\Analytics\Data\V1alpha\PropertyQuota::class);
        $this->property_quota = $var;

        return $this;
    }

    /**
     * Identifies what kind of resource this message is. This `kind` is always the
     * fixed string "analyticsData#runFunnelReport". Useful to distinguish between
     * response types in JSON.
     *
     * Generated from protobuf field <code>string kind = 4;</code>
     * @return string
     */
    public function getKind()
    {
        return $this->kind;
    }

    /**
     * Identifies what kind of resource this message is. This `kind` is always the
     * fixed string "analyticsData#runFunnelReport". Useful to distinguish between
     * response types in JSON.
     *
     * Generated from protobuf field <code>string kind = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setKind($var)
    {
        GPBUtil::checkString($var, True);
        $this->kind = $var;

        return $this;
    }

}

