Documentation

DownloadRequest
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DownloadRequest Class Doc Comment

Tags
category

Class

description

A model identifier, with the options of a download next to its fields. A request that holds a model identifier and nothing else is a valid download request. Instead of a model identifier, `error_uuid` names the file of an upload that failed.

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
FORMAT_IFC  : mixed = 'ifc'
FORMAT_IFCXML  : mixed = 'ifcxml'
FORMAT_ORIGINAL  : mixed = 'original'
TYPE_NODE_MODEL_IDENTIFIER  : mixed = 'NodeModelIdentifier'
TYPE_URL_MODEL_IDENTIFIER  : mixed = 'UrlModelIdentifier'
TYPE_VERSION_MODEL_IDENTIFIER  : mixed = 'VersionModelIdentifier'

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
getErrorUuid()  : string|null
Gets error_uuid
getFormat()  : string|null
Gets format
getFormatAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getTargetSchema()  : string|null
Gets target_schema
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getType()  : string|null
Gets type
getTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getUrl()  : string|null
Gets url
getUuid()  : string|null
Gets uuid
getValidate()  : bool|null
Gets validate
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
setErrorUuid()  : self
Sets error_uuid
setFormat()  : self
Sets format
setName()  : self
Sets name
setTargetSchema()  : self
Sets target_schema
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setType()  : self
Sets type
setUrl()  : self
Sets url
setUuid()  : self
Sets uuid
setValidate()  : self
Sets validate
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

TYPE_NODE_MODEL_IDENTIFIER

public mixed TYPE_NODE_MODEL_IDENTIFIER = 'NodeModelIdentifier'

TYPE_URL_MODEL_IDENTIFIER

public mixed TYPE_URL_MODEL_IDENTIFIER = 'UrlModelIdentifier'

TYPE_VERSION_MODEL_IDENTIFIER

public mixed TYPE_VERSION_MODEL_IDENTIFIER = 'VersionModelIdentifier'

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 = ['format' => 'format', 'error_uuid' => 'error_uuid', 'type' => 'type', 'name' => 'name', 'uuid' => 'uuid', 'url' => 'url', 'target_schema' => 'target_schema', 'validate' => 'validate']

$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 = ['format' => 'getFormat', 'error_uuid' => 'getErrorUuid', 'type' => 'getType', 'name' => 'getName', 'uuid' => 'getUuid', 'url' => 'getUrl', 'target_schema' => 'getTargetSchema', 'validate' => 'getValidate']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['format' => null, 'error_uuid' => 'uuid', 'type' => null, 'name' => null, 'uuid' => 'uuid', 'url' => 'uri', 'target_schema' => null, 'validate' => 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 = 'DownloadRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['format' => false, 'error_uuid' => false, 'type' => false, 'name' => false, 'uuid' => false, 'url' => false, 'target_schema' => false, 'validate' => 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 = ['format' => 'string', 'error_uuid' => 'string', 'type' => 'string', 'name' => 'string', 'uuid' => 'string', 'url' => 'string', 'target_schema' => 'string', 'validate' => 'bool']

$setters

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

protected static array<string|int, string> $setters = ['format' => 'setFormat', 'error_uuid' => 'setErrorUuid', 'type' => 'setType', 'name' => 'setName', 'uuid' => 'setUuid', 'url' => 'setUrl', 'target_schema' => 'setTargetSchema', 'validate' => 'setValidate']

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>

getErrorUuid()

Gets error_uuid

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

getFormat()

Gets format

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

getFormatAllowableValues()

Gets allowable values of the enum

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getName()

Gets name

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

getTargetSchema()

Gets target_schema

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

getType()

Gets type

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

getTypeAllowableValues()

Gets allowable values of the enum

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

getUrl()

Gets url

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

getUuid()

Gets uuid

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

getValidate()

Gets validate

public getValidate() : bool|null
Return values
bool|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>

setErrorUuid()

Sets error_uuid

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

Instead of a model identifier, the error of an upload that failed (from ListNodeErrors), whose uploaded file comes back. Needs read rights on its Node

Return values
self

setFormat()

Sets format

public setFormat(string|null $format) : self
Parameters
$format : string|null

original: the file as it was uploaded, byte for byte (a Version made by a transaction has no upload: it is served as ifc); ifc: the model serialized as IFC STEP (application/ifc), whatever the encoding it was uploaded in; ifcxml: the model serialized as ifcXML (application/xml), ISO 10303-28 for IFC2X3 and ifcXML4 for IFC4/IFC4X3. target_schema applies to original and ifc

Return values
self

setName()

Sets name

public setName(string|null $name) : self
Parameters
$name : string|null

Name of the model, see ModelIdentifier

Return values
self

setTargetSchema()

Sets target_schema

public setTargetSchema(string|null $target_schema) : self
Parameters
$target_schema : string|null

The IFC schema to convert the model to, for example IFC4. Absent means the model as it was uploaded

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>

setType()

Sets type

public setType(string|null $type) : self
Parameters
$type : string|null

The kind of model identifier, required unless error_uuid is given

Return values
self

setUrl()

Sets url

public setUrl(string|null $url) : self
Parameters
$url : string|null

The URL of the model (UrlModelIdentifier)

Return values
self

setUuid()

Sets uuid

public setUuid(string|null $uuid) : self
Parameters
$uuid : string|null

The UUID of the Version (VersionModelIdentifier) or of the Node (NodeModelIdentifier)

Return values
self

setValidate()

Sets validate

public setValidate(bool|null $validate) : self
Parameters
$validate : bool|null

Only with target_schema. Whether to run the schema check on the converted file before it is returned, and on the model to compare with. This about doubles the time of a conversion (default: false)

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