<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/ads/datamanager/v1/user_list_global_license_service.proto

namespace Google\Ads\DataManager\V1;

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

/**
 * Request to list all
 * [UserListGlobalLicense][google.ads.datamanager.v1.UserListGlobalLicense]
 * resources for a given account.
 *
 * Generated from protobuf message <code>google.ads.datamanager.v1.ListUserListGlobalLicensesRequest</code>
 */
class ListUserListGlobalLicensesRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The account whose licenses are being queried. Should be in the
     * format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $parent = '';
    /**
     * Optional. A [filter string](https://google.aip.dev/160) to apply to the
     * list request. All fields need to be on the left hand side of each condition
     * (for example: `user_list_id = 123`). Fields must be specified using either
     * all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake
     * case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of
     * camel case and snake case.
     * **Supported Operations:**
     * - `AND`
     * - `=`
     * - `!=`
     * - `>`
     * - `>=`
     * - `<`
     * - `<=`
     * **Unsupported Fields:**
     * - `name` (use get method instead)
     * - `historical_pricings` and all its subfields
     * - `pricing.start_time`
     * - `pricing.end_time`
     *
     * Generated from protobuf field <code>string filter = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $filter = '';
    /**
     * Optional. The maximum number of licenses to return. The service may return
     * fewer than this value. If unspecified, at most 50 licenses will be
     * returned. The maximum value is 1000; values above 1000 will be coerced to
     * 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_size = 0;
    /**
     * Optional. A page token, received from a previous
     * `ListUserListGlobalLicense` call. Provide this to retrieve the subsequent
     * page.
     * When paginating, all other parameters provided to
     * `ListUserListDirectLicense` must match the call that provided the page
     * token.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_token = '';

    /**
     * @param string $parent Required. The account whose licenses are being queried. Should be in the
     *                       format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
     *                       Please see {@see UserListGlobalLicenseServiceClient::accountName()} for help formatting this field.
     *
     * @return \Google\Ads\DataManager\V1\ListUserListGlobalLicensesRequest
     *
     * @experimental
     */
    public static function build(string $parent): self
    {
        return (new self())
            ->setParent($parent);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $parent
     *           Required. The account whose licenses are being queried. Should be in the
     *           format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
     *     @type string $filter
     *           Optional. A [filter string](https://google.aip.dev/160) to apply to the
     *           list request. All fields need to be on the left hand side of each condition
     *           (for example: `user_list_id = 123`). Fields must be specified using either
     *           all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake
     *           case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of
     *           camel case and snake case.
     *           **Supported Operations:**
     *           - `AND`
     *           - `=`
     *           - `!=`
     *           - `>`
     *           - `>=`
     *           - `<`
     *           - `<=`
     *           **Unsupported Fields:**
     *           - `name` (use get method instead)
     *           - `historical_pricings` and all its subfields
     *           - `pricing.start_time`
     *           - `pricing.end_time`
     *     @type int $page_size
     *           Optional. The maximum number of licenses to return. The service may return
     *           fewer than this value. If unspecified, at most 50 licenses will be
     *           returned. The maximum value is 1000; values above 1000 will be coerced to
     *           1000.
     *     @type string $page_token
     *           Optional. A page token, received from a previous
     *           `ListUserListGlobalLicense` call. Provide this to retrieve the subsequent
     *           page.
     *           When paginating, all other parameters provided to
     *           `ListUserListDirectLicense` must match the call that provided the page
     *           token.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Ads\Datamanager\V1\UserListGlobalLicenseService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The account whose licenses are being queried. Should be in the
     * format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @return string
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Required. The account whose licenses are being queried. Should be in the
     * format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @param string $var
     * @return $this
     */
    public function setParent($var)
    {
        GPBUtil::checkString($var, True);
        $this->parent = $var;

        return $this;
    }

    /**
     * Optional. A [filter string](https://google.aip.dev/160) to apply to the
     * list request. All fields need to be on the left hand side of each condition
     * (for example: `user_list_id = 123`). Fields must be specified using either
     * all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake
     * case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of
     * camel case and snake case.
     * **Supported Operations:**
     * - `AND`
     * - `=`
     * - `!=`
     * - `>`
     * - `>=`
     * - `<`
     * - `<=`
     * **Unsupported Fields:**
     * - `name` (use get method instead)
     * - `historical_pricings` and all its subfields
     * - `pricing.start_time`
     * - `pricing.end_time`
     *
     * Generated from protobuf field <code>string filter = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Optional. A [filter string](https://google.aip.dev/160) to apply to the
     * list request. All fields need to be on the left hand side of each condition
     * (for example: `user_list_id = 123`). Fields must be specified using either
     * all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake
     * case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of
     * camel case and snake case.
     * **Supported Operations:**
     * - `AND`
     * - `=`
     * - `!=`
     * - `>`
     * - `>=`
     * - `<`
     * - `<=`
     * **Unsupported Fields:**
     * - `name` (use get method instead)
     * - `historical_pricings` and all its subfields
     * - `pricing.start_time`
     * - `pricing.end_time`
     *
     * Generated from protobuf field <code>string filter = 2 [(.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. The maximum number of licenses to return. The service may return
     * fewer than this value. If unspecified, at most 50 licenses will be
     * returned. The maximum value is 1000; values above 1000 will be coerced to
     * 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * Optional. The maximum number of licenses to return. The service may return
     * fewer than this value. If unspecified, at most 50 licenses will be
     * returned. The maximum value is 1000; values above 1000 will be coerced to
     * 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.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. A page token, received from a previous
     * `ListUserListGlobalLicense` call. Provide this to retrieve the subsequent
     * page.
     * When paginating, all other parameters provided to
     * `ListUserListDirectLicense` must match the call that provided the page
     * token.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * Optional. A page token, received from a previous
     * `ListUserListGlobalLicense` call. Provide this to retrieve the subsequent
     * page.
     * When paginating, all other parameters provided to
     * `ListUserListDirectLicense` must match the call that provided the page
     * token.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.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;
    }

}

