<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/monitoring/v3/alert_service.proto

namespace Google\Cloud\Monitoring\V3;

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

/**
 * The protocol for the `ListAlertPolicies` request.
 *
 * Generated from protobuf message <code>google.monitoring.v3.ListAlertPoliciesRequest</code>
 */
class ListAlertPoliciesRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * The project whose alert policies are to be listed. The format is
     *     projects/[PROJECT_ID]
     * Note that this field names the parent container in which the alerting
     * policies to be listed are stored. To retrieve a single alerting policy
     * by name, use the
     * [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy]
     * operation, instead.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     */
    private $name = '';
    /**
     * If provided, this field specifies the criteria that must be met by
     * alert policies to be included in the response.
     * For more details, see [sorting and
     * filtering](/monitoring/api/v3/sorting-and-filtering).
     *
     * Generated from protobuf field <code>string filter = 5;</code>
     */
    private $filter = '';
    /**
     * A comma-separated list of fields by which to sort the result. Supports
     * the same set of field references as the `filter` field. Entries can be
     * prefixed with a minus sign to sort by the field in descending order.
     * For more details, see [sorting and
     * filtering](/monitoring/api/v3/sorting-and-filtering).
     *
     * Generated from protobuf field <code>string order_by = 6;</code>
     */
    private $order_by = '';
    /**
     * The maximum number of results to return in a single response.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     */
    private $page_size = 0;
    /**
     * If this field is not empty then it must contain the `nextPageToken` value
     * returned by a previous call to this method.  Using this field causes the
     * method to return more results from the previous method call.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     */
    private $page_token = '';

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           The project whose alert policies are to be listed. The format is
     *               projects/[PROJECT_ID]
     *           Note that this field names the parent container in which the alerting
     *           policies to be listed are stored. To retrieve a single alerting policy
     *           by name, use the
     *           [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy]
     *           operation, instead.
     *     @type string $filter
     *           If provided, this field specifies the criteria that must be met by
     *           alert policies to be included in the response.
     *           For more details, see [sorting and
     *           filtering](/monitoring/api/v3/sorting-and-filtering).
     *     @type string $order_by
     *           A comma-separated list of fields by which to sort the result. Supports
     *           the same set of field references as the `filter` field. Entries can be
     *           prefixed with a minus sign to sort by the field in descending order.
     *           For more details, see [sorting and
     *           filtering](/monitoring/api/v3/sorting-and-filtering).
     *     @type int $page_size
     *           The maximum number of results to return in a single response.
     *     @type string $page_token
     *           If this field is not empty then it must contain the `nextPageToken` value
     *           returned by a previous call to this method.  Using this field causes the
     *           method to return more results from the previous method call.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Monitoring\V3\AlertService::initOnce();
        parent::__construct($data);
    }

    /**
     * The project whose alert policies are to be listed. The format is
     *     projects/[PROJECT_ID]
     * Note that this field names the parent container in which the alerting
     * policies to be listed are stored. To retrieve a single alerting policy
     * by name, use the
     * [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy]
     * operation, instead.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * The project whose alert policies are to be listed. The format is
     *     projects/[PROJECT_ID]
     * Note that this field names the parent container in which the alerting
     * policies to be listed are stored. To retrieve a single alerting policy
     * by name, use the
     * [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy]
     * operation, instead.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * If provided, this field specifies the criteria that must be met by
     * alert policies to be included in the response.
     * For more details, see [sorting and
     * filtering](/monitoring/api/v3/sorting-and-filtering).
     *
     * Generated from protobuf field <code>string filter = 5;</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * If provided, this field specifies the criteria that must be met by
     * alert policies to be included in the response.
     * For more details, see [sorting and
     * filtering](/monitoring/api/v3/sorting-and-filtering).
     *
     * Generated from protobuf field <code>string filter = 5;</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

    /**
     * A comma-separated list of fields by which to sort the result. Supports
     * the same set of field references as the `filter` field. Entries can be
     * prefixed with a minus sign to sort by the field in descending order.
     * For more details, see [sorting and
     * filtering](/monitoring/api/v3/sorting-and-filtering).
     *
     * Generated from protobuf field <code>string order_by = 6;</code>
     * @return string
     */
    public function getOrderBy()
    {
        return $this->order_by;
    }

    /**
     * A comma-separated list of fields by which to sort the result. Supports
     * the same set of field references as the `filter` field. Entries can be
     * prefixed with a minus sign to sort by the field in descending order.
     * For more details, see [sorting and
     * filtering](/monitoring/api/v3/sorting-and-filtering).
     *
     * Generated from protobuf field <code>string order_by = 6;</code>
     * @param string $var
     * @return $this
     */
    public function setOrderBy($var)
    {
        GPBUtil::checkString($var, True);
        $this->order_by = $var;

        return $this;
    }

    /**
     * The maximum number of results to return in a single response.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * The maximum number of results to return in a single response.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     * @param int $var
     * @return $this
     */
    public function setPageSize($var)
    {
        GPBUtil::checkInt32($var);
        $this->page_size = $var;

        return $this;
    }

    /**
     * If this field is not empty then it must contain the `nextPageToken` value
     * returned by a previous call to this method.  Using this field causes the
     * method to return more results from the previous method call.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * If this field is not empty then it must contain the `nextPageToken` value
     * returned by a previous call to this method.  Using this field causes the
     * method to return more results from the previous method call.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     * @param string $var
     * @return $this
     */
    public function setPageToken($var)
    {
        GPBUtil::checkString($var, True);
        $this->page_token = $var;

        return $this;
    }

}

