/* tslint:disable */
/* eslint-disable */
/**
 * Timeweb Cloud API
 * # Введение API Timeweb Cloud позволяет вам управлять ресурсами в облаке программным способом с использованием обычных HTTP-запросов.  Множество функций, которые доступны в панели управления Timeweb Cloud, также доступны через API, что позволяет вам автоматизировать ваши собственные сценарии.  В этой документации сперва будет описан общий дизайн и принципы работы API, а после этого конкретные конечные точки. Также будут приведены примеры запросов к ним.   ## Запросы Запросы должны выполняться по протоколу `HTTPS`, чтобы гарантировать шифрование транзакций. Поддерживаются следующие методы запроса: |Метод|Применение| |--- |--- | |GET|Извлекает данные о коллекциях и отдельных ресурсах.| |POST|Для коллекций создает новый ресурс этого типа. Также используется для выполнения действий с конкретным ресурсом.| |PUT|Обновляет существующий ресурс.| |PATCH|Некоторые ресурсы поддерживают частичное обновление, то есть обновление только части атрибутов ресурса, в этом случае вместо метода PUT будет использован PATCH.| |DELETE|Удаляет ресурс.|  Методы `POST`, `PUT` и `PATCH` могут включать объект в тело запроса с типом содержимого `application/json`.  ### Параметры в запросах Некоторые коллекции поддерживают пагинацию, поиск или сортировку в запросах. В параметрах запроса требуется передать: - `limit` — обозначает количество записей, которое необходимо вернуть  - `offset` — указывает на смещение, относительно начала списка  - `search` — позволяет указать набор символов для поиска  - `sort` — можно задать правило сортировки коллекции  ## Ответы Запросы вернут один из следующих кодов состояния ответа HTTP:  |Статус|Описание| |--- |--- | |200 OK|Действие с ресурсом было выполнено успешно.| |201 Created|Ресурс был успешно создан. При этом ресурс может быть как уже готовым к использованию, так и находиться в процессе запуска.| |204 No Content|Действие с ресурсом было выполнено успешно, и ответ не содержит дополнительной информации в теле.| |400 Bad Request|Был отправлен неверный запрос, например, в нем отсутствуют обязательные параметры и т. д. Тело ответа будет содержать дополнительную информацию об ошибке.| |401 Unauthorized|Ошибка аутентификации.| |403 Forbidden|Аутентификация прошла успешно, но недостаточно прав для выполнения действия.| |404 Not Found|Запрашиваемый ресурс не найден.| |409 Conflict|Запрос конфликтует с текущим состоянием.| |423 Locked|Ресурс из запроса заблокирован от применения к нему указанного метода.| |429 Too Many Requests|Был достигнут лимит по количеству запросов в единицу времени.| |500 Internal Server Error|При выполнении запроса произошла какая-то внутренняя ошибка. Чтобы решить эту проблему, лучше всего создать тикет в панели управления.|  ### Структура успешного ответа Все конечные точки будут возвращать данные в формате `JSON`. Ответы на `GET`-запросы будут иметь на верхнем уровне следующую структуру атрибутов:  |Название поля|Тип|Описание| |--- |--- |--- | |[entity_name]|object, object[], string[], number[], boolean|Динамическое поле, которое будет меняться в зависимости от запрашиваемого ресурса и будет содержать все атрибуты, необходимые для описания этого ресурса. Например, при запросе списка баз данных будет возвращаться поле `dbs`, а при запросе конкретного облачного сервера `server`. Для некоторых конечных точек в ответе может возвращаться сразу несколько ресурсов.| |meta|object|Опционально. Объект, который содержит вспомогательную информацию о ресурсе. Чаще всего будет встречаться при запросе коллекций и содержать поле `total`, которое будет указывать на количество элементов в коллекции.| |response_id|string|Опционально. В большинстве случаев в ответе будет содержаться ID ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот ID— так мы сможем найти ответ на него намного быстрее. Также вы можете использовать этот ID, чтобы убедиться, что это новый ответ на запрос и результат не был получен из кэша.|  Пример запроса на получение списка SSH-ключей: ```     HTTP/2.0 200 OK     {       \"ssh_keys\":[           {             \"body\":\"ssh-rsa AAAAB3NzaC1sdfghjkOAsBwWhs= example@device.local\",             \"created_at\":\"2021-09-15T19:52:27Z\",             \"expired_at\":null,             \"id\":5297,             \"is_default\":false,             \"name\":\"example@device.local\",             \"used_at\":null,             \"used_by\":[]           }       ],       \"meta\":{           \"total\":1       },       \"response_id\":\"94608d15-8672-4eed-8ab6-28bd6fa3cdf7\"     } ```  ### Структура ответа с ошибкой |Название поля|Тип|Описание| |--- |--- |--- | |status_code|number|Короткий числовой идентификатор ошибки.| |error_code|string|Короткий текстовый идентификатор ошибки, который уточняет числовой идентификатор и удобен для программной обработки. Самый простой пример — это код `not_found` для ошибки 404.| |message|string, string[]|Опционально. В большинстве случаев в ответе будет содержаться человекочитаемое подробное описание ошибки или ошибок, которые помогут понять, что нужно исправить.| |response_id|string|Опционально. В большинстве случае в ответе будет содержаться ID ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот ID — так мы сможем найти ответ на него намного быстрее.|  Пример: ```     HTTP/2.0 403 Forbidden     {       \"status_code\": 403,       \"error_code\":  \"forbidden\",       \"message\":     \"You do not have access for the attempted action\",       \"response_id\": \"94608d15-8672-4eed-8ab6-28bd6fa3cdf7\"     } ```  ## Статусы ресурсов Важно учесть, что при создании большинства ресурсов внутри платформы вам будет сразу возвращен ответ от сервера со статусом `200 OK` или `201 Created` и ID созданного ресурса в теле ответа, но при этом этот ресурс может быть ещё в *состоянии запуска*.  Для того чтобы понять, в каком состоянии сейчас находится ваш ресурс, мы добавили поле `status` в ответ на получение информации о ресурсе.  Список статусов будет отличаться в зависимости от типа ресурса. Увидеть поддерживаемый список статусов вы сможете в описании каждого конкретного ресурса.     ## Ограничение скорости запросов (Rate Limiting) Чтобы обеспечить стабильность для всех пользователей, Timeweb Cloud защищает API от всплесков входящего трафика, анализируя количество запросов c каждого аккаунта к каждой конечной точке.  Если ваше приложение отправляет более 20 запросов в секунду на одну конечную точку, то для этого запроса API может вернуть код состояния HTTP `429 Too Many Requests`.   ## Аутентификация Доступ к API осуществляется с помощью JWT-токена. Токенами можно управлять внутри панели управления Timeweb Cloud в разделе *API и Terraform*.  Токен необходимо передавать в заголовке каждого запроса в формате: ```   Authorization: Bearer $TIMEWEB_CLOUD_TOKEN ```  ## Формат примеров API Примеры в этой документации описаны с помощью `curl`, HTTP-клиента командной строки. На компьютерах `Linux` и `macOS` обычно по умолчанию установлен `curl`, и он доступен для загрузки на всех популярных платформах, включая `Windows`.  Каждый пример разделен на несколько строк символом `\\`, который совместим с `bash`. Типичный пример выглядит так: ```   curl -X PATCH      -H \"Content-Type: application/json\"      -H \"Authorization: Bearer $TIMEWEB_CLOUD_TOKEN\"      -d \'{\"name\":\"Cute Corvus\",\"comment\":\"Development Server\"}\'      \"https://api.timeweb.cloud/api/v1/dedicated/1051\" ``` - Параметр `-X` задает метод запроса. Для согласованности метод будет указан во всех примерах, даже если он явно не требуется для методов `GET`. - Строки `-H` задают требуемые HTTP-заголовки. - Примеры, для которых требуется объект JSON в теле запроса, передают требуемые данные через параметр `-d`.  Чтобы использовать приведенные примеры, не подставляя каждый раз в них свой токен, вы можете добавить токен один раз в переменные окружения в вашей консоли. Например, на `Linux` это можно сделать с помощью команды:  ``` TIMEWEB_CLOUD_TOKEN=\"token\" ```  После этого токен будет автоматически подставляться в ваши запросы.  Обратите внимание, что все значения в этой документации являются примерами. Не полагайтесь на IDы операционных систем, тарифов и т.д., используемые в примерах. Используйте соответствующую конечную точку для получения значений перед созданием ресурсов.   ## Версионирование API построено согласно принципам [семантического версионирования](https://semver.org/lang/ru). Это значит, что мы гарантируем обратную совместимость всех изменений в пределах одной мажорной версии.  Мажорная версия каждой конечной точки обозначается в пути запроса, например, запрос `/api/v1/servers` указывает, что этот метод имеет версию 1.
 *
 * The version of the OpenAPI document: 1.0.0
 * Contact: info@timeweb.cloud
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { exists, mapValues } from '../runtime';
/**
 * Параметры базы данных
 * @export
 * @interface ConfigParameters
 */
