Documentation

CheckinStatus
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CheckinStatus Class Doc Comment

Tags
category

Class

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
STATUS_CANCELLED  : mixed = 'CANCELLED'
STATUS_DONE  : mixed = 'DONE'
STATUS_FAILED  : mixed = 'FAILED'
STATUS_PENDING  : mixed = 'PENDING'
STATUS_RUNNING  : mixed = 'RUNNING'

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
getAttempts()  : int|null
Gets attempts
getEnqueuedAt()  : string|null
Gets enqueued_at
getError()  : ErrorResponse|null
Gets error
getErrorUuid()  : string|null
Gets error_uuid
getFilename()  : string|null
Gets filename
getFinishedAt()  : string|null
Gets finished_at
getJobUuid()  : string|null
Gets job_uuid
getModelName()  : string
The original name of the model.
getNodeUuid()  : string|null
Gets node_uuid
getProgress()  : int|null
Gets progress
getStartedAt()  : string|null
Gets started_at
getStatus()  : string|null
Gets status
getStatusAllowableValues()  : 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)
getValidation()  : array<string, mixed>|null
Gets validation
getVersion()  : Version|null
Gets version
getVersionUuid()  : string|null
Gets version_uuid
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
setAttempts()  : self
Sets attempts
setEnqueuedAt()  : self
Sets enqueued_at
setError()  : self
Sets error
setErrorUuid()  : self
Sets error_uuid
setFilename()  : self
Sets filename
setFinishedAt()  : self
Sets finished_at
setJobUuid()  : self
Sets job_uuid
setNodeUuid()  : self
Sets node_uuid
setProgress()  : self
Sets progress
setStartedAt()  : self
Sets started_at
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setValidation()  : self
Sets validation
setVersion()  : self
Sets version
setVersionUuid()  : self
Sets version_uuid
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

STATUS_CANCELLED

public mixed STATUS_CANCELLED = 'CANCELLED'

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 = ['job_uuid' => 'job_uuid', 'status' => 'status', 'progress' => 'progress', 'node_uuid' => 'node_uuid', 'filename' => 'filename', 'attempts' => 'attempts', 'enqueued_at' => 'enqueued_at', 'started_at' => 'started_at', 'finished_at' => 'finished_at', 'version_uuid' => 'version_uuid', 'version' => 'version', 'validation' => 'validation', 'error' => 'error', 'error_uuid' => 'error_uuid']

