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

namespace Google\Ads\AdManager\V1;

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

/**
 * Request object for `ListCompanies` method.
 *
 * Generated from protobuf message <code>google.ads.admanager.v1.ListCompaniesRequest</code>
 */
class ListCompaniesRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The parent, which owns this collection of Companies.
     * Format: `networks/{network_code}`
     *
     * 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 `Companies` to return. The service may
     * return fewer than this value. If unspecified, at most 50 `Companies` 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 `ListCompanies` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListCompanies` 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. Expression to filter the response.
     * See syntax details at
     * https://developers.google.com/ad-manager/api/beta/filters
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $filter = '';
    /**
     * Optional. Expression to specify sorting order.
     * See syntax details at
     * https://developers.google.com/ad-manager/api/beta/filters#order
     *
     * Generated from protobuf field <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $order_by = '';
    /**
     * Optional. Number of individual resources to skip while paginating.
     *
     * Generated from protobuf field <code>int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $skip = 0;

    /**
     * @param string $parent Required. The parent, which owns this collection of Companies.
     *                       Format: `networks/{network_code}`
     *                       Please see {@see CompanyServiceClient::networkName()} for help formatting this field.
     *
     * @return \Google\Ads\AdManager\V1\ListCompaniesRequest
     *
     * @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, which owns this collection of Companies.
     *           Format: `networks/{network_code}`
     *     @type int $page_size
     *           Optional. The maximum number of `Companies` to return. The service may
     *           return fewer than this value. If unspecified, at most 50 `Companies` 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 `ListCompanies` call.
     *           Provide this to retrieve the subsequent page.
     *           When paginating, all other parameters provided to `ListCompanies` must
     *           match the call that provided the page token.
     *     @type string $filter
     *           Optional. Expression to filter the response.
     *           See syntax details at
     *           https://developers.google.com/ad-manager/api/beta/filters
     *     @type string $order_by
     *           Optional. Expression to specify sorting order.
     *           See syntax details at
     *           https://developers.google.com/ad-manager/api/beta/filters#order
     *     @type int $skip
     *           Optional. Number of individual resources to skip while paginating.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Ads\Admanager\V1\CompanyService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The parent, which owns this collection of Companies.
     * Format: `networks/{network_code}`
     *
     * 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, which owns this collection of Companies.
     * Format: `networks/{network_code}`
     *
     * 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 `Companies` to return. The service may
     * return fewer than this value. If unspecified, at most 50 `Companies` 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 `Companies` to return. The service may
     * return fewer than this value. If unspecified, at most 50 `Companies` 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 `ListCompanies` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListCompanies` 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 `ListCompanies` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListCompanies` 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. Expression to filter the response.
     * See syntax details at
     * https://developers.google.com/ad-manager/api/beta/filters
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Optional. Expression to filter the response.
     * See syntax details at
     * https://developers.google.com/ad-manager/api/beta/filters
     *
     * 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. Expression to specify sorting order.
     * See syntax details at
     * https://developers.google.com/ad-manager/api/beta/filters#order
     *
     * 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. Expression to specify sorting order.
     * See syntax details at
     * https://developers.google.com/ad-manager/api/beta/filters#order
     *
     * 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. Number of individual resources to skip while paginating.
     *
     * Generated from protobuf field <code>int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return int
     */
    public function getSkip()
    {
        return $this->skip;
    }

    /**
     * Optional. Number of individual resources to skip while paginating.
     *
     * Generated from protobuf field <code>int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param int $var
     * @return $this
     */
    public function setSkip($var)
    {
        GPBUtil::checkInt32($var);
        $this->skip = $var;

        return $this;
    }

}