export interface ConfigParameters {
    /**
     * Интервал между значениями столбцов с атрибутом `AUTO_INCREMENT` (`mysql5` | `mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    autoIncrementIncrement?: string;
    /**
     * Начальное значение для столбцов с атрибутом `AUTO_INCREMENT` (`mysql5` | `mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    autoIncrementOffset?: string;
    /**
     * Количество операций ввода-вывода в секунду `IOPS` (`mysql5` | `mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    innodbIoCapacity?: string;
    /**
     * Количество потоков ввода-вывода, используемых для операций очистки (`mysql5` | `mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    innodbPurgeThreads?: string;
    /**
     * Количество потоков ввода-вывода, используемых для операций чтения (`mysql5` | `mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    innodbReadIoThreads?: string;
    /**
     * Максимальное число потоков, которые могут исполняться (`mysql5` | `mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    innodbThreadConcurrency?: string;
    /**
     * Количество потоков ввода-вывода, используемых для операций записи (`mysql5` | `mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    innodbWriteIoThreads?: string;
    /**
     * Минимальный размер буфера (`mysql5` | `mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    joinBufferSize?: string;
    /**
     * Максимальный размер одного пакета, строки или параметра, отправляемого функцией `mysql_stmt_send_long_data()` (`mysql5` | `mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    maxAllowedPacket?: string;
    /**
     * Максимальный размер пользовательских MEMORY-таблиц (`mysql5` | `mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    maxHeapTableSize?: string;
    /**
     * Доля измененных или удаленных записей в таблице, при которой процесс автоочистки выполнит команду `ANALYZE` (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    autovacuumAnalyzeScaleFactor?: string;
    /**
     * Задержка между запусками процесса фоновой записи (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    bgwriterDelay?: string;
    /**
     * Максимальное число элементов буферного кеша (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    bgwriterLruMaxpages?: string;
    /**
     * Время ожидания, по истечении которого будет выполняться проверка состояния перекрестной блокировки (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    deadlockTimeout?: string;
    /**
     * Максимальный размер очереди записей индекса `GIN` (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    ginPendingListLimit?: string;
    /**
     * Время простоя открытой транзакции, при превышении которого будет завершена сессия с этой транзакцией (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    idleInTransactionSessionTimeout?: string;
    /**
     * Время простоя не открытой транзакции, при превышении которого будет завершена сессия с этой транзакцией (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    idleSessionTimeout?: string;
    /**
     * Значение количества элементов в списке `FROM` при превышении которого, планировщик будет переносить в список явные инструкции `JOIN` (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    joinCollapseLimit?: string;
    /**
     * Время ожидания освобождения блокировки (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    lockTimeout?: string;
    /**
     * Максимальное число транзакций, которые могут одновременно находиться в подготовленном состоянии (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    maxPreparedTransactions?: string;
    /**
     * Допустимое количество соединений (`postgres` | `postgres14`| `postgres15` | `mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    maxConnections?: string;
    /**
     * Устанавливает количество буферов общей памяти, используемых сервером (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    sharedBuffers?: string;
    /**
     * Устанавливает количество буферов дисковых страниц в общей памяти для WAL (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    walBuffers?: string;
    /**
     * Устанавливает максимальное количество временных буферов, используемых каждой сессией (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    tempBuffers?: string;
    /**
     * Устанавливает максимальное количество памяти, используемое для рабочих пространств запросов (`postgres` | `postgres14`| `postgres15`).
     * @type {string}
     * @memberof ConfigParameters
     */
    workMem?: string;
    /**
     * Устанавливает режим SQL. Можно задать несколько режимов, разделяя их запятой. (`mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    sqlMode?: string;
    /**
     * Параметр включает или отключает работу MySQL Query Cache (`mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    queryCacheType?: string;
    /**
     * Размер в байтах, доступный для кэша запросов (`mysql`).
     * @type {string}
     * @memberof ConfigParameters
     */
    queryCacheSize?: string;
}

