Documentation

CreateNodeRequest
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CreateNodeRequest Class Doc Comment

Tags
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

Properties

$attributeMap  : array<string, 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, string>
Array of attributes to getter functions (for serialization of requests)
$openAPIFormats  : array<string, string|null>
Array of property to format mappings. Used for (de)serialization
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string, bool>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string, bool>
If a nullable field gets set to null, insert it here
$openAPITypes  : array<string, string>
Array of property to type mappings. Used for (de)serialization
$setters  : array<string, 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, string>
Array of attributes where the key is the local name, and the value is the original name
getAllowExisting()  : bool|null
Gets allow_existing
getFolder()  : bool
Gets folder
getInputFileType()  : InputFileType|null
Gets input_file_type
getModelName()  : string
The original name of the model.
getName()  : string
Gets name
getParentNodeUuid()  : string|null
Gets parent_node_uuid
getters()  : array<string, string>
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, string>
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, string|null>
Array of property to format mappings. Used for (de)serialization
openAPITypes()  : array<string, string>
Array of property to type mappings. Used for (de)serialization
setAllowExisting()  : $this
Sets allow_existing
setFolder()  : $this
Sets folder
setInputFileType()  : $this
Sets input_file_type
setName()  : $this
Sets name
setParentNodeUuid()  : $this
Sets parent_node_uuid
setters()  : array<string, string>
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, bool>
Array of nullable properties
fillIfExists()  : 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
getOpenAPINullablesSetToNull()  : array<string, bool>
Array of nullable field names deliberately set to null
setOpenAPINullablesSetToNull()  : void
Setter - Array of nullable field names deliberately set to null

Constants

Properties

$attributeMap

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

protected static array<string, string> $attributeMap = ['name' => 'name', 'folder' => 'folder', 'input_file_type' => 'input_file_type', 'parent_node_uuid' => 'parent_node_uuid', 'allow_existing' => 'allow_existing']

$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, string> $getters = ['name' => 'getName', 'folder' => 'getFolder', 'input_file_type' => 'getInputFileType', 'parent_node_uuid' => 'getParentNodeUuid', 'allow_existing' => 'getAllowExisting']

$openAPIFormats

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

protected static array<string, string|null> $openAPIFormats = ['name' => null, 'folder' => null, 'input_file_type' => null, 'parent_node_uuid' => 'uuid', 'allow_existing' => null]

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'CreateNodeRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string, bool> $openAPINullables = ['name' => false, 'folder' => false, 'input_file_type' => false, 'parent_node_uuid' => false, 'allow_existing' => false]

$openAPINullablesSetToNull

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

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

$openAPITypes

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

protected static array<string, string> $openAPITypes = ['name' => 'string', 'folder' => 'bool', 'input_file_type' => '\BIMworks\Model\InputFileType', 'parent_node_uuid' => 'string', 'allow_existing' => 'bool']

$setters

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

protected static array<string, string> $setters = ['name' => 'setName', 'folder' => 'setFolder', 'input_file_type' => 'setInputFileType', 'parent_node_uuid' => 'setParentNodeUuid', 'allow_existing' => 'setAllowExisting']

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

__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, string>
Return values
array<string, string>

getAllowExisting()

Gets allow_existing

public getAllowExisting() : bool|null
Return values
bool|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getParentNodeUuid()

Gets parent_node_uuid

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

getters()

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

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

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, string>
Return values
array<string|int, string> —

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|string|null $offset, mixed $value) : void
Parameters
$offset : int|string|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, string|null>
Return values
array<string, string|null>

openAPITypes()

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

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

setAllowExisting()

Sets allow_existing

public setAllowExisting(bool|null $allow_existing) : $this
Parameters
$allow_existing : bool|null

When true, no exception will be thrown in case the specified Node already exists, the existing Node will be returned. When false, an exception will be thrown when a Node with the given name already exists.

Return values
$this

setFolder()

Sets folder

public setFolder(bool $folder) : $this
Parameters
$folder : bool

folder

Return values
$this

setInputFileType()

Sets input_file_type

public setInputFileType(InputFileType|null $input_file_type) : $this
Parameters
$input_file_type : InputFileType|null

The type of Node, when not provided it assumed to be FOLDER (when folder is true) or IFC (when folder is false)

Return values
$this

setName()

Sets name

public setName(string $name) : $this
Parameters
$name : string

name

Return values
$this

setParentNodeUuid()

Sets parent_node_uuid

public setParentNodeUuid(string|null $parent_node_uuid) : $this
Parameters
$parent_node_uuid : string|null

The UUID of the Node under which to create a new Node. When not specified this defaults to the Root Node of your current auth context

Return values
$this

setters()

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

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

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, bool>
Return values
array<string, bool>

fillIfExists()

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 fillIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

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

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

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

Search results