Documentation

AuditLogEventDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

AuditLogEventDto Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

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
getAction()  : string
Gets action
getActorUserId()  : string|null
Gets actor_user_id
getDt()  : string|null
Gets dt
getEventId()  : string
Gets event_id
getEventTs()  : DateTime
Gets event_ts
getIpAddress()  : string|null
Gets ip_address
getMetadataJson()  : string|null
Gets metadata_json
getModelName()  : string
The original name of the model.
getOutcome()  : string|null
Gets outcome
getRequestId()  : string|null
Gets request_id
getResourceId()  : string|null
Gets resource_id
getResourceType()  : string|null
Gets resource_type
getTargetUserId()  : string|null
Gets target_user_id
getTenantId()  : string
Gets tenant_id
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUserId()  : string|null
Gets user_id
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
setAction()  : self
Sets action
setActorUserId()  : self
Sets actor_user_id
setDt()  : self
Sets dt
setEventId()  : self
Sets event_id
setEventTs()  : self
Sets event_ts
setIpAddress()  : self
Sets ip_address
setMetadataJson()  : self
Sets metadata_json
setOutcome()  : self
Sets outcome
setRequestId()  : self
Sets request_id
setResourceId()  : self
Sets resource_id
setResourceType()  : self
Sets resource_type
setTargetUserId()  : self
Sets target_user_id
setTenantId()  : self
Sets tenant_id
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUserId()  : self
Sets user_id
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 = ['tenant_id' => 'tenantId', 'dt' => 'dt', 'event_id' => 'eventId', 'event_ts' => 'eventTs', 'action' => 'action', 'user_id' => 'userId', 'actor_user_id' => 'actorUserId', 'target_user_id' => 'targetUserId', 'resource_type' => 'resourceType', 'resource_id' => 'resourceId', 'outcome' => 'outcome', 'request_id' => 'requestId', 'ip_address' => 'ipAddress', 'metadata_json' => 'metadataJson']

$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 = ['tenant_id' => 'getTenantId', 'dt' => 'getDt', 'event_id' => 'getEventId', 'event_ts' => 'getEventTs', 'action' => 'getAction', 'user_id' => 'getUserId', 'actor_user_id' => 'getActorUserId', 'target_user_id' => 'getTargetUserId', 'resource_type' => 'getResourceType', 'resource_id' => 'getResourceId', 'outcome' => 'getOutcome', 'request_id' => 'getRequestId', 'ip_address' => 'getIpAddress', 'metadata_json' => 'getMetadataJson']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['tenant_id' => null, 'dt' => null, 'event_id' => null, 'event_ts' => 'date-time', 'action' => null, 'user_id' => null, 'actor_user_id' => null, 'target_user_id' => null, 'resource_type' => null, 'resource_id' => null, 'outcome' => null, 'request_id' => null, 'ip_address' => null, 'metadata_json' => 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 = 'AuditLogEventDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['tenant_id' => false, 'dt' => true, 'event_id' => false, 'event_ts' => false, 'action' => false, 'user_id' => true, 'actor_user_id' => true, 'target_user_id' => true, 'resource_type' => true, 'resource_id' => true, 'outcome' => true, 'request_id' => true, 'ip_address' => true, 'metadata_json' => true]

$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 = ['tenant_id' => 'string', 'dt' => 'string', 'event_id' => 'string', 'event_ts' => '\\DateTime', 'action' => 'string', 'user_id' => 'string', 'actor_user_id' => 'string', 'target_user_id' => 'string', 'resource_type' => 'string', 'resource_id' => 'string', 'outcome' => 'string', 'request_id' => 'string', 'ip_address' => 'string', 'metadata_json' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['tenant_id' => 'setTenantId', 'dt' => 'setDt', 'event_id' => 'setEventId', 'event_ts' => 'setEventTs', 'action' => 'setAction', 'user_id' => 'setUserId', 'actor_user_id' => 'setActorUserId', 'target_user_id' => 'setTargetUserId', 'resource_type' => 'setResourceType', 'resource_id' => 'setResourceId', 'outcome' => 'setOutcome', 'request_id' => 'setRequestId', 'ip_address' => 'setIpAddress', 'metadata_json' => 'setMetadataJson']

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> —

getAction()

Gets action

public getAction() : string
Return values
string —

getActorUserId()

Gets actor_user_id

public getActorUserId() : string|null
Return values
string|null —

getDt()

Gets dt

public getDt() : string|null
Return values
string|null —

getEventId()

Gets event_id

public getEventId() : string
Return values
string —

getEventTs()

Gets event_ts

public getEventTs() : DateTime
Return values
DateTime —

getIpAddress()

Gets ip_address

public getIpAddress() : string|null
Return values
string|null —

getMetadataJson()

Gets metadata_json

public getMetadataJson() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getOutcome()

Gets outcome

public getOutcome() : string|null
Return values
string|null —

getRequestId()

Gets request_id

public getRequestId() : string|null
Return values
string|null —

getResourceId()

Gets resource_id

public getResourceId() : string|null
Return values
string|null —

getResourceType()

Gets resource_type

public getResourceType() : string|null
Return values
string|null —

getTargetUserId()

Gets target_user_id

public getTargetUserId() : string|null
Return values
string|null —

getTenantId()

Gets tenant_id

public getTenantId() : string
Return values
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> —

getUserId()

Gets user_id

public getUserId() : 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 $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> —

setAction()

Sets action

public setAction(string $action) : self
Parameters
$action : string

action

Return values
self —

setActorUserId()

Sets actor_user_id

public setActorUserId(string|null $actor_user_id) : self
Parameters
$actor_user_id : string|null

actor_user_id

Return values
self —

setDt()

Sets dt

public setDt(string|null $dt) : self
Parameters
$dt : string|null

dt

Return values
self —

setEventId()

Sets event_id

public setEventId(string $event_id) : self
Parameters
$event_id : string

event_id

Return values
self —

setEventTs()

Sets event_ts

public setEventTs(DateTime $event_ts) : self
Parameters
$event_ts : DateTime

event_ts

Return values
self —

setIpAddress()

Sets ip_address

public setIpAddress(string|null $ip_address) : self
Parameters
$ip_address : string|null

ip_address

Return values
self —

setMetadataJson()

Sets metadata_json

public setMetadataJson(string|null $metadata_json) : self
Parameters
$metadata_json : string|null

metadata_json

Return values
self —

setOutcome()

Sets outcome

public setOutcome(string|null $outcome) : self
Parameters
$outcome : string|null

outcome

Return values
self —

setRequestId()

Sets request_id

public setRequestId(string|null $request_id) : self
Parameters
$request_id : string|null

request_id

Return values
self —

setResourceId()

Sets resource_id

public setResourceId(string|null $resource_id) : self
Parameters
$resource_id : string|null

resource_id

Return values
self —

setResourceType()

Sets resource_type

public setResourceType(string|null $resource_type) : self
Parameters
$resource_type : string|null

resource_type

Return values
self —

setTargetUserId()

Sets target_user_id

public setTargetUserId(string|null $target_user_id) : self
Parameters
$target_user_id : string|null

target_user_id

Return values
self —

setTenantId()

Sets tenant_id

public setTenantId(string $tenant_id) : self
Parameters
$tenant_id : string

tenant_id

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> —

setUserId()

Sets user_id

public setUserId(string|null $user_id) : self
Parameters
$user_id : string|null

user_id

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
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>
Return values
void —

Search results