/**
 * Check if a given object implements the ConfigParameters interface.
 */
export function instanceOfConfigParameters(value: object): boolean {
    let isInstance = true;

    return isInstance;
}

export function ConfigParametersFromJSON(json: any): ConfigParameters {
    return ConfigParametersFromJSONTyped(json, false);
}

export function ConfigParametersFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConfigParameters {
    if ((json === undefined) || (json === null)) {
        return json;
    }
    return {
        
        'autoIncrementIncrement': !exists(json, 'auto_increment_increment') ? undefined : json['auto_increment_increment'],
        'autoIncrementOffset': !exists(json, 'auto_increment_offset') ? undefined : json['auto_increment_offset'],
        'innodbIoCapacity': !exists(json, 'innodb_io_capacity') ? undefined : json['innodb_io_capacity'],
        'innodbPurgeThreads': !exists(json, 'innodb_purge_threads') ? undefined : json['innodb_purge_threads'],
        'innodbReadIoThreads': !exists(json, 'innodb_read_io_threads') ? undefined : json['innodb_read_io_threads'],
        'innodbThreadConcurrency': !exists(json, 'innodb_thread_concurrency') ? undefined : json['innodb_thread_concurrency'],
        'innodbWriteIoThreads': !exists(json, 'innodb_write_io_threads') ? undefined : json['innodb_write_io_threads'],
        'joinBufferSize': !exists(json, 'join_buffer_size') ? undefined : json['join_buffer_size'],
        'maxAllowedPacket': !exists(json, 'max_allowed_packet') ? undefined : json['max_allowed_packet'],
        'maxHeapTableSize': !exists(json, 'max_heap_table_size') ? undefined : json['max_heap_table_size'],
        'autovacuumAnalyzeScaleFactor': !exists(json, 'autovacuum_analyze_scale_factor') ? undefined : json['autovacuum_analyze_scale_factor'],
        'bgwriterDelay': !exists(json, 'bgwriter_delay') ? undefined : json['bgwriter_delay'],
        'bgwriterLruMaxpages': !exists(json, 'bgwriter_lru_maxpages') ? undefined : json['bgwriter_lru_maxpages'],
        'deadlockTimeout': !exists(json, 'deadlock_timeout') ? undefined : json['deadlock_timeout'],
        'ginPendingListLimit': !exists(json, 'gin_pending_list_limit') ? undefined : json['gin_pending_list_limit'],
        'idleInTransactionSessionTimeout': !exists(json, 'idle_in_transaction_session_timeout') ? undefined : json['idle_in_transaction_session_timeout'],
        'idleSessionTimeout': !exists(json, 'idle_session_timeout') ? undefined : json['idle_session_timeout'],
        'joinCollapseLimit': !exists(json, 'join_collapse_limit') ? undefined : json['join_collapse_limit'],
        'lockTimeout': !exists(json, 'lock_timeout') ? undefined : json['lock_timeout'],
        'maxPreparedTransactions': !exists(json, 'max_prepared_transactions') ? undefined : json['max_prepared_transactions'],
        'maxConnections': !exists(json, 'max_connections') ? undefined : json['max_connections'],
        'sharedBuffers': !exists(json, 'shared_buffers') ? undefined : json['shared_buffers'],
        'walBuffers': !exists(json, 'wal_buffers') ? undefined : json['wal_buffers'],
        'tempBuffers': !exists(json, 'temp_buffers') ? undefined : json['temp_buffers'],
        'workMem': !exists(json, 'work_mem') ? undefined : json['work_mem'],
        'sqlMode': !exists(json, 'sql_mode') ? undefined : json['sql_mode'],
        'queryCacheType': !exists(json, 'query_cache_type') ? undefined : json['query_cache_type'],
        'queryCacheSize': !exists(json, 'query_cache_size') ? undefined : json['query_cache_size'],
    };
}

