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

namespace Google\Analytics\Data\V1alpha\OrderBy;

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

/**
 * Sorts by a pivot column group.
 *
 * Generated from protobuf message <code>google.analytics.data.v1alpha.OrderBy.PivotOrderBy</code>
 */
class PivotOrderBy extends \Google\Protobuf\Internal\Message
{
    /**
     * In the response to order by, order rows by this column. Must be a metric
     * name from the request.
     *
     * Generated from protobuf field <code>string metric_name = 1;</code>
     */
    private $metric_name = '';
    /**
     * Used to select a dimension name and value pivot. If multiple pivot
     * selections are given, the sort occurs on rows where all pivot selection
     * dimension name and value pairs match the row's dimension name and value
     * pair.
     *
     * Generated from protobuf field <code>repeated .google.analytics.data.v1alpha.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;</code>
     */
    private $pivot_selections;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $metric_name
     *           In the response to order by, order rows by this column. Must be a metric
     *           name from the request.
     *     @type \Google\Analytics\Data\V1alpha\OrderBy\PivotOrderBy\PivotSelection[]|\Google\Protobuf\Internal\RepeatedField $pivot_selections
     *           Used to select a dimension name and value pivot. If multiple pivot
     *           selections are given, the sort occurs on rows where all pivot selection
     *           dimension name and value pairs match the row's dimension name and value
     *           pair.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Analytics\Data\V1Alpha\Data::initOnce();
        parent::__construct($data);
    }

    /**
     * In the response to order by, order rows by this column. Must be a metric
     * name from the request.
     *
     * Generated from protobuf field <code>string metric_name = 1;</code>
     * @return string
     */
    public function getMetricName()
    {
        return $this->metric_name;
    }

    /**
     * In the response to order by, order rows by this column. Must be a metric
     * name from the request.
     *
     * Generated from protobuf field <code>string metric_name = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setMetricName($var)
    {
        GPBUtil::checkString($var, True);
        $this->metric_name = $var;

        return $this;
    }

    /**
     * Used to select a dimension name and value pivot. If multiple pivot
     * selections are given, the sort occurs on rows where all pivot selection
     * dimension name and value pairs match the row's dimension name and value
     * pair.
     *
     * Generated from protobuf field <code>repeated .google.analytics.data.v1alpha.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getPivotSelections()
    {
        return $this->pivot_selections;
    }

    /**
     * Used to select a dimension name and value pivot. If multiple pivot
     * selections are given, the sort occurs on rows where all pivot selection
     * dimension name and value pairs match the row's dimension name and value
     * pair.
     *
     * Generated from protobuf field <code>repeated .google.analytics.data.v1alpha.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;</code>
     * @param \Google\Analytics\Data\V1alpha\OrderBy\PivotOrderBy\PivotSelection[]|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setPivotSelections($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Analytics\Data\V1alpha\OrderBy\PivotOrderBy\PivotSelection::class);
        $this->pivot_selections = $arr;

        return $this;
    }

}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PivotOrderBy::class, \Google\Analytics\Data\V1alpha\OrderBy_PivotOrderBy::class);

