@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
64 lines (63 loc) • 2 kB
TypeScript
/**
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
* This product includes software developed at Datadog (https://www.datadoghq.com/).
* Copyright 2020-Present Datadog, Inc.
*/
import { LogsListRequestTime } from "./LogsListRequestTime";
import { LogsSort } from "./LogsSort";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
* Object to send with the request to retrieve a list of logs from your Organization.
*/
export declare class LogsListRequest {
/**
* The log index on which the request is performed. For multi-index organizations,
* the default is all live indexes. Historical indexes of rehydrated logs must be specified.
*/
"index"?: string;
/**
* Number of logs return in the response.
*/
"limit"?: number;
/**
* The search query - following the log search syntax.
*/
"query"?: string;
/**
* Time-ascending `asc` or time-descending `desc` results.
*/
"sort"?: LogsSort;
/**
* Hash identifier of the first log to return in the list, available in a log `id` attribute.
* This parameter is used for the pagination feature.
*
* **Note**: This parameter is ignored if the corresponding log
* is out of the scope of the specified time window.
*/
"startAt"?: string;
/**
* Timeframe to retrieve the log from.
*/
"time": LogsListRequestTime;
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
"additionalProperties"?: {
[key: string]: any;
};
/**
* @ignore
*/
"_unparsed"?: boolean;
/**
* @ignore
*/
static readonly attributeTypeMap: AttributeTypeMap;
/**
* @ignore
*/
static getAttributeTypeMap(): AttributeTypeMap;
constructor();
}