Documentation

GetValidationReportRequest
in package
implements ModelInterface, ArrayAccess, JsonSerializable

GetValidationReportRequest 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
MIN_SEVERITY_ERROR  : mixed = 'ERROR'
MIN_SEVERITY_FATAL  : mixed = 'FATAL'
MIN_SEVERITY_INFO  : mixed = 'INFO'
MIN_SEVERITY_WARNING  : mixed = 'WARNING'

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
getExpressId()  : int|null
Gets express_id
getGlobalId()  : string|null
Gets global_id
getMinSeverity()  : string|null
Gets min_severity
getMinSeverityAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getModel()  : ModelIdentifier|null
Gets model
getModelName()  : string
The original name of the model.
getRule()  : array<string|int, string>|null
Gets rule
getStage()  : string|null
Gets stage
getSummaryOnly()  : bool|null
Gets summary_only
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
setErrorUuid()  : self
Sets error_uuid
setExpressId()  : self
Sets express_id
setGlobalId()  : self
Sets global_id
setMinSeverity()  : self
Sets min_severity
setModel()  : self
Sets model
setRule()  : self
Sets rule
setStage()  : self
Sets stage
setSummaryOnly()  : self
Sets summary_only
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

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 = ['model' => 'model', 'error_uuid' => 'error_uuid', 'summary_only' => 'summary_only', 'min_severity' => 'min_severity', 'stage' => 'stage', 'rule' => 'rule', 'global_id' => 'global_id', 'express_id' => 'express_id']

$getters

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

protected static array<string|int, string> $getters = ['model' => 'getModel', 'error_uuid' => 'getErrorUuid', 'summary_only' => 'getSummaryOnly', 'min_severity' => 'getMinSeverity', 'stage' => 'getStage', 'rule' => 'getRule', 'global_id' => 'getGlobalId', 'express_id' => 'getExpressId']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['model' => null, 'error_uuid' => 'uuid', 'summary_only' => null, 'min_severity' => null, 'stage' => null, 'rule' => null, 'global_id' => null, 'express_id' => 'int64']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'GetValidationReportRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['model' => false, 'error_uuid' => false, 'summary_only' => false, 'min_severity' => false, 'stage' => false, 'rule' => false, 'global_id' => false, 'express_id' => 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 = ['model' => '\BIMworks\Model\ModelIdentifier', 'error_uuid' => 'string', 'summary_only' => 'bool', 'min_severity' => 'string', 'stage' => 'string', 'rule' => 'string[]', 'global_id' => 'string', 'express_id' => 'int']

$setters

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

protected static array<string|int, string> $setters = ['model' => 'setModel', 'error_uuid' => 'setErrorUuid', 'summary_only' => 'setSummaryOnly', 'min_severity' => 'setMinSeverity', 'stage' => 'setStage', 'rule' => 'setRule', 'global_id' => 'setGlobalId', 'express_id' => 'setExpressId']

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

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>

getMinSeverityAllowableValues()

Gets allowable values of the enum

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

getRule()

Gets rule

public getRule() : array<string|int, string>|null
Return values
array<string|int, 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

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

A failed checkin instead, from ListNodeErrors

Return values
self

setExpressId()

Sets express_id

public setExpressId(int|null $express_id) : self
Parameters
$express_id : int|null

Only findings about this STEP line

Return values
self

setGlobalId()

Sets global_id

public setGlobalId(string|null $global_id) : self
Parameters
$global_id : string|null

Only findings about this object

Return values
self

setMinSeverity()

Sets min_severity

public setMinSeverity(string|null $min_severity) : self
Parameters
$min_severity : string|null

Only findings of this severity or worse

Return values
self

setRule()

Sets rule

public setRule(array<string|int, string>|null $rule) : self
Parameters
$rule : array<string|int, string>|null

Only these rules

Return values
self

setStage()

Sets stage

public setStage(string|null $stage) : self
Parameters
$stage : string|null

Only this stage

Return values
self

setSummaryOnly()

Sets summary_only

public setSummaryOnly(bool|null $summary_only) : self
Parameters
$summary_only : bool|null

Only the summary

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

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