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

namespace Google\Ads\DataManager\V1;

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

/**
 * Request message for ListUserLists.
 *
 * Generated from protobuf message <code>google.ads.datamanager.v1.ListUserListsRequest</code>
 */
class ListUserListsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The parent account which owns this collection of user lists.
     * Format: accountTypes/{account_type}/accounts/{account}
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $parent = '';
    /**
     * Optional. The maximum number of user lists to return. The service may
     * return fewer than this value. If unspecified, at most 50 user lists will be
     * returned. The maximum value is 1000; values above 1000 will be coerced to
     * 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_size = 0;
    /**
     * Optional. A page token, received from a previous `ListUserLists` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListUserLists` must
     * match the call that provided the page token.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_token = '';
    /**
     * Optional. A [filter string](https://google.aip.dev/160). All fields need to
     * be on the left hand side of each condition (for example: `display_name =
     * "list 1"`). 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`
     * - `=`
     * - `!=`
     * - `>`
     * - `>=`
     * - `<`
     * - `<=`
     * - `:` (has)
     * Supported fields:
     * - `id`
     * - `display_name`
     * - `description`
     * - `membership_status`
     * - `integration_code`
     * - `access_reason`
     * - `ingested_user_list_info.upload_key_types`
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $filter = '';

    /**
     * @param string $parent Required. The parent account which owns this collection of user lists.
     *                       Format: accountTypes/{account_type}/accounts/{account}
     *                       Please see {@see UserListServiceClient::accountName()} for help formatting this field.
     *
     * @return \Google\Ads\DataManager\V1\ListUserListsRequest
     *
     * @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 parent account which owns this collection of user lists.
     *           Format: accountTypes/{account_type}/accounts/{account}
     *     @type int $page_size
     *           Optional. The maximum number of user lists to return. The service may
     *           return fewer than this value. If unspecified, at most 50 user lists 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 `ListUserLists` call.
     *           Provide this to retrieve the subsequent page.
     *           When paginating, all other parameters provided to `ListUserLists` must
     *           match the call that provided the page token.
     *     @type string $filter
     *           Optional. A [filter string](https://google.aip.dev/160). All fields need to
     *           be on the left hand side of each condition (for example: `display_name =
     *           "list 1"`). 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`
     *           - `=`
     *           - `!=`
     *           - `>`
     *           - `>=`
     *           - `<`
     *           - `<=`
     *           - `:` (has)
     *           Supported fields:
     *           - `id`
     *           - `display_name`
     *           - `description`
     *           - `membership_status`
     *           - `integration_code`
     *           - `access_reason`
     *           - `ingested_user_list_info.upload_key_types`
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Ads\Datamanager\V1\UserListService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The parent account which owns this collection of user lists.
     * Format: accountTypes/{account_type}/accounts/{account}
     *
     * 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 parent account which owns this collection of user lists.
     * Format: accountTypes/{account_type}/accounts/{account}
     *
     * 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. The maximum number of user lists to return. The service may
     * return fewer than this value. If unspecified, at most 50 user lists will be
     * returned. The maximum value is 1000; values above 1000 will be coerced to
     * 1000.
     *
     * 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 user lists to return. The service may
     * return fewer than this value. If unspecified, at most 50 user lists will be
     * returned. The maximum value is 1000; values above 1000 will be coerced to
     * 1000.
     *
     * 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. A page token, received from a previous `ListUserLists` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListUserLists` must
     * match the call that provided 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. A page token, received from a previous `ListUserLists` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListUserLists` must
     * match the call that provided 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. A [filter string](https://google.aip.dev/160). All fields need to
     * be on the left hand side of each condition (for example: `display_name =
     * "list 1"`). 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`
     * - `=`
     * - `!=`
     * - `>`
     * - `>=`
     * - `<`
     * - `<=`
     * - `:` (has)
     * Supported fields:
     * - `id`
     * - `display_name`
     * - `description`
     * - `membership_status`
     * - `integration_code`
     * - `access_reason`
     * - `ingested_user_list_info.upload_key_types`
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Optional. A [filter string](https://google.aip.dev/160). All fields need to
     * be on the left hand side of each condition (for example: `display_name =
     * "list 1"`). 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`
     * - `=`
     * - `!=`
     * - `>`
     * - `>=`
     * - `<`
     * - `<=`
     * - `:` (has)
     * Supported fields:
     * - `id`
     * - `display_name`
     * - `description`
     * - `membership_status`
     * - `integration_code`
     * - `access_reason`
     * - `ingested_user_list_info.upload_key_types`
     *
     * 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;
    }

}

