openstatus.status_page.v1.ListSubscribersRequest
*/
class ListSubscribersRequest extends \Google\Protobuf\Internal\Message
{
/**
* ID of the status page to list subscribers for (required).
*
* Generated from protobuf field string page_id = 1 [json_name = "pageId", (.buf.validate.field) = {
*/
protected $page_id = '';
/**
* Maximum number of subscribers to return (1-100, defaults to 50).
*
* Generated from protobuf field optional int32 limit = 2 [json_name = "limit", (.buf.validate.field) = {
*/
protected $limit = null;
/**
* Number of subscribers to skip for pagination (defaults to 0).
*
* Generated from protobuf field optional int32 offset = 3 [json_name = "offset", (.buf.validate.field) = {
*/
protected $offset = null;
/**
* Whether to include unsubscribed users (defaults to false).
*
* Generated from protobuf field optional bool include_unsubscribed = 4 [json_name = "includeUnsubscribed"];
*/
protected $include_unsubscribed = null;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $page_id
* ID of the status page to list subscribers for (required).
* @type int $limit
* Maximum number of subscribers to return (1-100, defaults to 50).
* @type int $offset
* Number of subscribers to skip for pagination (defaults to 0).
* @type bool $include_unsubscribed
* Whether to include unsubscribed users (defaults to false).
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Openstatus\StatusPage\V1\Service::initOnce();
parent::__construct($data);
}
/**
* ID of the status page to list subscribers for (required).
*
* Generated from protobuf field string page_id = 1 [json_name = "pageId", (.buf.validate.field) = {
* @return string
*/
public function getPageId()
{
return $this->page_id;
}
/**
* ID of the status page to list subscribers for (required).
*
* Generated from protobuf field string page_id = 1 [json_name = "pageId", (.buf.validate.field) = {
* @param string $var
* @return $this
*/
public function setPageId(string $var)
{
GPBUtil::checkString($var, true);
$this->page_id = $var;
return $this;
}
/**
* Maximum number of subscribers to return (1-100, defaults to 50).
*
* Generated from protobuf field optional int32 limit = 2 [json_name = "limit", (.buf.validate.field) = {
* @return int
*/
public function getLimit()
{
return isset($this->limit) ? $this->limit : 0;
}
public function hasLimit()
{
return isset($this->limit);
}
public function clearLimit()
{
unset($this->limit);
}
/**
* Maximum number of subscribers to return (1-100, defaults to 50).
*
* Generated from protobuf field optional int32 limit = 2 [json_name = "limit", (.buf.validate.field) = {
* @param int $var
* @return $this
*/
public function setLimit(int $var)
{
GPBUtil::checkInt32($var);
$this->limit = $var;
return $this;
}
/**
* Number of subscribers to skip for pagination (defaults to 0).
*
* Generated from protobuf field optional int32 offset = 3 [json_name = "offset", (.buf.validate.field) = {
* @return int
*/
public function getOffset()
{
return isset($this->offset) ? $this->offset : 0;
}
public function hasOffset()
{
return isset($this->offset);
}
public function clearOffset()
{
unset($this->offset);
}
/**
* Number of subscribers to skip for pagination (defaults to 0).
*
* Generated from protobuf field optional int32 offset = 3 [json_name = "offset", (.buf.validate.field) = {
* @param int $var
* @return $this
*/
public function setOffset(int $var)
{
GPBUtil::checkInt32($var);
$this->offset = $var;
return $this;
}
/**
* Whether to include unsubscribed users (defaults to false).
*
* Generated from protobuf field optional bool include_unsubscribed = 4 [json_name = "includeUnsubscribed"];
* @return bool
*/
public function getIncludeUnsubscribed()
{
return isset($this->include_unsubscribed) ? $this->include_unsubscribed : false;
}
public function hasIncludeUnsubscribed()
{
return isset($this->include_unsubscribed);
}
public function clearIncludeUnsubscribed()
{
unset($this->include_unsubscribed);
}
/**
* Whether to include unsubscribed users (defaults to false).
*
* Generated from protobuf field optional bool include_unsubscribed = 4 [json_name = "includeUnsubscribed"];
* @param bool $var
* @return $this
*/
public function setIncludeUnsubscribed(bool $var)
{
$this->include_unsubscribed = $var;
return $this;
}
}