export function ConfigParametersToJSON(value?: ConfigParameters | null): any {
    if (value === undefined) {
        return undefined;
    }
    if (value === null) {
        return null;
    }
    return {
        
        'auto_increment_increment': value.autoIncrementIncrement,
        'auto_increment_offset': value.autoIncrementOffset,
        'innodb_io_capacity': value.innodbIoCapacity,
        'innodb_purge_threads': value.innodbPurgeThreads,
        'innodb_read_io_threads': value.innodbReadIoThreads,
        'innodb_thread_concurrency': value.innodbThreadConcurrency,
        'innodb_write_io_threads': value.innodbWriteIoThreads,
        'join_buffer_size': value.joinBufferSize,
        'max_allowed_packet': value.maxAllowedPacket,
        'max_heap_table_size': value.maxHeapTableSize,
        'autovacuum_analyze_scale_factor': value.autovacuumAnalyzeScaleFactor,
        'bgwriter_delay': value.bgwriterDelay,
        'bgwriter_lru_maxpages': value.bgwriterLruMaxpages,
        'deadlock_timeout': value.deadlockTimeout,
        'gin_pending_list_limit': value.ginPendingListLimit,
        'idle_in_transaction_session_timeout': value.idleInTransactionSessionTimeout,
        'idle_session_timeout': value.idleSessionTimeout,
        'join_collapse_limit': value.joinCollapseLimit,
        'lock_timeout': value.lockTimeout,
        'max_prepared_transactions': value.maxPreparedTransactions,
        'max_connections': value.maxConnections,
        'shared_buffers': value.sharedBuffers,
        'wal_buffers': value.walBuffers,
        'temp_buffers': value.tempBuffers,
        'work_mem': value.workMem,
        'sql_mode': value.sqlMode,
        'query_cache_type': value.queryCacheType,
        'query_cache_size': value.queryCacheSize,
    };
}