chirpstack/api/php/generated/Chirpstack/Api/ListTenantsRequest.php

<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: api/tenant.proto

namespace Chirpstack\Api;

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

/**
 * Generated from protobuf message <code>api.ListTenantsRequest</code>
 */
class ListTenantsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Max number of tenants to return in the result-set.
     *
     * Generated from protobuf field <code>uint32 limit = 1;</code>
     */
    protected $limit = 0;
    /**
     * Offset in the result-set (for pagination).
     *
     * Generated from protobuf field <code>uint32 offset = 2;</code>
     */
    protected $offset = 0;
    /**
     * If set, the given string will be used to search on name.
     *
     * Generated from protobuf field <code>string search = 3;</code>
     */
    protected $search = '';
    /**
     * If set, filters the result set to the tenants of the user.
     * Only global API keys are able to filter by this field.
     *
     * Generated from protobuf field <code>string user_id = 4;</code>
     */
    protected $user_id = '';

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type int $limit
     *           Max number of tenants to return in the result-set.
     *     @type int $offset
     *           Offset in the result-set (for pagination).
     *     @type string $search
     *           If set, the given string will be used to search on name.
     *     @type string $user_id
     *           If set, filters the result set to the tenants of the user.
     *           Only global API keys are able to filter by this field.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Chirpstack\Api\Tenant::initOnce();
        parent::__construct($data);
    }

    /**
     * Max number of tenants to return in the result-set.
     *
     * Generated from protobuf field <code>uint32 limit = 1;</code>
     * @return int
     */
    public function getLimit()
    {
        return $this->limit;
    }

    /**
     * Max number of tenants to return in the result-set.
     *
     * Generated from protobuf field <code>uint32 limit = 1;</code>
     * @param int $var
     * @return $this
     */
    public function setLimit($var)
    {
        GPBUtil::checkUint32($var);
        $this->limit = $var;

        return $this;
    }

    /**
     * Offset in the result-set (for pagination).
     *
     * Generated from protobuf field <code>uint32 offset = 2;</code>
     * @return int
     */
    public function getOffset()
    {
        return $this->offset;
    }

    /**
     * Offset in the result-set (for pagination).
     *
     * Generated from protobuf field <code>uint32 offset = 2;</code>
     * @param int $var
     * @return $this
     */
    public function setOffset($var)
    {
        GPBUtil::checkUint32($var);
        $this->offset = $var;

        return $this;
    }

    /**
     * If set, the given string will be used to search on name.
     *
     * Generated from protobuf field <code>string search = 3;</code>
     * @return string
     */
    public function getSearch()
    {
        return $this->search;
    }

    /**
     * If set, the given string will be used to search on name.
     *
     * Generated from protobuf field <code>string search = 3;</code>
     * @param string $var
     * @return $this
     */
    public function setSearch($var)
    {
        GPBUtil::checkString($var, True);
        $this->search = $var;

        return $this;
    }

    /**
     * If set, filters the result set to the tenants of the user.
     * Only global API keys are able to filter by this field.
     *
     * Generated from protobuf field <code>string user_id = 4;</code>
     * @return string
     */
    public function getUserId()
    {
        return $this->user_id;
    }

    /**
     * If set, filters the result set to the tenants of the user.
     * Only global API keys are able to filter by this field.
     *
     * Generated from protobuf field <code>string user_id = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setUserId($var)
    {
        GPBUtil::checkString($var, True);
        $this->user_id = $var;

        return $this;
    }

}