EventMetadata
extends RequestMetadata
in package
RequestMetadata with an optional `timestampMillis` referencing when a security event took place.
Table of Contents
- $customFields : array<string|int, string>
- $iclFields : IclFields
- $tenantId : string
- $timestampMillis : int
- __construct() : mixed
- getPostData() : array<string|int, mixed>
- Gets an associative array of data that can be serialized and sent to the Tenant Security Proxy.
- getTenantId() : string
- Gets the ID of the tenant making the request.
- getTimestampMillis() : int
- Gets the timestampMillis.
Properties
$customFields
private
array<string|int, string>
$customFields
Optional additional information for the Tenant Security Proxy to log.
$iclFields
private
IclFields
$iclFields
Metadata about the request for the Tenant Security Proxy to log.
$tenantId
private
string
$tenantId
Unique ID of tenant that is performing the operation.
$timestampMillis
private
int
$timestampMillis
Linux epoch millis of when the event occurred.
Methods
__construct()
public
__construct(string $tenantId, IclFields $iclFields, array<string|int, string> $customFields[, int $timestampMillis = null ]) : mixed
Parameters
- $tenantId : string
-
Unique ID of tenant that is performing the operation
- $iclFields : IclFields
-
Metadata about the request for the Tenant Security Proxy to log
- $customFields : array<string|int, string>
-
Optional additional information for the Tenant Security Proxy to log
- $timestampMillis : int = null
-
Linux epoch millis of when the event occurred. If this isn't passed, now will be assumed.
Return values
mixed —getPostData()
Gets an associative array of data that can be serialized and sent to the Tenant Security Proxy.
public
getPostData() : array<string|int, mixed>
Return values
array<string|int, mixed> —Data to send to the Tenant Security Proxy.
getTenantId()
Gets the ID of the tenant making the request.
public
getTenantId() : string
Return values
string —Tenant ID making the request
getTimestampMillis()
Gets the timestampMillis.
public
getTimestampMillis() : int
Return values
int —Linux epoch millis of when the event occurred.