/**
 * ThoughtSpot Public REST API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * OpenAPI spec version: 2.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { ExcludeMetadataListItemInput } from '../models/ExcludeMetadataListItemInput';
import { FavoriteObjectOptionsInput } from '../models/FavoriteObjectOptionsInput';
import { LiveboardDetailsInput } from '../models/LiveboardDetailsInput';
import { MetadataListItemInput } from '../models/MetadataListItemInput';
import { MetadataSearchSortOptions } from '../models/MetadataSearchSortOptions';
import { PermissionInput } from '../models/PermissionInput';
import { HttpFile } from '../http/http';

export class SearchMetadataRequest {
    /**
    * Metadata objects such as Liveboards, Answers, and Worksheets.
    */
    'metadata'?: Array<MetadataListItemInput>;
    /**
    * Object permission details to search by.
    */
    'permissions'?: Array<PermissionInput>;
    /**
    * GUID or name of user who created the metadata object.
    */
    'created_by_user_identifiers'?: Array<string>;
    /**
    * Version of the dependent table of the metadata objects like Worksheets.
    */
    'dependent_object_version'?: SearchMetadataRequestDependentObjectVersionEnum;
    /**
    * List of metadata objects to exclude from search.
    */
    'exclude_objects'?: Array<ExcludeMetadataListItemInput>;
    /**
    * Options to sort the API response by objects set as favorites for the logged-in user or the users specified in the API request.
    */
    'favorite_object_options'?: FavoriteObjectOptionsInput;
    /**
    * Includes system-generated metadata objects.
    */
    'include_auto_created_objects'?: boolean | null;
    /**
    * Includes dependents of the metadata object specified in the API request. For example, a worksheet can consist of dependent objects such as Liveboards or Answers.
    */
    'include_dependent_objects'?: boolean | null;
    /**
    * The maximum number of dependents to include per metadata object.
    */
    'dependent_objects_record_size'?: number;
    /**
    * Includes complete details of the metadata objects.
    */
    'include_details'?: boolean | null;
    /**
    * When set to true and include_details is also true, includes personalised views in the metadata_detail for LIVEBOARD objects. Personalised views are also included when liveboard_details.personalized_views is true.
    */
    'include_personalised_views'?: boolean | null;
    /**
    * <div>Version: 26.10.0.cl or later </div>  Selects which parts of a Liveboard\'s `metadata_detail` are returned, so that a request can skip the parts it does not need.  Applies only to `LIVEBOARD` objects, and only when `include_details` is `true` and `liveboard_response_version` is `V2`. Otherwise it is ignored.  * `liveboard_filters`, `liveboard_tabs`, `container_layouts`, `visualizations`, `parameter_overrides`: default to `true`. Set a field to `false` to exclude that part of the Liveboard. * `personalized_views`: defaults to `false`. Personalised views are included when either this field or `include_personalised_views` is `true`.  The Liveboard header, type, and style are always returned. Excluded collections are returned empty.  To fetch only the personalised views of a Liveboard, set every other field to `false`. The Liveboard definition is then not loaded, and `metadata_detail` contains only `personalised_views`:  ```json \"liveboard_details\": {   \"liveboard_filters\": false,   \"liveboard_tabs\": false,   \"container_layouts\": false,   \"visualizations\": false,   \"parameter_overrides\": false,   \"personalized_views\": true } ```
    */
    'liveboard_details'?: LiveboardDetailsInput;
    /**
    * Includes headers of the metadata objects.
    */
    'include_headers'?: boolean | null;
    /**
    * Includes details of the hidden objects, such as a column in a worksheet or a table.
    */
    'include_hidden_objects'?: boolean | null;
    /**
    * Includes objects with incomplete metadata.
    */
    'include_incomplete_objects'?: boolean | null;
    /**
    * Includes visualization headers of the specified Liveboard object.
    */
    'include_visualization_headers'?: boolean | null;
    /**
    * If search assistance lessons are configured on a worksheet, the API returns the search assist data for Worksheet objects.
    */
    'include_worksheet_search_assist_data'?: boolean | null;
    /**
    * Includes ID or names of the users who modified the metadata object.
    */
    'modified_by_user_identifiers'?: Array<string>;
    /**
    * The starting record number from where the records should be included.
    */
    'record_offset'?: number;
    /**
    * The number of records that should be included. It is recommended to use a smaller `record_size` when fetching dependent objects or any of the additional metadata detail options.
    */
    'record_size'?: number;
    /**
    * Sort options to filter metadata details.
    */
    'sort_options'?: MetadataSearchSortOptions;
    /**
    * Tags to filter metadata objects by
    */
    'tag_identifiers'?: Array<string>;
    /**
    * Indicates whether to include stats of the metadata objects.
    */
    'include_stats'?: boolean | null;
    /**
    * <div>Version: 10.7.0.cl or later </div>  Boolean to indicate whether to include discoverable metadata objects.
    */
    'include_discoverable_objects'?: boolean | null;
    /**
    * <div>Version: 10.9.0.cl or later </div>  Indicates whether to show resolved parameterised values.
    */
    'show_resolved_parameters'?: boolean | null;
    /**
    * Indicates the model version of Liveboard to be attached in metadata detail.
    */
    'liveboard_response_version'?: SearchMetadataRequestLiveboardResponseVersionEnum;
    /**
    * <div>Version: 10.11.0.cl or later </div>  If only published objects should be returned
    */
    'include_only_published_objects'?: boolean | null;

    static readonly discriminator: string | undefined = undefined;

    static readonly mapping: {[index: string]: string} | undefined = undefined;

    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
        {
            "name": "metadata",
            "baseName": "metadata",
            "type": "Array<MetadataListItemInput>",
            "format": ""
        },
        {
            "name": "permissions",
            "baseName": "permissions",
            "type": "Array<PermissionInput>",
            "format": ""
        },
        {
            "name": "created_by_user_identifiers",
            "baseName": "created_by_user_identifiers",
            "type": "Array<string>",
            "format": ""
        },
        {
            "name": "dependent_object_version",
            "baseName": "dependent_object_version",
            "type": "SearchMetadataRequestDependentObjectVersionEnum",
            "format": ""
        },
        {
            "name": "exclude_objects",
            "baseName": "exclude_objects",
            "type": "Array<ExcludeMetadataListItemInput>",
            "format": ""
        },
        {
            "name": "favorite_object_options",
            "baseName": "favorite_object_options",
            "type": "FavoriteObjectOptionsInput",
            "format": ""
        },
        {
            "name": "include_auto_created_objects",
            "baseName": "include_auto_created_objects",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "include_dependent_objects",
            "baseName": "include_dependent_objects",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "dependent_objects_record_size",
            "baseName": "dependent_objects_record_size",
            "type": "number",
            "format": "int32"
        },
        {
            "name": "include_details",
            "baseName": "include_details",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "include_personalised_views",
            "baseName": "include_personalised_views",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "liveboard_details",
            "baseName": "liveboard_details",
            "type": "LiveboardDetailsInput",
            "format": ""
        },
        {
            "name": "include_headers",
            "baseName": "include_headers",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "include_hidden_objects",
            "baseName": "include_hidden_objects",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "include_incomplete_objects",
            "baseName": "include_incomplete_objects",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "include_visualization_headers",
            "baseName": "include_visualization_headers",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "include_worksheet_search_assist_data",
            "baseName": "include_worksheet_search_assist_data",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "modified_by_user_identifiers",
            "baseName": "modified_by_user_identifiers",
            "type": "Array<string>",
            "format": ""
        },
        {
            "name": "record_offset",
            "baseName": "record_offset",
            "type": "number",
            "format": "int32"
        },
        {
            "name": "record_size",
            "baseName": "record_size",
            "type": "number",
            "format": "int32"
        },
        {
            "name": "sort_options",
            "baseName": "sort_options",
            "type": "MetadataSearchSortOptions",
            "format": ""
        },
        {
            "name": "tag_identifiers",
            "baseName": "tag_identifiers",
            "type": "Array<string>",
            "format": ""
        },
        {
            "name": "include_stats",
            "baseName": "include_stats",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "include_discoverable_objects",
            "baseName": "include_discoverable_objects",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "show_resolved_parameters",
            "baseName": "show_resolved_parameters",
            "type": "boolean",
            "format": ""
        },
        {
            "name": "liveboard_response_version",
            "baseName": "liveboard_response_version",
            "type": "SearchMetadataRequestLiveboardResponseVersionEnum",
            "format": ""
        },
        {
            "name": "include_only_published_objects",
            "baseName": "include_only_published_objects",
            "type": "boolean",
            "format": ""
        }    ];

    static getAttributeTypeMap() {
        return SearchMetadataRequest.attributeTypeMap;
    }

    public constructor() {
    }
}

    export type SearchMetadataRequestDependentObjectVersionEnum = "V1" | "V2" ;
    export type SearchMetadataRequestLiveboardResponseVersionEnum = "V1" | "V2" ;