/**
 * Copyright 2022 Splunk, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"): you may
 * not use this file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Splunk Search service
 * Use the Search service in Splunk Cloud Services to dispatch, review, and manage searches and search jobs. You can finalize or cancel jobs, retrieve search results, and request search-related configurations from the Metadata Catalog service in Splunk Cloud Services.
 *
 * OpenAPI spec version: v3alpha1
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
/**
 * The parameters for single-statement search. If fields are omitted, those fields are filled in with system defaults or \"defaults\" parameters defined in the request.
 * @export
 * @interface SingleStatementQueryParameters
 */
export interface SingleStatementQueryParameters {
    /**
     * Specifies whether a search that contains commands with side effects (with possible security risks) is allowed to run. The search contains commands, thru or into, that have side effects.
     * @type {boolean}
     * @memberof SingleStatementQueryParameters
     */
    allowSideEffects?: boolean;
    /**
     * Specifies whether a search is allowed to collect the Fields summary during the run time.
     * @type {boolean}
     * @memberof SingleStatementQueryParameters
     */
    collectFieldSummary?: boolean;
    /**
     * Specifies whether a search is allowed to collect the Timeline Buckets summary during the run time.
     * @type {boolean}
     * @memberof SingleStatementQueryParameters
     */
    collectTimeBuckets?: boolean;
    /**
     * The earliest time, in absolute or relative format, to retrieve events. When specifying an absolute time specify either UNIX time, or UTC in seconds using the ISO-8601 (%FT%T.%Q) format. For example 2020-01-25T13:15:30Z. GMT is the default timezone. You must specify GMT when you specify UTC. Any offset specified is ignored.
     * @type {string}
     * @memberof SingleStatementQueryParameters
     */
    earliest?: string;
    /**
     * Specifies whether a search is allowed to collect the preview results during the run time.
     * @type {boolean}
     * @memberof SingleStatementQueryParameters
     */
    enablePreview?: boolean;
    /**
     * Specifies how the Search service should extract fields. Valid values include 'all', 'none', or 'indexed'. 'all' extracts all fields, 'indexed' extracts only indexed fields, and 'none' extracts only the default fields.
     * @type {string}
     * @memberof SingleStatementQueryParameters
     */
    extractFields?: string;
    /**
     * The latest time, in absolute or relative format, to retrieve events. When specifying an absolute time specify either UNIX time, or UTC in seconds using the ISO-8601 (%FT%T.%Q) format. For example 2020-01-25T13:15:30Z. GMT is the default timezone. You must specify GMT when you specify UTC. Any offset specified is ignored.
     * @type {string}
     * @memberof SingleStatementQueryParameters
     */
    latest?: string;
    /**
     * The number of seconds to run the search before finalizing the search. The maximum value is 3600 seconds (1 hour).
     * @type {number}
     * @memberof SingleStatementQueryParameters
     */
    maxTime?: number;
    /**
     * Relative values for the 'earliest' and 'latest' parameters snap to the unit that you specify. For example, if 'earliest' is set to -d@d, the unit is day. If the 'relativeTimeAnchor' is is set to '2020-10-05T13:15:30Z' then 'resolvedEarliest' is snapped to '2020-10-05T00:00:00Z', which is the day. Hours, minutes, and seconds are dropped. If no 'relativeTimeAnchor' is specified, the default value is set to the time the search job was created.
     * @type {string}
     * @memberof SingleStatementQueryParameters
     */
    relativeTimeAnchor?: string;
    /**
     * Reuse the results from the previous search ID (sid) for the statement. For customized default queryParameters, the sid is ignored.
     * @type {string}
     * @memberof SingleStatementQueryParameters
     */
    sid?: string;
    /**
     * The timezone that relative time specifiers are based off of. Timezone only applies to relative time literals for 'earliest' and 'latest'. If UNIX time or UTC format is used for 'earliest' and 'latest', this field is ignored. For the list of supported timezone formats, see https://docs.splunk.com/Documentation/Splunk/latest/Data/Applytimezoneoffsetstotimestamps#zoneinfo_.28TZ.29_database type: string default: \"GMT\"
     * @type {any}
     * @memberof SingleStatementQueryParameters
     */
    timezone?: any;
    /**
     * dynamic keys capturing additional key/value pairs for this model
     * @memberof SingleStatementQueryParameters
     */
    [additionalProperty: string]: any;
}