forge-dashboard-sdk-php

RateLimit
in package
implements ModelInterface, ArrayAccess, JsonSerializable

RateLimit Class Doc Comment

Tags
category

Class

description

One of a forge API's own request budgets for the credential the last refresh used — see ForgeHealth.rateLimitGraphQL/rateLimitREST for which budget this is and when each is (or isn't) reported.

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR  : mixed = null
SEVERITY_EXCEEDED  : mixed = 'exceeded'
SEVERITY_LOW  : mixed = 'low'
SEVERITY_OK  : mixed = 'ok'
SEVERITY_WARNING  : mixed = 'warning'

Properties

$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$openAPIFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string|int, bool>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string|int, bool>
If a nullable field gets set to null, insert it here
$openAPITypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)

Methods

__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getCost()  : int|null
Gets cost
getLimit()  : int
Gets limit
getModelName()  : string
The original name of the model.
getRemaining()  : int
Gets remaining
getResetsAt()  : DateTime
Gets resets_at
getSeverity()  : string
Gets severity
getSeverityAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
isNullable()  : bool
Checks if a property is nullable
isNullableSetToNull()  : bool
Checks if a nullable property is set to null.
jsonSerialize()  : mixed
Serializes the object to a value that can be serialized natively by json_encode().
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed|null
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
openAPIFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
openAPITypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
setCost()  : self
Sets cost
setLimit()  : self
Sets limit
setRemaining()  : self
Sets remaining
setResetsAt()  : self
Sets resets_at
setSeverity()  : self
Sets severity
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
toHeaderValue()  : string
Gets a header-safe presentation of the object
valid()  : bool
Validate all the properties in the model return true if all passed
openAPINullables()  : array<string|int, mixed>
Array of nullable properties
getOpenAPINullablesSetToNull()  : array<string|int, bool>
Array of nullable field names deliberately set to null
setIfExists()  : void
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
setOpenAPINullablesSetToNull()  : void
Setter - Array of nullable field names deliberately set to null

Constants

DISCRIMINATOR

public mixed DISCRIMINATOR = null

SEVERITY_EXCEEDED

public mixed SEVERITY_EXCEEDED = 'exceeded'

SEVERITY_LOW

public mixed SEVERITY_LOW = 'low'

SEVERITY_OK

public mixed SEVERITY_OK = 'ok'

SEVERITY_WARNING

public mixed SEVERITY_WARNING = 'warning'

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['limit' => 'limit', 'remaining' => 'remaining', 'resets_at' => 'resetsAt', 'cost' => 'cost', 'severity' => 'severity']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['limit' => 'getLimit', 'remaining' => 'getRemaining', 'resets_at' => 'getResetsAt', 'cost' => 'getCost', 'severity' => 'getSeverity']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['limit' => null, 'remaining' => null, 'resets_at' => 'date-time', 'cost' => null, 'severity' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'RateLimit'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['limit' => false, 'remaining' => false, 'resets_at' => false, 'cost' => false, 'severity' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string|int, bool> $openAPINullablesSetToNull = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $openAPITypes = ['limit' => 'int', 'remaining' => 'int', 'resets_at' => '\DateTime', 'cost' => 'int', 'severity' => 'string']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['limit' => 'setLimit', 'remaining' => 'setRemaining', 'resets_at' => 'setResetsAt', 'cost' => 'setCost', 'severity' => 'setSeverity']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed>|null $data = null ]) : mixed
Parameters
$data : array<string|int, mixed>|null = null

Associated array of property values initializing the model

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCost()

Gets cost

public getCost() : int|null
Return values
int|null

getLimit()

Gets limit

public getLimit() : int
Return values
int

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getRemaining()

Gets remaining

public getRemaining() : int
Return values
int

getResetsAt()

Gets resets_at

public getResetsAt() : DateTime
Return values
DateTime

getSeverity()

Gets severity

public getSeverity() : string
Return values
string

getSeverityAllowableValues()

Gets allowable values of the enum

public getSeverityAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed>

isNullable()

Checks if a property is nullable

public static isNullable(string $property) : bool
Parameters
$property : string
Return values
bool

isNullableSetToNull()

Checks if a nullable property is set to null.

public isNullableSetToNull(string $property) : bool
Parameters
$property : string
Return values
bool

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int|string $offset) : bool
Parameters
$offset : int|string

Offset

Return values
bool

offsetGet()

Gets offset.

public offsetGet(int|string $offset) : mixed|null
Parameters
$offset : int|string

Offset

Attributes
#[ReturnTypeWillChange]
Return values
mixed|null

offsetSet()

Sets value based on offset.

public offsetSet(int|null $offset, mixed $value) : void
Parameters
$offset : int|null

Offset

$value : mixed

Value to be set

offsetUnset()

Unsets offset.

public offsetUnset(int|string $offset) : void
Parameters
$offset : int|string

Offset

openAPIFormats()

Array of property to format mappings. Used for (de)serialization

public static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>

openAPITypes()

Array of property to type mappings. Used for (de)serialization

public static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

setCost()

Sets cost

public setCost(int|null $cost) : self
Parameters
$cost : int|null

The point price the most recent call was actually charged — GraphQL-specific, since a REST request has no separate cost concept beyond the flat one-request-one-point REST's own budget already counts. Omitted for a REST-sourced RateLimit.

Return values
self

setLimit()

Sets limit

public setLimit(int $limit) : self
Parameters
$limit : int

Requests allowed per window.

Return values
self

setRemaining()

Sets remaining

public setRemaining(int $remaining) : self
Parameters
$remaining : int

Requests left in the current window.

Return values
self

setResetsAt()

Sets resets_at

public setResetsAt(DateTime $resets_at) : self
Parameters
$resets_at : DateTime

When the window resets and remaining goes back to limit.

Return values
self

setSeverity()

Sets severity

public setSeverity(string $severity) : self
Parameters
$severity : string

How worried a client should be about this budget, graded by the server as of the response, so no client needs its own threshold or clock check. exceeded: nothing left and the reset hasn't been seen to pass. low: under 5% left (also a spent budget whose reset time has passed, until the next snapshot says otherwise). warning: under 20% left but not yet low, for a gauge's amber stage; a banner or a lock has no reason to act on it. ok: everything else.

Return values
self

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed>

toHeaderValue()

Gets a header-safe presentation of the object

public toHeaderValue() : string
Return values
string

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

openAPINullables()

Array of nullable properties

protected static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

private getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool>

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array

private setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

private setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string|int, bool>
On this page

Search results