Class ArchiveSearchCreateRequestAttributes

Attributes accepted when creating an Archive Search.

Hierarchy

  • ArchiveSearchCreateRequestAttributes

Constructors

constructor

Properties

additionalProperties? archiveId description? from name query rehydration? to

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

archiveId

archiveId: string

ID of the archive to search. Use the Logs Archives API to list the archives of the organization.

Optional description

description?: string

Free-text description of the Archive Search.

from

from: Date

Start of the time range to search, as an ISO 8601 timestamp.

name

name: string

Name of the Archive Search.

query

query: string

Log search query used to filter the archived logs.

Optional rehydration

rehydration?: ArchiveSearchCreateRehydration

Rehydration settings. Include this object to index the matched logs into a retained historical view. Omit it to run an Archive Search that only scans the archive.

to

to: Date

End of the time range to search, as an ISO 8601 timestamp. Must be after from.

Settings

Member Visibility

Theme

Generated using TypeDoc