$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 = ['job_uuid' => 'getJobUuid', 'status' => 'getStatus', 'progress' => 'getProgress', 'node_uuid' => 'getNodeUuid', 'filename' => 'getFilename', 'attempts' => 'getAttempts', 'enqueued_at' => 'getEnqueuedAt', 'started_at' => 'getStartedAt', 'finished_at' => 'getFinishedAt', 'version_uuid' => 'getVersionUuid', 'version' => 'getVersion', 'validation' => 'getValidation', 'error' => 'getError', 'error_uuid' => 'getErrorUuid']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['job_uuid' => 'uuid', 'status' => null, 'progress' => null, 'node_uuid' => 'uuid', 'filename' => null, 'attempts' => null, 'enqueued_at' => null, 'started_at' => null, 'finished_at' => null, 'version_uuid' => 'uuid', 'version' => null, 'validation' => null, 'error' => null, 'error_uuid' => 'uuid']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'CheckinStatus'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['job_uuid' => false, 'status' => false, 'progress' => false, 'node_uuid' => false, 'filename' => false, 'attempts' => false, 'enqueued_at' => false, 'started_at' => false, 'finished_at' => false, 'version_uuid' => false, 'version' => false, 'validation' => false, 'error' => false, 'error_uuid' => 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 = ['job_uuid' => 'string', 'status' => 'string', 'progress' => 'int', 'node_uuid' => 'string', 'filename' => 'string', 'attempts' => 'int', 'enqueued_at' => 'string', 'started_at' => 'string', 'finished_at' => 'string', 'version_uuid' => 'string', 'version' => '\BIMworks\Model\Version', 'validation' => 'array<string,mixed>', 'error' => '\BIMworks\Model\ErrorResponse', 'error_uuid' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['job_uuid' => 'setJobUuid', 'status' => 'setStatus', 'progress' => 'setProgress', 'node_uuid' => 'setNodeUuid', 'filename' => 'setFilename', 'attempts' => 'setAttempts', 'enqueued_at' => 'setEnqueuedAt', 'started_at' => 'setStartedAt', 'finished_at' => 'setFinishedAt', 'version_uuid' => 'setVersionUuid', 'version' => 'setVersion', 'validation' => 'setValidation', 'error' => 'setError', 'error_uuid' => 'setErrorUuid']

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>

getAttempts()

Gets attempts

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

getEnqueuedAt()

Gets enqueued_at

public getEnqueuedAt() : string|null
Return values
string|null

getErrorUuid()

Gets error_uuid

public getErrorUuid() : string|null
Return values
string|null

getFilename()

Gets filename

public getFilename() : string|null
Return values
string|null

getFinishedAt()

Gets finished_at

public getFinishedAt() : string|null
Return values
string|null

getJobUuid()

Gets job_uuid

public getJobUuid() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getNodeUuid()

Gets node_uuid

public getNodeUuid() : string|null
Return values
string|null

getProgress()

Gets progress

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

getStartedAt()

Gets started_at

public getStartedAt() : string|null
Return values
string|null

getStatus()

Gets status

public getStatus() : string|null
Return values
string|null

getStatusAllowableValues()

Gets allowable values of the enum

public getStatusAllowableValues() : 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>

getValidation()

Gets validation

public getValidation() : array<string, mixed>|null
Return values
array<string, mixed>|null

getVersionUuid()

Gets version_uuid

public getVersionUuid() : string|null
Return values
string|null

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>

setAttempts()

Sets attempts

public setAttempts(int|null $attempts) : self
Parameters
$attempts : int|null

How often a server started it (a server that went away mid-checkin is retried once)

Return values
self

setEnqueuedAt()

Sets enqueued_at

public setEnqueuedAt(string|null $enqueued_at) : self
Parameters
$enqueued_at : string|null

UTC, ISO 8601

Return values
self

setErrorUuid()

Sets error_uuid

public setErrorUuid(string|null $error_uuid) : self
Parameters
$error_uuid : string|null

FAILED only, the error record of the Node (ListNodeErrors, GetValidationReport)

Return values
self

setFilename()

Sets filename

public setFilename(string|null $filename) : self
Parameters
$filename : string|null

filename

Return values
self

setFinishedAt()

Sets finished_at

public setFinishedAt(string|null $finished_at) : self
Parameters
$finished_at : string|null

UTC, ISO 8601

Return values
self

setJobUuid()

Sets job_uuid

public setJobUuid(string|null $job_uuid) : self
Parameters
$job_uuid : string|null

job_uuid

Return values
self

setNodeUuid()

Sets node_uuid

public setNodeUuid(string|null $node_uuid) : self
Parameters
$node_uuid : string|null

The model (Node) the checkin is for

Return values
self

setProgress()

Sets progress

public setProgress(int|null $progress) : self
Parameters
$progress : int|null

Percent

Return values
self

setStartedAt()

Sets started_at

public setStartedAt(string|null $started_at) : self
Parameters
$started_at : string|null

UTC, ISO 8601

Return values
self

setStatus()

Sets status

public setStatus(string|null $status) : self
Parameters
$status : string|null

status

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>

setValidation()

Sets validation

public setValidation(array<string, mixed>|null $validation) : self
Parameters
$validation : array<string, mixed>|null

The validation summary, when there is one (the report is GetValidationReport)

Return values
self

setVersion()

Sets version

public setVersion(Version|null $version) : self
Parameters
$version : Version|null

DONE only, when this server has it already

Return values
self

setVersionUuid()

Sets version_uuid

public setVersionUuid(string|null $version_uuid) : self
Parameters
$version_uuid : string|null

DONE only

Return values
self

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