AgentApiErrorDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AgentApiErrorDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- $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, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- 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)
- __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
- getDetails() : array<string, object>
- Gets details
- getMessage() : string
- Gets message
- getModelName() : string
- The original name of the model.
- getRequestId() : string
- Gets request_id
- getRetryable() : bool
- Gets retryable
- getSuggestedAction() : string|null
- Gets suggested_action
- 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
- setDetails() : self
- Sets details
- setMessage() : self
- Sets message
- setRequestId() : self
- Sets request_id
- setRetryable() : self
- Sets retryable
- setSuggestedAction() : self
- Sets suggested_action
- 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
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
= ['code' => 'code', 'message' => 'message', 'retryable' => 'retryable', 'suggested_action' => 'suggestedAction', 'request_id' => 'requestId', 'details' => 'details']
$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
= ['code' => 'getCode', 'message' => 'getMessage', 'retryable' => 'getRetryable', 'suggested_action' => 'getSuggestedAction', 'request_id' => 'getRequestId', 'details' => 'getDetails']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['code' => null, 'message' => null, 'retryable' => null, 'suggested_action' => null, 'request_id' => null, 'details' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AgentApiErrorDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['code' => false, 'message' => false, 'retryable' => false, 'suggested_action' => true, 'request_id' => false, 'details' => false]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['code' => 'string', 'message' => 'string', 'retryable' => 'bool', 'suggested_action' => 'string', 'request_id' => 'string', 'details' => 'array<string,object>']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['code' => 'setCode', 'message' => 'setMessage', 'retryable' => 'setRetryable', 'suggested_action' => 'setSuggestedAction', 'request_id' => 'setRequestId', 'details' => 'setDetails']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__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> —getCode()
Gets code
public
getCode() : string
Return values
string —getDetails()
Gets details
public
getDetails() : array<string, object>
Return values
array<string, object> —getMessage()
Gets message
public
getMessage() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRequestId()
Gets request_id
public
getRequestId() : string
Return values
string —getRetryable()
Gets retryable
public
getRetryable() : bool
Return values
bool —getSuggestedAction()
Gets suggested_action
public
getSuggestedAction() : string|null
Return values
string|null —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 —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
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 $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
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
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —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> —setCode()
Sets code
public
setCode(string $code) : self
Parameters
- $code : string
-
code
Return values
self —setDetails()
Sets details
public
setDetails(array<string, object> $details) : self
Parameters
- $details : array<string, object>
-
details
Return values
self —setMessage()
Sets message
public
setMessage(string $message) : self
Parameters
- $message : string
-
message
Return values
self —setRequestId()
Sets request_id
public
setRequestId(string $request_id) : self
Parameters
- $request_id : string
-
request_id
Return values
self —setRetryable()
Sets retryable
public
setRetryable(bool $retryable) : self
Parameters
- $retryable : bool
-
retryable
Return values
self —setSuggestedAction()
Sets suggested_action
public
setSuggestedAction(string|null $suggested_action) : self
Parameters
- $suggested_action : string|null
-
suggested_action
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
Return values
void —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>