Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/openstatusHQ/sdk-php. php sdk for openstatus www.openstatus.dev
Something went wrong. Try again.
21 kB · 653 lines
PHP
at main
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654<?php# Generated by the protocol buffer compiler. DO NOT EDIT!# NO CHECKED-IN PROTOBUF GENCODE# source: openstatus/status_page/v1/service.proto
namespace Openstatus\Status_page\V1;
use Google\Protobuf\Internal\GPBType;use Google\Protobuf\Internal\GPBUtil;use Google\Protobuf\RepeatedField;
/** * CreateStatusPageRequest is the request to create a new status page. * * Generated from protobuf message <code>openstatus.status_page.v1.CreateStatusPageRequest</code> */class CreateStatusPageRequest extends \Google\Protobuf\Internal\Message{ /** * Title of the status page (required). * * Generated from protobuf field <code>string title = 1 [json_name = "title", (.gnostic.openapi.v3.property) = {</code> */ protected $title = ''; /** * Description of the status page (optional). * * Generated from protobuf field <code>optional string description = 2 [json_name = "description", (.buf.validate.field) = {</code> */ protected $description = null; /** * URL-friendly slug for the status page (required). Must be lowercase alphanumeric with hyphens. * * Generated from protobuf field <code>string slug = 3 [json_name = "slug", (.gnostic.openapi.v3.property) = {</code> */ protected $slug = ''; /** * URL to the homepage (optional). * * Generated from protobuf field <code>optional string homepage_url = 4 [json_name = "homepageUrl", (.gnostic.openapi.v3.property) = {</code> */ protected $homepage_url = null; /** * URL to the contact page (optional). * * Generated from protobuf field <code>optional string contact_url = 5 [json_name = "contactUrl"];</code> */ protected $contact_url = null; /** * Default locale for the status page (optional, defaults to EN). * * Generated from protobuf field <code>optional .openstatus.status_page.v1.Locale default_locale = 6 [json_name = "defaultLocale"];</code> */ protected $default_locale = null; /** * Enabled locales for the status page (optional). * * Generated from protobuf field <code>repeated .openstatus.status_page.v1.Locale locales = 7 [json_name = "locales"];</code> */ private $locales; /** * Icon URL for the status page (optional). * * Generated from protobuf field <code>optional string icon = 8 [json_name = "icon", (.buf.validate.field) = {</code> */ protected $icon = null; /** * Custom domain for the status page (optional). * * Generated from protobuf field <code>optional string custom_domain = 9 [json_name = "customDomain", (.buf.validate.field) = {</code> */ protected $custom_domain = null; /** * Visual theme for the status page (optional, defaults to SYSTEM). * * Generated from protobuf field <code>optional .openstatus.status_page.v1.PageTheme theme = 10 [json_name = "theme"];</code> */ protected $theme = null; /** * Access type for the status page (optional, defaults to PUBLIC). * * Generated from protobuf field <code>optional .openstatus.status_page.v1.PageAccessType access_type = 11 [json_name = "accessType"];</code> */ protected $access_type = null; /** * Password for the status page (required when access_type is PASSWORD_PROTECTED). * * Generated from protobuf field <code>optional string password = 12 [json_name = "password", (.buf.validate.field) = {</code> */ protected $password = null; /** * Email domains allowed to access the page (used when access_type is AUTHENTICATED). * * Generated from protobuf field <code>repeated string auth_email_domains = 13 [json_name = "authEmailDomains"];</code> */ private $auth_email_domains; /** * Whether search engines are allowed to index this status page (optional, defaults to true). * * Generated from protobuf field <code>optional bool allow_index = 14 [json_name = "allowIndex"];</code> */ protected $allow_index = null; /** * Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED). * * Generated from protobuf field <code>optional string allowed_ip_ranges = 15 [json_name = "allowedIpRanges"];</code> */ protected $allowed_ip_ranges = null;
/** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $title * Title of the status page (required). * @type string $description * Description of the status page (optional). * @type string $slug * URL-friendly slug for the status page (required). Must be lowercase alphanumeric with hyphens. * @type string $homepage_url * URL to the homepage (optional). * @type string $contact_url * URL to the contact page (optional). * @type int $default_locale * Default locale for the status page (optional, defaults to EN). * @type int[] $locales * Enabled locales for the status page (optional). * @type string $icon * Icon URL for the status page (optional). * @type string $custom_domain * Custom domain for the status page (optional). * @type int $theme * Visual theme for the status page (optional, defaults to SYSTEM). * @type int $access_type * Access type for the status page (optional, defaults to PUBLIC). * @type string $password * Password for the status page (required when access_type is PASSWORD_PROTECTED). * @type string[] $auth_email_domains * Email domains allowed to access the page (used when access_type is AUTHENTICATED). * @type bool $allow_index * Whether search engines are allowed to index this status page (optional, defaults to true). * @type string $allowed_ip_ranges * Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED). * } */ public function __construct($data = NULL) { \GPBMetadata\Openstatus\StatusPage\V1\Service::initOnce(); parent::__construct($data); }
/** * Title of the status page (required). * * Generated from protobuf field <code>string title = 1 [json_name = "title", (.gnostic.openapi.v3.property) = {</code> * @return string */ public function getTitle() { return $this->title; }
/** * Title of the status page (required). * * Generated from protobuf field <code>string title = 1 [json_name = "title", (.gnostic.openapi.v3.property) = {</code> * @param string $var * @return $this */ public function setTitle(string $var) { GPBUtil::checkString($var, true); $this->title = $var;
return $this; }
/** * Description of the status page (optional). * * Generated from protobuf field <code>optional string description = 2 [json_name = "description", (.buf.validate.field) = {</code> * @return string */ public function getDescription() { return isset($this->description) ? $this->description : ''; }
public function hasDescription() { return isset($this->description); }
public function clearDescription() { unset($this->description); }
/** * Description of the status page (optional). * * Generated from protobuf field <code>optional string description = 2 [json_name = "description", (.buf.validate.field) = {</code> * @param string $var * @return $this */ public function setDescription(string $var) { GPBUtil::checkString($var, true); $this->description = $var;
return $this; }
/** * URL-friendly slug for the status page (required). Must be lowercase alphanumeric with hyphens. * * Generated from protobuf field <code>string slug = 3 [json_name = "slug", (.gnostic.openapi.v3.property) = {</code> * @return string */ public function getSlug() { return $this->slug; }
/** * URL-friendly slug for the status page (required). Must be lowercase alphanumeric with hyphens. * * Generated from protobuf field <code>string slug = 3 [json_name = "slug", (.gnostic.openapi.v3.property) = {</code> * @param string $var * @return $this */ public function setSlug(string $var) { GPBUtil::checkString($var, true); $this->slug = $var;
return $this; }
/** * URL to the homepage (optional). * * Generated from protobuf field <code>optional string homepage_url = 4 [json_name = "homepageUrl", (.gnostic.openapi.v3.property) = {</code> * @return string */ public function getHomepageUrl() { return isset($this->homepage_url) ? $this->homepage_url : ''; }
public function hasHomepageUrl() { return isset($this->homepage_url); }
public function clearHomepageUrl() { unset($this->homepage_url); }
/** * URL to the homepage (optional). * * Generated from protobuf field <code>optional string homepage_url = 4 [json_name = "homepageUrl", (.gnostic.openapi.v3.property) = {</code> * @param string $var * @return $this */ public function setHomepageUrl(string $var) { GPBUtil::checkString($var, true); $this->homepage_url = $var;
return $this; }
/** * URL to the contact page (optional). * * Generated from protobuf field <code>optional string contact_url = 5 [json_name = "contactUrl"];</code> * @return string */ public function getContactUrl() { return isset($this->contact_url) ? $this->contact_url : ''; }
public function hasContactUrl() { return isset($this->contact_url); }
public function clearContactUrl() { unset($this->contact_url); }
/** * URL to the contact page (optional). * * Generated from protobuf field <code>optional string contact_url = 5 [json_name = "contactUrl"];</code> * @param string $var * @return $this */ public function setContactUrl(string $var) { GPBUtil::checkString($var, true); $this->contact_url = $var;
return $this; }
/** * Default locale for the status page (optional, defaults to EN). * * Generated from protobuf field <code>optional .openstatus.status_page.v1.Locale default_locale = 6 [json_name = "defaultLocale"];</code> * @return int one of the values in {@see \Openstatus\Status_page\V1\Locale} */ public function getDefaultLocale() { return isset($this->default_locale) ? $this->default_locale : 0; }
public function hasDefaultLocale() { return isset($this->default_locale); }
public function clearDefaultLocale() { unset($this->default_locale); }
/** * Default locale for the status page (optional, defaults to EN). * * Generated from protobuf field <code>optional .openstatus.status_page.v1.Locale default_locale = 6 [json_name = "defaultLocale"];</code> * @param int $var one of the values in {@see \Openstatus\Status_page\V1\Locale} * @return $this */ public function setDefaultLocale(int $var) { GPBUtil::checkEnum($var, \Openstatus\Status_page\V1\Locale::class); $this->default_locale = $var;
return $this; }
/** * Enabled locales for the status page (optional). * * Generated from protobuf field <code>repeated .openstatus.status_page.v1.Locale locales = 7 [json_name = "locales"];</code> * @return RepeatedField<int> one of the values in {@see \Openstatus\Status_page\V1\Locale} */ public function getLocales() { return $this->locales; }
/** * Enabled locales for the status page (optional). * * Generated from protobuf field <code>repeated .openstatus.status_page.v1.Locale locales = 7 [json_name = "locales"];</code> * @param int[] $var one of the values in {@see \Openstatus\Status_page\V1\Locale} * @return $this */ public function setLocales(array|RepeatedField $var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Openstatus\Status_page\V1\Locale::class); $this->locales = $arr;
return $this; }
/** * Icon URL for the status page (optional). * * Generated from protobuf field <code>optional string icon = 8 [json_name = "icon", (.buf.validate.field) = {</code> * @return string */ public function getIcon() { return isset($this->icon) ? $this->icon : ''; }
public function hasIcon() { return isset($this->icon); }
public function clearIcon() { unset($this->icon); }
/** * Icon URL for the status page (optional). * * Generated from protobuf field <code>optional string icon = 8 [json_name = "icon", (.buf.validate.field) = {</code> * @param string $var * @return $this */ public function setIcon(string $var) { GPBUtil::checkString($var, true); $this->icon = $var;
return $this; }
/** * Custom domain for the status page (optional). * * Generated from protobuf field <code>optional string custom_domain = 9 [json_name = "customDomain", (.buf.validate.field) = {</code> * @return string */ public function getCustomDomain() { return isset($this->custom_domain) ? $this->custom_domain : ''; }
public function hasCustomDomain() { return isset($this->custom_domain); }
public function clearCustomDomain() { unset($this->custom_domain); }
/** * Custom domain for the status page (optional). * * Generated from protobuf field <code>optional string custom_domain = 9 [json_name = "customDomain", (.buf.validate.field) = {</code> * @param string $var * @return $this */ public function setCustomDomain(string $var) { GPBUtil::checkString($var, true); $this->custom_domain = $var;
return $this; }
/** * Visual theme for the status page (optional, defaults to SYSTEM). * * Generated from protobuf field <code>optional .openstatus.status_page.v1.PageTheme theme = 10 [json_name = "theme"];</code> * @return int one of the values in {@see \Openstatus\Status_page\V1\PageTheme} */ public function getTheme() { return isset($this->theme) ? $this->theme : 0; }
public function hasTheme() { return isset($this->theme); }
public function clearTheme() { unset($this->theme); }
/** * Visual theme for the status page (optional, defaults to SYSTEM). * * Generated from protobuf field <code>optional .openstatus.status_page.v1.PageTheme theme = 10 [json_name = "theme"];</code> * @param int $var one of the values in {@see \Openstatus\Status_page\V1\PageTheme} * @return $this */ public function setTheme(int $var) { GPBUtil::checkEnum($var, \Openstatus\Status_page\V1\PageTheme::class); $this->theme = $var;
return $this; }
/** * Access type for the status page (optional, defaults to PUBLIC). * * Generated from protobuf field <code>optional .openstatus.status_page.v1.PageAccessType access_type = 11 [json_name = "accessType"];</code> * @return int one of the values in {@see \Openstatus\Status_page\V1\PageAccessType} */ public function getAccessType() { return isset($this->access_type) ? $this->access_type : 0; }
public function hasAccessType() { return isset($this->access_type); }
public function clearAccessType() { unset($this->access_type); }
/** * Access type for the status page (optional, defaults to PUBLIC). * * Generated from protobuf field <code>optional .openstatus.status_page.v1.PageAccessType access_type = 11 [json_name = "accessType"];</code> * @param int $var one of the values in {@see \Openstatus\Status_page\V1\PageAccessType} * @return $this */ public function setAccessType(int $var) { GPBUtil::checkEnum($var, \Openstatus\Status_page\V1\PageAccessType::class); $this->access_type = $var;
return $this; }
/** * Password for the status page (required when access_type is PASSWORD_PROTECTED). * * Generated from protobuf field <code>optional string password = 12 [json_name = "password", (.buf.validate.field) = {</code> * @return string */ public function getPassword() { return isset($this->password) ? $this->password : ''; }
public function hasPassword() { return isset($this->password); }
public function clearPassword() { unset($this->password); }
/** * Password for the status page (required when access_type is PASSWORD_PROTECTED). * * Generated from protobuf field <code>optional string password = 12 [json_name = "password", (.buf.validate.field) = {</code> * @param string $var * @return $this */ public function setPassword(string $var) { GPBUtil::checkString($var, true); $this->password = $var;
return $this; }
/** * Email domains allowed to access the page (used when access_type is AUTHENTICATED). * * Generated from protobuf field <code>repeated string auth_email_domains = 13 [json_name = "authEmailDomains"];</code> * @return RepeatedField<string> */ public function getAuthEmailDomains() { return $this->auth_email_domains; }
/** * Email domains allowed to access the page (used when access_type is AUTHENTICATED). * * Generated from protobuf field <code>repeated string auth_email_domains = 13 [json_name = "authEmailDomains"];</code> * @param string[] $var * @return $this */ public function setAuthEmailDomains(array|RepeatedField $var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->auth_email_domains = $arr;
return $this; }
/** * Whether search engines are allowed to index this status page (optional, defaults to true). * * Generated from protobuf field <code>optional bool allow_index = 14 [json_name = "allowIndex"];</code> * @return bool */ public function getAllowIndex() { return isset($this->allow_index) ? $this->allow_index : false; }
public function hasAllowIndex() { return isset($this->allow_index); }
public function clearAllowIndex() { unset($this->allow_index); }
/** * Whether search engines are allowed to index this status page (optional, defaults to true). * * Generated from protobuf field <code>optional bool allow_index = 14 [json_name = "allowIndex"];</code> * @param bool $var * @return $this */ public function setAllowIndex(bool $var) { $this->allow_index = $var;
return $this; }
/** * Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED). * * Generated from protobuf field <code>optional string allowed_ip_ranges = 15 [json_name = "allowedIpRanges"];</code> * @return string */ public function getAllowedIpRanges() { return isset($this->allowed_ip_ranges) ? $this->allowed_ip_ranges : ''; }
public function hasAllowedIpRanges() { return isset($this->allowed_ip_ranges); }
public function clearAllowedIpRanges() { unset($this->allowed_ip_ranges); }
/** * Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED). * * Generated from protobuf field <code>optional string allowed_ip_ranges = 15 [json_name = "allowedIpRanges"];</code> * @param string $var * @return $this */ public function setAllowedIpRanges(string $var) { GPBUtil::checkString($var, true); $this->allowed_ip_ranges = $var;
return $this; }
}