forge-dashboard-sdk-php

ActionError

in package

• ForgeDashboard
• Generated

implements ModelInterface, ArrayAccess, JsonSerializable

ActionError Class Doc Comment

Tags

category

Class

description

The structured result of a refused pull request action (Merge, Close, Update branch, Enable auto-merge, Dependabot and Renovate rebase). `code` and `message` are what a client should act on and show.

author

OpenAPI Generator team

link

https://openapi-generator.tech

implements

Table of Contents

Interfaces

ModelInterface

Interface abstracting model access.

ArrayAccess

JsonSerializable

Constants

CODE_ALREADY_CLOSED  : mixed = 'already_closed'

CODE_ALREADY_MERGED  : mixed = 'already_merged'

CODE_ALREADY_UP_TO_DATE  : mixed = 'already_up_to_date'

CODE_AUTO_MERGE_NOT_ALLOWED  : mixed = 'auto_merge_not_allowed'

CODE_BEHIND  : mixed = 'behind'

CODE_BLOCKED_BY_PROTECTION  : mixed = 'blocked_by_protection'

CODE_CHECKS_FAILING  : mixed = 'checks_failing'

CODE_CHECKS_PENDING  : mixed = 'checks_pending'

CODE_CONFLICT  : mixed = 'conflict'

CODE_NOT_MERGEABLE  : mixed = 'not_mergeable'

CODE_PERMISSION  : mixed = 'permission'

CODE_RATE_LIMITED  : mixed = 'rate_limited'

CODE_READY_TO_MERGE  : mixed = 'ready_to_merge'

CODE_UNKNOWN  : mixed = 'unknown'

DISCRIMINATOR  : mixed = null

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

getCode()  : string

Gets code

getCodeAllowableValues()  : array<string|int, string>

Gets allowable values of the enum

getError()  : string

Gets error

getMessage()  : string

Gets message

getModelName()  : string

The original name of the model.

getResetsAt()  : DateTime|null

Gets resets_at

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

setCode()  : self

Sets code

setError()  : self

Sets error

setMessage()  : self

Sets message

setResetsAt()  : self

Sets resets_at

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