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

namespace Google\Cloud\NetworkConnectivity\V1;

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

/**
 * The request for
 * [HubService.QueryHubStatus][google.cloud.networkconnectivity.v1.HubService.QueryHubStatus].
 *
 * Generated from protobuf message <code>google.cloud.networkconnectivity.v1.QueryHubStatusRequest</code>
 */
class QueryHubStatusRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The name of the hub.
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $name = '';
    /**
     * Optional. The maximum number of results to return per page.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_size = 0;
    /**
     * Optional. The page token.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_token = '';
    /**
     * Optional. An expression that filters the list of results.
     * The filter can be used to filter the results by the following fields:
     *   * `psc_propagation_status.source_spoke`
     *   * `psc_propagation_status.source_group`
     *   * `psc_propagation_status.source_forwarding_rule`
     *   * `psc_propagation_status.target_spoke`
     *   * `psc_propagation_status.target_group`
     *   * `psc_propagation_status.code`
     *   * `psc_propagation_status.message`
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $filter = '';
    /**
     * Optional. Sort the results in ascending order by the specified fields.
     * A comma-separated list of any of these fields:
     *   * `psc_propagation_status.source_spoke`
     *   * `psc_propagation_status.source_group`
     *   * `psc_propagation_status.source_forwarding_rule`
     *   * `psc_propagation_status.target_spoke`
     *   * `psc_propagation_status.target_group`
     *   * `psc_propagation_status.code`
     * If `group_by` is set, the value of the `order_by` field must be the
     * same as or a subset of the `group_by` field.
     *
     * Generated from protobuf field <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $order_by = '';
    /**
     * Optional. Aggregate the results by the specified fields.
     * A comma-separated list of any of these fields:
     *   * `psc_propagation_status.source_spoke`
     *   * `psc_propagation_status.source_group`
     *   * `psc_propagation_status.source_forwarding_rule`
     *   * `psc_propagation_status.target_spoke`
     *   * `psc_propagation_status.target_group`
     *   * `psc_propagation_status.code`
     *
     * Generated from protobuf field <code>string group_by = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $group_by = '';

    /**
     * @param string $name Required. The name of the hub. Please see
     *                     {@see HubServiceClient::hubName()} for help formatting this field.
     *
     * @return \Google\Cloud\NetworkConnectivity\V1\QueryHubStatusRequest
     *
     * @experimental
     */
    public static function build(string $name): self
    {
        return (new self())
            ->setName($name);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           Required. The name of the hub.
     *     @type int $page_size
     *           Optional. The maximum number of results to return per page.
     *     @type string $page_token
     *           Optional. The page token.
     *     @type string $filter
     *           Optional. An expression that filters the list of results.
     *           The filter can be used to filter the results by the following fields:
     *             * `psc_propagation_status.source_spoke`
     *             * `psc_propagation_status.source_group`
     *             * `psc_propagation_status.source_forwarding_rule`
     *             * `psc_propagation_status.target_spoke`
     *             * `psc_propagation_status.target_group`
     *             * `psc_propagation_status.code`
     *             * `psc_propagation_status.message`
     *     @type string $order_by
     *           Optional. Sort the results in ascending order by the specified fields.
     *           A comma-separated list of any of these fields:
     *             * `psc_propagation_status.source_spoke`
     *             * `psc_propagation_status.source_group`
     *             * `psc_propagation_status.source_forwarding_rule`
     *             * `psc_propagation_status.target_spoke`
     *             * `psc_propagation_status.target_group`
     *             * `psc_propagation_status.code`
     *           If `group_by` is set, the value of the `order_by` field must be the
     *           same as or a subset of the `group_by` field.
     *     @type string $group_by
     *           Optional. Aggregate the results by the specified fields.
     *           A comma-separated list of any of these fields:
     *             * `psc_propagation_status.source_spoke`
     *             * `psc_propagation_status.source_group`
     *             * `psc_propagation_status.source_forwarding_rule`
     *             * `psc_propagation_status.target_spoke`
     *             * `psc_propagation_status.target_group`
     *             * `psc_propagation_status.code`
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Networkconnectivity\V1\Hub::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The name of the hub.
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Required. The name of the hub.
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * Optional. The maximum number of results to return per page.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * Optional. The maximum number of results to return per page.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param int $var
     * @return $this
     */
    public function setPageSize($var)
    {
        GPBUtil::checkInt32($var);
        $this->page_size = $var;

        return $this;
    }

    /**
     * Optional. The page token.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * Optional. The page token.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setPageToken($var)
    {
        GPBUtil::checkString($var, True);
        $this->page_token = $var;

        return $this;
    }

    /**
     * Optional. An expression that filters the list of results.
     * The filter can be used to filter the results by the following fields:
     *   * `psc_propagation_status.source_spoke`
     *   * `psc_propagation_status.source_group`
     *   * `psc_propagation_status.source_forwarding_rule`
     *   * `psc_propagation_status.target_spoke`
     *   * `psc_propagation_status.target_group`
     *   * `psc_propagation_status.code`
     *   * `psc_propagation_status.message`
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Optional. An expression that filters the list of results.
     * The filter can be used to filter the results by the following fields:
     *   * `psc_propagation_status.source_spoke`
     *   * `psc_propagation_status.source_group`
     *   * `psc_propagation_status.source_forwarding_rule`
     *   * `psc_propagation_status.target_spoke`
     *   * `psc_propagation_status.target_group`
     *   * `psc_propagation_status.code`
     *   * `psc_propagation_status.message`
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

    /**
     * Optional. Sort the results in ascending order by the specified fields.
     * A comma-separated list of any of these fields:
     *   * `psc_propagation_status.source_spoke`
     *   * `psc_propagation_status.source_group`
     *   * `psc_propagation_status.source_forwarding_rule`
     *   * `psc_propagation_status.target_spoke`
     *   * `psc_propagation_status.target_group`
     *   * `psc_propagation_status.code`
     * If `group_by` is set, the value of the `order_by` field must be the
     * same as or a subset of the `group_by` field.
     *
     * Generated from protobuf field <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getOrderBy()
    {
        return $this->order_by;
    }

    /**
     * Optional. Sort the results in ascending order by the specified fields.
     * A comma-separated list of any of these fields:
     *   * `psc_propagation_status.source_spoke`
     *   * `psc_propagation_status.source_group`
     *   * `psc_propagation_status.source_forwarding_rule`
     *   * `psc_propagation_status.target_spoke`
     *   * `psc_propagation_status.target_group`
     *   * `psc_propagation_status.code`
     * If `group_by` is set, the value of the `order_by` field must be the
     * same as or a subset of the `group_by` field.
     *
     * Generated from protobuf field <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setOrderBy($var)
    {
        GPBUtil::checkString($var, True);
        $this->order_by = $var;

        return $this;
    }

    /**
     * Optional. Aggregate the results by the specified fields.
     * A comma-separated list of any of these fields:
     *   * `psc_propagation_status.source_spoke`
     *   * `psc_propagation_status.source_group`
     *   * `psc_propagation_status.source_forwarding_rule`
     *   * `psc_propagation_status.target_spoke`
     *   * `psc_propagation_status.target_group`
     *   * `psc_propagation_status.code`
     *
     * Generated from protobuf field <code>string group_by = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getGroupBy()
    {
        return $this->group_by;
    }

    /**
     * Optional. Aggregate the results by the specified fields.
     * A comma-separated list of any of these fields:
     *   * `psc_propagation_status.source_spoke`
     *   * `psc_propagation_status.source_group`
     *   * `psc_propagation_status.source_forwarding_rule`
     *   * `psc_propagation_status.target_spoke`
     *   * `psc_propagation_status.target_group`
     *   * `psc_propagation_status.code`
     *
     * Generated from protobuf field <code>string group_by = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setGroupBy($var)
    {
        GPBUtil::checkString($var, True);
        $this->group_by = $var;

        return $this;
    }

}

