// tslint:disable
/**
 * 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.
 *
 * Metadata Catalog
 * With the Metadata Catalog you can create and manage knowledge objects such as datasets, fields, rules, actions, dashboards, and workflows.
 *
 * OpenAPI spec version: v2alpha2.6 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import {
    FieldPOST,
    LookupDatasetExternalKind,
    LookupDatasetKind,
} from './';

/**
 * Initial property values for creating a new lookup dataset using a POST request.
 * @export
 * @interface LookupDatasetPOST
 */
export interface LookupDatasetPOST {
    /**
     * 
     * @type {LookupDatasetExternalKind}
     * @memberof LookupDatasetPOST
     */
    externalKind: LookupDatasetExternalKind;

    /**
     * The name of the external lookup.
     * @type {string}
     * @memberof LookupDatasetPOST
     */
    externalName: string;

    /**
     * 
     * @type {LookupDatasetKind}
     * @memberof LookupDatasetPOST
     */
    kind: LookupDatasetKind;

    /**
     * The dataset name. Dataset names must be unique within each module.
     * @type {string}
     * @memberof LookupDatasetPOST
     */
    name: string;

    /**
     * Match case-sensitively against the lookup.
     * @type {boolean}
     * @memberof LookupDatasetPOST
     */
    caseSensitiveMatch?: boolean;

    /**
     * The fields to be associated with this dataset.
     * @type {Array<FieldPOST>}
     * @memberof LookupDatasetPOST
     */
    fields?: Array<FieldPOST>;

    /**
     * A query that filters results out of the lookup before those results are returned.
     * @type {string}
     * @memberof LookupDatasetPOST
     */
    filter?: string;

    /**
     * A unique dataset ID. Random ID used if not provided.
     * @type {string}
     * @memberof LookupDatasetPOST
     */
    id?: string;

    /**
     * The name of the module to create the new dataset in.
     * @type {string}
     * @memberof LookupDatasetPOST
     */
    module?: string;

}