Managed Service for MySQL API, gRPC: ClusterService.Restore

Field

Description

backup_id

string

Required field. ID of the backup to restore from.
To get this ID, make a BackupService.List request (lists all backups in a folder) or a ClusterService.ListBackups request (lists all backups for an existing cluster).

time

google.protobuf.Timestamp

Timestamp of the moment to which the MySQL cluster should be restored.

name

string

Required field. Name of the new MySQL cluster the backup will be restored to. The name must be unique within the folder.

Value must match the regular expression [a-zA-Z0-9_-]*.

description

string

Description of the new cluster.

The maximum string length in characters is 256.

labels

object (map<string, string>)

Custom labels for the new cluster as key:value pairs.

The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\@0-9a-z]*. Each value must match the regular expression [-_./\@0-9a-z]*. No more than 64 per resource.

environment

enum Environment

Deployment environment of the new cluster.

• PRODUCTION: Environment for stable versions of your apps.
  A conservative update policy is in effect: only bug fixes are applied during regular maintenance.
• PRESTABLE: Environment for testing, including the Managed Service for MySQL itself.
  This environment gets new features, improvements, and bug fixes in the first place, compared to the production environment.
  However, not every update ensures backward compatibility.

config_spec

ConfigSpec

Configuration of the new cluster.

host_specs[]

HostSpec

Configuration of hosts in the new cluster.

network_id

string

ID of the network to create the new cluster in.

The maximum string length in characters is 50.

folder_id

string

ID of the folder to create the new cluster in.

The maximum string length in characters is 50.

security_group_ids[]

string

List of security group IDs to apply to the new cluster.

deletion_protection

bool

Deletion Protection inhibits deletion of the cluster

host_group_ids[]

string

Host groups hosting VMs of the cluster.

maintenance_window

MaintenanceWindow

Window of maintenance operations.

disk_encryption_key_id

google.protobuf.StringValue

ID of the key to encrypt cluster disks.

Field

Description

version

string

Version of MySQL used in the cluster.
Possible values: 5.7, 8.0, 8.4.

mysql_config_5_7

MysqlConfig5_7

Configuration for a MySQL 5.7 cluster.

Includes only one of the fields mysql_config_5_7, mysql_config_8_0, mysql_config_8_4.

Cluster-wide MySQL configuration.

mysql_config_8_0

MysqlConfig8_0

Configuration for a MySQL 8.0 cluster.

Includes only one of the fields mysql_config_5_7, mysql_config_8_0, mysql_config_8_4.

Cluster-wide MySQL configuration.

mysql_config_8_4

MysqlConfig8_4

Configuration for a MySQL 8.4 cluster.

Includes only one of the fields mysql_config_5_7, mysql_config_8_0, mysql_config_8_4.

Cluster-wide MySQL configuration.

resources

Resources

Resource preset for the cluster hosts.

backup_window_start

google.type.TimeOfDay

Time to start the daily backup, in the UTC timezone.

access

Access

Access policy for external services.
If the specific services need to access the cluster, then set the necessary values in this policy.

performance_diagnostics

PerformanceDiagnostics

Configuration of the performance diagnostics service.

backup_retain_period_days

google.protobuf.Int64Value

Retention policy of automated backups.

Acceptable values are 7 to 60, inclusive.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling

Field

Description

innodb_buffer_pool_size

google.protobuf.Int64Value

Size of the InnoDB buffer pool used for caching table and index data.
See MySQL documentation for details.

The minimum value is 134217728.

max_connections

google.protobuf.Int64Value

The maximum permitted number of simultaneous client connections.
See MySQL documentation for details.

Acceptable values are 10 to 100000, inclusive.

long_query_time

google.protobuf.DoubleValue

Time that it takes to process a query before it is considered slow.
See MySQL documentation for details.

Acceptable values are 0 to 3600, inclusive.

general_log

google.protobuf.BoolValue

Enable writing of general query log of MySQL.
See MySQL documentation for details.

audit_log

google.protobuf.BoolValue

Enable writing of audit log of MySQL.
See MySQL documentation for details.

sql_mode[]

enum SQLMode

Server SQL mode of MySQL.
See MySQL documentation for details.

• ALLOW_INVALID_DATES: Allow dates where the day or month part is 0. See MySQL documentation.
• ANSI_QUOTES: Treat " as an identifier quote character (like the ` quote character) rather than as a string quote character. See MySQL documentation.
• ERROR_FOR_DIVISION_BY_ZERO: Produce an error for divisions by zero. See MySQL documentation.
• HIGH_NOT_PRECEDENCE: Give NOT higher precedence in negation than it has in non-high-precedence mode. See MySQL documentation.
• IGNORE_SPACE: Allow spaces between a function name and the ( character. See MySQL documentation.
• NO_AUTO_VALUE_ON_ZERO: Do not reset the AUTO_INCREMENT column to 0 when inserting 0 into it. See MySQL documentation.
• NO_BACKSLASH_ESCAPES: Disable the use of the backslash character (\) as an escape character within strings. See MySQL documentation.
• NO_ENGINE_SUBSTITUTION: Do not substitute the default storage engine when a statement specifies a storage engine that is disabled or not compiled in. See MySQL documentation.
• NO_UNSIGNED_SUBTRACTION: Disable unsigned subtraction so that subtraction results are always signed. See MySQL documentation.
• NO_ZERO_DATE: Disable the MySQL-specific date 0000-00-00. See MySQL documentation.
• NO_ZERO_IN_DATE: Disable month or day parts of 0 in dates. See MySQL documentation.
• NO_FIELD_OPTIONS: Ignore field options in CREATE TABLE statements (MySQL 5.7 compatibility). See MySQL documentation.
• NO_KEY_OPTIONS: Ignore key options in CREATE TABLE statements (MySQL 5.7 compatibility). See MySQL documentation.
• NO_TABLE_OPTIONS: Ignore table options in CREATE TABLE statements (MySQL 5.7 compatibility). See MySQL documentation.
• ONLY_FULL_GROUP_BY: Reject queries for which the select list, HAVING condition, or ORDER BY list refer to non-aggregated columns that are not named in the GROUP BY clause. See MySQL documentation.
• PAD_CHAR_TO_FULL_LENGTH: Pad CHAR column values with spaces to the full column length when retrieving them. See MySQL documentation.
• PIPES_AS_CONCAT: Treat \|\| as a string concatenation operator rather than as OR. See MySQL documentation.
• REAL_AS_FLOAT: Treat REAL as a synonym for FLOAT rather than DOUBLE. See MySQL documentation.
• STRICT_ALL_TABLES: Strict mode for all storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• STRICT_TRANS_TABLES: Strict mode for transactional storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• ANSI: Equivalent to REAL_AS_FLOAT, PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE, and ONLY_FULL_GROUP_BY. See MySQL documentation.
• TRADITIONAL: Equivalent to STRICT_TRANS_TABLES, STRICT_ALL_TABLES, NO_ZERO_IN_DATE, NO_ZERO_DATE, ERROR_FOR_DIVISION_BY_ZERO, and NO_AUTO_CREATE_USER. See MySQL documentation.
• DB2: IBM DB2 compatibility mode. See MySQL documentation.
• MAXDB: SAP MaxDB compatibility mode. See MySQL documentation.
• MSSQL: Microsoft SQL Server compatibility mode. See MySQL documentation.
• MYSQL323: MySQL 3.23 compatibility mode. See MySQL documentation.
• MYSQL40: MySQL 4.0 compatibility mode. See MySQL documentation.
• ORACLE: Oracle compatibility mode. See MySQL documentation.
• POSTGRESQL: PostgreSQL compatibility mode. See MySQL documentation.
• NO_AUTO_CREATE_USER: Prevent GRANT from creating new users implicitly. See MySQL documentation.
• NO_DIR_IN_CREATE: Prevent the use of .. in directory paths in CREATE TABLE statements. See MySQL documentation.

max_allowed_packet

google.protobuf.Int64Value

The maximum size in bytes of one packet.
See MySQL documentation for details.

Acceptable values are 1048576 to 1073741824, inclusive.

default_authentication_plugin

enum AuthPlugin

Authentication plugin used in the managed MySQL cluster.
See MySQL documentation for details.

• MYSQL_NATIVE_PASSWORD: Using Native Pluggable Authentication.
• CACHING_SHA2_PASSWORD: Using Caching SHA-2 Pluggable Authentication.
• SHA256_PASSWORD: Using SHA-256 Pluggable Authentication.
• MYSQL_NO_LOGIN: Use MYSQL_NO_LOGIN Pluggable Authentication.
• MDB_IAMPROXY_AUTH: Use IAM Pluggable Authentication.

innodb_flush_log_at_trx_commit

google.protobuf.Int64Value

Transaction log flush behaviour.
See MySQL documentation for details.

Acceptable values are 1 to 2, inclusive.

innodb_lock_wait_timeout

google.protobuf.Int64Value

Max time in seconds for a transaction to wait for a row lock.
See MySQL documentation for details.

Acceptable values are 1 to 28800, inclusive.

transaction_isolation

enum TransactionIsolation

Default transaction isolation level.
See MySQL documentation for details.

• READ_COMMITTED: Read committed isolation level. A consistent read within the same transaction reads the snapshot established by the first read.
• REPEATABLE_READ: Repeatable read isolation level. All consistent reads within the same transaction read the snapshot established by the first read.
• SERIALIZABLE: Serializable isolation level. All statements implicitly convert to SELECT ... FOR SHARE if autocommit is disabled.

innodb_print_all_deadlocks

google.protobuf.BoolValue

Print information about deadlocks in error log.
See MySQL documentation for details.

net_read_timeout

google.protobuf.Int64Value

The number of seconds to wait for more data from a connection before aborting the read.
See MySQL documentation for details.

Acceptable values are 1 to 1200, inclusive.

net_write_timeout

google.protobuf.Int64Value

The number of seconds to wait for a block to be written to a connection before aborting the write.
See MySQL documentation for details.

Acceptable values are 1 to 1200, inclusive.

group_concat_max_len

google.protobuf.Int64Value

The maximum permitted result length in bytes for the GROUP_CONCAT() function.
See MySQL documentation for details.

Acceptable values are 4 to 33554432, inclusive.

tmp_table_size

google.protobuf.Int64Value

The maximum size of internal in-memory temporary tables.
See MySQL documentation for details.

Acceptable values are 1024 to 536870912, inclusive.

max_heap_table_size

google.protobuf.Int64Value

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
See MySQL documentation for details.

Acceptable values are 16384 to 536870912, inclusive.

default_time_zone

string

The servers default time zone.
See MySQL documentation for details.

character_set_server

string

The servers default character set.
See MySQL documentation for details.

collation_server

string

The server default collation.
See MySQL documentation for details.

innodb_adaptive_hash_index

google.protobuf.BoolValue

Enables InnoDB adaptive hash index.
See MySQL documentation for details.

innodb_numa_interleave

google.protobuf.BoolValue

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.
See MySQL documentation for details.

innodb_log_buffer_size

google.protobuf.Int64Value

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.
See MySQL documentation for details.

Acceptable values are 1048576 to 268435456, inclusive.

innodb_log_file_size

google.protobuf.Int64Value

The size in bytes of the single InnoDB Redo log file.
See MySQL documentation for details.

Acceptable values are 268435456 to 8589934592, inclusive.

innodb_io_capacity

google.protobuf.Int64Value

Limits IO available for InnoDB background tasks.
See MySQL documentation for details.

Acceptable values are 100 to 100000, inclusive.

innodb_io_capacity_max

google.protobuf.Int64Value

Limits IO available for InnoDB background tasks.
See MySQL documentation for details.

Acceptable values are 100 to 100000, inclusive.

innodb_read_io_threads

google.protobuf.Int64Value

The number of I/O threads for read operations in InnoDB.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodb_write_io_threads

google.protobuf.Int64Value

The number of I/O threads for write operations in InnoDB.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodb_purge_threads

google.protobuf.Int64Value

The number of background threads devoted to the InnoDB purge operation.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodb_thread_concurrency

google.protobuf.Int64Value

Defines the maximum number of threads permitted inside of InnoDB.
See MySQL documentation for details.

Acceptable values are 0 to 1000, inclusive.

innodb_temp_data_file_max_size

google.protobuf.Int64Value

Limits the max size of InnoDB temp tablespace.
See MySQL documentation for details.

Acceptable values are 1073741824 to 107374182400, inclusive.

thread_cache_size

google.protobuf.Int64Value

A number of threads the server should cache for reuse.
See MySQL documentation for details.

Acceptable values are 10 to 10000, inclusive.

thread_stack

google.protobuf.Int64Value

The stack size for each thread. The default is large enough for normal operation.
See MySQL documentation for details.

Acceptable values are 131072 to 16777216, inclusive.

join_buffer_size

google.protobuf.Int64Value

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that don't use indexes and thus perform full table scans.
See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.

sort_buffer_size

google.protobuf.Int64Value

Each session that must perform a sort allocates a buffer of this size.
See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.

table_definition_cache

google.protobuf.Int64Value

The number of table definitions that can be stored in the definition cache.
See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.

table_open_cache

google.protobuf.Int64Value

The number of open tables for all threads.
See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.

table_open_cache_instances

google.protobuf.Int64Value

The number of open tables cache instances.
See MySQL documentation for details.

Acceptable values are 1 to 32, inclusive.

explicit_defaults_for_timestamp

google.protobuf.BoolValue

Determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.
See MySQL documentation for details.

auto_increment_increment

google.protobuf.Int64Value

Can be used to control the operation of AUTO_INCREMENT columns.
See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.

auto_increment_offset

google.protobuf.Int64Value

Can be used to control the operation of AUTO_INCREMENT columns.
See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.

sync_binlog

google.protobuf.Int64Value

Controls how often the MySQL server synchronizes the binary log to disk.
See MySQL documentation for details.

Acceptable values are 0 to 4096, inclusive.

binlog_cache_size

google.protobuf.Int64Value

The size of the cache to hold changes to the binary log during a transaction.
See MySQL documentation for details.

Acceptable values are 4096 to 67108864, inclusive.

binlog_group_commit_sync_delay

google.protobuf.Int64Value

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk.
See MySQL documentation for the variable for details.

Acceptable values are 0 to 50000, inclusive.

binlog_row_image

enum BinlogRowImage

For MySQL row-based replication, this variable determines how row images are written to the binary log.
See MySQL documentation for details.

• FULL: Log all columns (full row image).
• MINIMAL: Log only changed columns and columns needed to identify the row.
• NOBLOB: Log all columns except BLOB and TEXT columns.

binlog_rows_query_log_events

google.protobuf.BoolValue

When enabled, it causes the server to write informational log events such as row query log events into its binary log.
See MySQL documentation for details.

rpl_semi_sync_master_wait_for_slave_count

google.protobuf.Int64Value

The number of replica acknowledgments the source must receive per transaction before proceeding.
See MySQL documentation for details.

The minimum value is 1.

slave_parallel_type

enum SlaveParallelType

When using a multi-threaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica.
See MySQL documentation for details.

• DATABASE: Transactions are parallelized per database (schema).
• LOGICAL_CLOCK: Transactions are parallelized using the logical clock algorithm based on the binary log group commit.

slave_parallel_workers

google.protobuf.Int64Value

Sets the number of applier threads for executing replication transactions in parallel.
See MySQL documentation for details.

Acceptable values are 0 to 64, inclusive.

mdb_preserve_binlog_bytes

google.protobuf.Int64Value

The size of the binary log to hold.

Acceptable values are 1073741824 to 1099511627776, inclusive.

interactive_timeout

google.protobuf.Int64Value

The number of seconds the server waits for activity on an interactive connection before closing it.
See MySQL documentation for details.

Acceptable values are 600 to 86400, inclusive.

wait_timeout

google.protobuf.Int64Value

The number of seconds the server waits for activity on a noninteractive connection before closing it.
See MySQL documentation for details.

Acceptable values are 600 to 86400, inclusive.

mdb_offline_mode_enable_lag

google.protobuf.Int64Value

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data.

Acceptable values are 30 to 86400, inclusive.

mdb_offline_mode_disable_lag

google.protobuf.Int64Value

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'.
Should be less than mdb_offline_mode_enable_lag value.

Acceptable values are 10 to 86400, inclusive.

range_optimizer_max_mem_size

google.protobuf.Int64Value

The limit on memory consumption for the range optimizer.
See MySQL documentation for details.

Acceptable values are 60 to 268435456, inclusive.

innodb_online_alter_log_max_size

google.protobuf.Int64Value

The limit in bytes on the size of the temporary log files used during online DDL operations
For details, see MySQL documentation for the variable.

Acceptable values are 65536 to 107374182400, inclusive.

innodb_ft_min_token_size

google.protobuf.Int64Value

Minimum length of words that are stored in an InnoDB FULLTEXT index
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 16, inclusive.

innodb_ft_max_token_size

google.protobuf.Int64Value

Maximum length of words that are stored in an InnoDB FULLTEXT index
For details, see MySQL documentation for the variable.

Acceptable values are 10 to 84, inclusive.

lower_case_table_names

google.protobuf.Int64Value

Table names storage and comparison strategy
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 1, inclusive.

show_compatibility_56

google.protobuf.BoolValue

Manages MySQL 5.6 compatibility
For details, see MySQL documentation for the variable.

slow_query_log

google.protobuf.BoolValue

Manages slow query log.
See MySQL documentation for details.

slow_query_log_always_write_time

google.protobuf.DoubleValue

Query execution time, after which query to be logged unconditionally, that is, `log_slow_rate_limit`` will not apply to it.
See Percona documentation for details.

Acceptable values are 0 to 3600, inclusive.

log_slow_rate_type

enum LogSlowRateType

Specifies slow log granularity for log_slow_rate_limit values QUERY or SESSION.
See Percona documentation for details.

• SESSION: Logging is controlled per session.
• QUERY: Logging is controlled per query.

log_slow_rate_limit

google.protobuf.Int64Value

Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query.
See Percona documentation for details.

Acceptable values are 1 to 1000, inclusive.

log_slow_sp_statements

google.protobuf.BoolValue

When TRUE, statements executed by stored procedures are logged to the slow log.
See Percona documentation for details.

log_slow_filter[]

enum LogSlowFilterType

Filters the slow log by the query's execution plan.
See Percona documentation for details.

• FULL_SCAN: Queries that perform a full table scan.
• FULL_JOIN: Queries that perform a full join (a join without indexes).
• TMP_TABLE: Queries that create an implicit internal temporary table.
• TMP_TABLE_ON_DISK: Queries that create an implicit internal temporary table on disk.
• FILESORT: Queries that use a filesort.
• FILESORT_ON_DISK: Queries that use a filesort on disk.

mdb_priority_choice_max_lag

google.protobuf.Int64Value

Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from".
Should be less than mdb_offline_mode_disable_lag.

Acceptable values are 0 to 86400, inclusive.

innodb_page_size

google.protobuf.Int64Value

Specifies the page size for InnoDB tablespaces.
For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 65536, inclusive.

max_sp_recursion_depth

google.protobuf.Int64Value

The number of times that any given stored procedure may be called recursively.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 255, inclusive.

innodb_compression_level

google.protobuf.Int64Value

The level of zlib compression to use for InnoDB compressed tables and indexes.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 9, inclusive.

binlog_transaction_dependency_tracking

enum BinlogTransactionDependencyTracking

Specifies how the source mysqld generates the dependency information that it writes in the binary log to help replicas determine which transactions can be executed in parallel.
For details, see MySQL documentation for the variable.

• COMMIT_ORDER: Transactions are made dependent based on commit order.
• WRITESET: Transactions are made dependent based on the write set of rows modified by the transaction.
• WRITESET_SESSION: Transactions are made dependent based on the write set and the commit order within a session.

autocommit

google.protobuf.BoolValue

Config specific will be all changes to a table take effect immediately or you must use COMMIT to accept a transaction or ROLLBACK to cancel it.
For details, see MySQL documentation for the variable.

innodb_status_output

google.protobuf.BoolValue

Enables or disables periodic output for the standard InnoDB Monitor.
For details, see MySQL documentation for the variable.

innodb_strict_mode

google.protobuf.BoolValue

When innodb_strict_mode is enabled, InnoDB returns errors rather than warnings when checking for invalid or incompatible table options.
For details, see MySQL documentation for the variable.

innodb_print_lock_wait_timeout_info

google.protobuf.BoolValue

Makes InnoDB to write information about all lock wait timeout errors into the log file.
For details, see Percona documentation for the variable.

log_error_verbosity

google.protobuf.Int64Value

System variable specifies the verbosity for handling events intended for the error log
For details, see MySQL documentation for the variable.

Acceptable values are 2 to 3, inclusive.

max_digest_length

google.protobuf.Int64Value

The maximum number of bytes of memory reserved per session for computation of normalized statement digests.
For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 1048576, inclusive.

query_cache_limit

google.protobuf.Int64Value

Do not cache results that are larger than this number of bytes.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 4294967295, inclusive.

query_cache_size

google.protobuf.Int64Value

The amount of memory allocated for caching query results.
For details, see MySQL documentation for the variable.

query_cache_type

google.protobuf.Int64Value

Set the query cache type.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 2, inclusive.

lock_wait_timeout

google.protobuf.Int64Value

This variable specifies the timeout in seconds for attempts to acquire metadata locks
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 31536000, inclusive.

max_prepared_stmt_count

google.protobuf.Int64Value

This variable limits the total number of prepared statements in the server.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 1048576, inclusive.

optimizer_switch

string

The system variable enables control over optimizer behavior.
For details, see MySQL documentation for the variable
https://dev.mysql.com/doc/refman/5.7/en/switchable-optimizations.html

optimizer_search_depth

google.protobuf.Int64Value

The maximum depth of search performed by the query optimizer
For details, see MySQL documentation for the variable

Acceptable values are 0 to 62, inclusive.

query_response_time_stats

google.protobuf.BoolValue

Enables and disables collection of query times
For details, see Percona documentation for the variable.

userstat

google.protobuf.BoolValue

Enables or disables collection of statistics
For details, see Percona documentation for the variable.

max_execution_time

google.protobuf.Int64Value

The execution timeout for SELECT statements, in milliseconds. If the value is 0, timeouts are not enabled.
For details, see MySQL documentation for the variable

Acceptable values are 0 to 4294967295, inclusive.

audit_log_policy

enum AuditLogPolicy

The policy controlling how the audit log plugin writes events to its log file
For details, see MySQL documentation for the variable

• ALL: Log all events.
• LOGINS: Log only login events.
• QUERIES: Log only query events.
• NONE: Do not log events.

innodb_lru_scan_depth

google.protobuf.Int64Value

A parameter that influences the algorithms and heuristics for the flush operation for the InnoDB buffer pool
For details, see MySQL documentation for the variable

Acceptable values are 100 to 4294967295, inclusive.

mdb_force_ssl

google.protobuf.BoolValue

Force ssl on all hosts (require_secure_transport)

innodb_change_buffering

enum InnodbChangeBuffering

An optimization for change buffering
For details, see MySQL documentation for the variable.

• INNODB_CHANGE_BUFFERING_NONE: Do not buffer any operations.
• INNODB_CHANGE_BUFFERING_INSERTS: Buffer insert operations.
• INNODB_CHANGE_BUFFERING_DELETES: Buffer delete-marking operations.
• INNODB_CHANGE_BUFFERING_CHANGES: Buffer insert and delete-marking operations.
• INNODB_CHANGE_BUFFERING_PURGES: Buffer operations where undo log records are discarded.
• INNODB_CHANGE_BUFFERING_ALL: Buffer all types of eligible operations.

max_write_lock_count

google.protobuf.Int64Value

Permit some pending read lock requests interval
P.S. Should be UInt64, but java fails to handle UInt64 limits
For details, see Percona documentation for the variable.

The minimum value is 1.

innodb_adaptive_hash_index_parts

google.protobuf.Int64Value

Partitions the adaptive hash index search system.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 512, inclusive.

Field

Description

innodb_buffer_pool_size

google.protobuf.Int64Value

Size of the InnoDB buffer pool used for caching table and index data.
See MySQL documentation for details.

The minimum value is 134217728.

max_connections

google.protobuf.Int64Value

The maximum permitted number of simultaneous client connections.
See MySQL documentation for details.

Acceptable values are 10 to 100000, inclusive.

long_query_time

google.protobuf.DoubleValue

Time that it takes to process a query before it is considered slow.
See MySQL documentation for details.

Acceptable values are 0 to 3600, inclusive.

general_log

google.protobuf.BoolValue

Enable writing of general query log of MySQL.
See MySQL documentation for details.

audit_log

google.protobuf.BoolValue

Enable writing of audit log of MySQL.
See MySQL documentation for details.

sql_mode[]

enum SQLMode

Server SQL mode of MySQL.
See MySQL documentation for details.

• ALLOW_INVALID_DATES: Allow dates where the day or month part is 0. See MySQL documentation.
• ANSI_QUOTES: Treat " as an identifier quote character (like the ` quote character) rather than as a string quote character. See MySQL documentation.
• ERROR_FOR_DIVISION_BY_ZERO: Produce an error for divisions by zero. See MySQL documentation.
• HIGH_NOT_PRECEDENCE: Give NOT higher precedence in negation than it has in non-high-precedence mode. See MySQL documentation.
• IGNORE_SPACE: Allow spaces between a function name and the ( character. See MySQL documentation.
• NO_AUTO_VALUE_ON_ZERO: Do not reset the AUTO_INCREMENT column to 0 when inserting 0 into it. See MySQL documentation.
• NO_BACKSLASH_ESCAPES: Disable the use of the backslash character (\) as an escape character within strings. See MySQL documentation.
• NO_ENGINE_SUBSTITUTION: Do not substitute the default storage engine when a statement specifies a storage engine that is disabled or not compiled in. See MySQL documentation.
• NO_UNSIGNED_SUBTRACTION: Disable unsigned subtraction so that subtraction results are always signed. See MySQL documentation.
• NO_ZERO_DATE: Disable the MySQL-specific date 0000-00-00. See MySQL documentation.
• NO_ZERO_IN_DATE: Disable month or day parts of 0 in dates. See MySQL documentation.
• ONLY_FULL_GROUP_BY: Reject queries for which the select list, HAVING condition, or ORDER BY list refer to non-aggregated columns that are not named in the GROUP BY clause. See MySQL documentation.
• PAD_CHAR_TO_FULL_LENGTH: Pad CHAR column values with spaces to the full column length when retrieving them. See MySQL documentation.
• PIPES_AS_CONCAT: Treat \|\| as a string concatenation operator rather than as OR. See MySQL documentation.
• REAL_AS_FLOAT: Treat REAL as a synonym for FLOAT rather than DOUBLE. See MySQL documentation.
• STRICT_ALL_TABLES: Strict mode for all storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• STRICT_TRANS_TABLES: Strict mode for transactional storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• TIME_TRUNCATE_FRACTIONAL: Causes fractional seconds to be truncated rather than rounded when inserting into a column that has a data type with a fractional seconds part. See MySQL documentation.
• ANSI: Equivalent to REAL_AS_FLOAT, PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE, and ONLY_FULL_GROUP_BY. See MySQL documentation.
• TRADITIONAL: Equivalent to STRICT_TRANS_TABLES, STRICT_ALL_TABLES, NO_ZERO_IN_DATE, NO_ZERO_DATE, ERROR_FOR_DIVISION_BY_ZERO, and NO_ENGINE_SUBSTITUTION. See MySQL documentation.
• NO_DIR_IN_CREATE: Prevent the use of .. in directory paths in CREATE TABLE statements. See MySQL documentation.

max_allowed_packet

google.protobuf.Int64Value

The maximum size in bytes of one packet.
See MySQL documentation for details.

Acceptable values are 1048576 to 1073741824, inclusive.

default_authentication_plugin

enum AuthPlugin

Authentication plugin used in the managed MySQL cluster.
See MySQL documentation for details.

• MYSQL_NATIVE_PASSWORD: Using Native Pluggable Authentication.
• CACHING_SHA2_PASSWORD: Using Caching SHA-2 Pluggable Authentication.
• SHA256_PASSWORD: Using SHA-256 Pluggable Authentication.
• MYSQL_NO_LOGIN: Use MYSQL_NO_LOGIN Pluggable Authentication.
• MDB_IAMPROXY_AUTH: Use IAM Pluggable Authentication.

innodb_flush_log_at_trx_commit

google.protobuf.Int64Value

Transaction log flush behaviour.
See MySQL documentation for details.

Acceptable values are 1 to 2, inclusive.

innodb_lock_wait_timeout

google.protobuf.Int64Value

Max time in seconds for a transaction to wait for a row lock.
See MySQL documentation for details.

Acceptable values are 1 to 28800, inclusive.

transaction_isolation

enum TransactionIsolation

Default transaction isolation level.
See MySQL documentation for details.

• READ_COMMITTED: Read committed isolation level. A consistent read within the same transaction reads the snapshot established by the first read.
• REPEATABLE_READ: Repeatable read isolation level. All consistent reads within the same transaction read the snapshot established by the first read.
• SERIALIZABLE: Serializable isolation level. All statements implicitly convert to SELECT ... FOR SHARE if autocommit is disabled.

innodb_print_all_deadlocks

google.protobuf.BoolValue

Print information about deadlocks in error log.
See MySQL documentation for details.

net_read_timeout

google.protobuf.Int64Value

The number of seconds to wait for more data from a connection before aborting the read.
See MySQL documentation for details.

Acceptable values are 1 to 1200, inclusive.

net_write_timeout

google.protobuf.Int64Value

The number of seconds to wait for a block to be written to a connection before aborting the write.
See MySQL documentation for details.

Acceptable values are 1 to 1200, inclusive.

group_concat_max_len

google.protobuf.Int64Value

The maximum permitted result length in bytes for the GROUP_CONCAT() function.
See MySQL documentation for details.

Acceptable values are 4 to 33554432, inclusive.

tmp_table_size

google.protobuf.Int64Value

The maximum size of internal in-memory temporary tables.
See MySQL documentation for details.

Acceptable values are 1024 to 536870912, inclusive.

max_heap_table_size

google.protobuf.Int64Value

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
See MySQL documentation for details.

Acceptable values are 16384 to 536870912, inclusive.

default_time_zone

string

The servers default time zone.
See MySQL documentation for details.

character_set_server

string

The servers default character set.
See MySQL documentation for details.

collation_server

string

The server default collation.
See MySQL documentation for details.

innodb_adaptive_hash_index

google.protobuf.BoolValue

Enables InnoDB adaptive hash index.
See MySQL documentation for details.

innodb_numa_interleave

google.protobuf.BoolValue

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.
See MySQL documentation for details.

innodb_log_buffer_size

google.protobuf.Int64Value

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.
See MySQL documentation for details.

Acceptable values are 1048576 to 268435456, inclusive.

innodb_log_file_size

google.protobuf.Int64Value

The size in bytes of the single InnoDB Redo log file.
See MySQL documentation for details.

Acceptable values are 268435456 to 8589934592, inclusive.

innodb_io_capacity

google.protobuf.Int64Value

Limits IO available for InnoDB background tasks.
See MySQL documentation for details.

Acceptable values are 100 to 100000, inclusive.

innodb_io_capacity_max

google.protobuf.Int64Value

Limits IO available for InnoDB background tasks.
See MySQL documentation for details.

Acceptable values are 100 to 100000, inclusive.

innodb_read_io_threads

google.protobuf.Int64Value

The number of I/O threads for read operations in InnoDB.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodb_write_io_threads

google.protobuf.Int64Value

The number of I/O threads for write operations in InnoDB.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodb_purge_threads

google.protobuf.Int64Value

The number of background threads devoted to the InnoDB purge operation.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodb_thread_concurrency

google.protobuf.Int64Value

Defines the maximum number of threads permitted inside of InnoDB.
See MySQL documentation for details.

Acceptable values are 0 to 1000, inclusive.

innodb_temp_data_file_max_size

google.protobuf.Int64Value

Limits the max size of InnoDB temp tablespace.
See MySQL documentation for details.

Acceptable values are 1073741824 to 107374182400, inclusive.

thread_cache_size

google.protobuf.Int64Value

How many threads the server should cache for reuse.
See MySQL documentation for details.

Acceptable values are 10 to 10000, inclusive.

thread_stack

google.protobuf.Int64Value

The stack size for each thread. The default is large enough for normal operation.
See MySQL documentation for details.

Acceptable values are 131072 to 16777216, inclusive.

join_buffer_size

google.protobuf.Int64Value

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that don't use indexes and thus perform full table scans.
See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.

sort_buffer_size

google.protobuf.Int64Value

Each session that must perform a sort allocates a buffer of this size.
See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.

table_definition_cache

google.protobuf.Int64Value

The number of table definitions that can be stored in the definition cache.
See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.

table_open_cache

google.protobuf.Int64Value

The number of open tables for all threads.
See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.

table_open_cache_instances

google.protobuf.Int64Value

The number of open tables cache instances.
See MySQL documentation for details.

Acceptable values are 1 to 32, inclusive.

explicit_defaults_for_timestamp

google.protobuf.BoolValue

Determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.
See MySQL documentation for details.

auto_increment_increment

google.protobuf.Int64Value

Can be used to control the operation of AUTO_INCREMENT columns.
See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.

auto_increment_offset

google.protobuf.Int64Value

Can be used to control the operation of AUTO_INCREMENT columns.
See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.

sync_binlog

google.protobuf.Int64Value

Controls how often the MySQL server synchronizes the binary log to disk.
See MySQL documentation for details.

Acceptable values are 0 to 4096, inclusive.

binlog_cache_size

google.protobuf.Int64Value

The size of the cache to hold changes to the binary log during a transaction.
See MySQL documentation for details.

Acceptable values are 4096 to 67108864, inclusive.

binlog_group_commit_sync_delay

google.protobuf.Int64Value

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk.
See MySQL documentation for details.

Acceptable values are 0 to 50000, inclusive.

binlog_row_image

enum BinlogRowImage

For MySQL row-based replication, this variable determines how row images are written to the binary log.
See MySQL documentation for details.

• FULL: Log all columns (full row image).
• MINIMAL: Log only changed columns and columns needed to identify the row.
• NOBLOB: Log all columns except BLOB and TEXT columns.

binlog_rows_query_log_events

google.protobuf.BoolValue

When enabled, it causes the server to write informational log events such as row query log events into its binary log.
See MySQL documentation for details.

rpl_semi_sync_master_wait_for_slave_count

google.protobuf.Int64Value

The number of replica acknowledgments the source must receive per transaction before proceeding.
See MySQL documentation for details.

The minimum value is 1.

slave_parallel_type

enum SlaveParallelType

When using a multi-threaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica.
See MySQL documentation for details.

• DATABASE: Transactions are parallelized per database (schema).
• LOGICAL_CLOCK: Transactions are parallelized using the logical clock algorithm based on the binary log group commit.

slave_parallel_workers

google.protobuf.Int64Value

Sets the number of applier threads for executing replication transactions in parallel.
See MySQL documentation for details.

Acceptable values are 0 to 64, inclusive.

regexp_time_limit

google.protobuf.Int64Value

The time limit for regular expression matching operations performed by REGEXP_LIKE and similar functions.
See MySQL documentation for details.

Acceptable values are 0 to 1048576, inclusive.

mdb_preserve_binlog_bytes

google.protobuf.Int64Value

The size of the binary log to hold.

Acceptable values are 1073741824 to 1099511627776, inclusive.

interactive_timeout

google.protobuf.Int64Value

The number of seconds the server waits for activity on an interactive connection before closing it.
See MySQL documentation for details.

Acceptable values are 600 to 86400, inclusive.

wait_timeout

google.protobuf.Int64Value

The number of seconds the server waits for activity on a noninteractive connection before closing it.
See MySQL documentation for details.

Acceptable values are 600 to 86400, inclusive.

mdb_offline_mode_enable_lag

google.protobuf.Int64Value

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data.

Acceptable values are 30 to 86400, inclusive.

mdb_offline_mode_disable_lag

google.protobuf.Int64Value

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'.
Should be less than mdb_offline_mode_enable_lag.

Acceptable values are 10 to 86400, inclusive.

range_optimizer_max_mem_size

google.protobuf.Int64Value

The limit on memory consumption for the range optimizer.
See MySQL documentation for details.

Acceptable values are 60 to 268435456, inclusive.

innodb_online_alter_log_max_size

google.protobuf.Int64Value

The limit in bytes on the size of the temporary log files used during online DDL operations
See MySQL documentation for the variable for details.

Acceptable values are 65536 to 107374182400, inclusive.

innodb_ft_min_token_size

google.protobuf.Int64Value

Minimum length of words that are stored in an InnoDB FULLTEXT index
See MySQL documentation for the variable for details.

Acceptable values are 0 to 16, inclusive.

innodb_ft_max_token_size

google.protobuf.Int64Value

Maximum length of words that are stored in an InnoDB FULLTEXT index
See MySQL documentation for the variable for details.

Acceptable values are 10 to 84, inclusive.

lower_case_table_names

google.protobuf.Int64Value

Table names storage and comparison strategy
See MySQL documentation for the variable for details.

Acceptable values are 0 to 1, inclusive.

slow_query_log

google.protobuf.BoolValue

Manages slow query log.
See MySQL documentation for details.

slow_query_log_always_write_time

google.protobuf.DoubleValue

Query execution time, after which query to be logged unconditionally, that is, log_slow_rate_limit will not apply to it.
See Percona documentation for details.

Acceptable values are 0 to 3600, inclusive.

log_slow_rate_type

enum LogSlowRateType

Specifies slow log granularity for log_slow_rate_limit QUERY or SESSION value.
See Percona documentation for details.

• SESSION: Logging is controlled per session.
• QUERY: Logging is controlled per query.

log_slow_rate_limit

google.protobuf.Int64Value

Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query.
See Percona documentation for details.

Acceptable values are 1 to 1000, inclusive.

log_slow_sp_statements

google.protobuf.BoolValue

When TRUE, statements executed by stored procedures are logged to the slow log.
See Percona documentation for details.

log_slow_filter[]

enum LogSlowFilterType

Filters the slow log by the query's execution plan.
See Percona documentation for details.

• FULL_SCAN: Queries that perform a full table scan.
• FULL_JOIN: Queries that perform a full join (a join without indexes).
• TMP_TABLE: Queries that create an implicit internal temporary table.
• TMP_TABLE_ON_DISK: Queries that create an implicit internal temporary table on disk.
• FILESORT: Queries that use a filesort.
• FILESORT_ON_DISK: Queries that use a filesort on disk.

mdb_priority_choice_max_lag

google.protobuf.Int64Value

Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from".
Should be less than mdb_offline_mode_disable_lag.

Acceptable values are 0 to 86400, inclusive.

innodb_page_size

google.protobuf.Int64Value

Specifies the page size for InnoDB tablespaces.
For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 65536, inclusive.

max_sp_recursion_depth

google.protobuf.Int64Value

The number of times that any given stored procedure may be called recursively.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 255, inclusive.

innodb_compression_level

google.protobuf.Int64Value

The level of zlib compression to use for InnoDB compressed tables and indexes.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 9, inclusive.

binlog_transaction_dependency_tracking

enum BinlogTransactionDependencyTracking

Specifies how the source mysqld generates the dependency information that it writes in the binary log to help replicas determine which transactions can be executed in parallel.
For details, see MySQL documentation for the variable.

• COMMIT_ORDER: Transactions are made dependent based on commit order.
• WRITESET: Transactions are made dependent based on the write set of rows modified by the transaction.
• WRITESET_SESSION: Transactions are made dependent based on the write set and the commit order within a session.

autocommit

google.protobuf.BoolValue

Config specific will be all changes to a table take effect immediately or you must use COMMIT to accept a transaction or ROLLBACK to cancel it.
For details, see MySQL documentation for the variable.

innodb_status_output

google.protobuf.BoolValue

Enables or disables periodic output for the standard InnoDB Monitor.
For details, see MySQL documentation for the variable.

innodb_strict_mode

google.protobuf.BoolValue

When innodb_strict_mode is enabled, InnoDB returns errors rather than warnings when checking for invalid or incompatible table options.
For details, see MySQL documentation for the variable.

innodb_print_lock_wait_timeout_info

google.protobuf.BoolValue

Makes InnoDB to write information about all lock wait timeout errors into the log file.
For details, see Percona documentation for the variable.

log_error_verbosity

google.protobuf.Int64Value

System variable specifies the verbosity for handling events intended for the error log
For details, see MySQL documentation for the variable.

Acceptable values are 2 to 3, inclusive.

max_digest_length

google.protobuf.Int64Value

The maximum number of bytes of memory reserved per session for computation of normalized statement digests.
For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 1048576, inclusive.

lock_wait_timeout

google.protobuf.Int64Value

This variable specifies the timeout in seconds for attempts to acquire metadata locks
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 31536000, inclusive.

max_prepared_stmt_count

google.protobuf.Int64Value

This variable limits the total number of prepared statements in the server.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 4194304, inclusive.

optimizer_switch

string

The system variable enables control over optimizer behavior.
For details, see MySQL documentation for the variable
https://dev.mysql.com/doc/refman/8.0/en/switchable-optimizations.html

optimizer_search_depth

google.protobuf.Int64Value

The maximum depth of search performed by the query optimizer
For details, see MySQL documentation for the variable

Acceptable values are 0 to 62, inclusive.

userstat

google.protobuf.BoolValue

Enables or disables collection of statistics
For details, see Percona documentation for the variable.

max_execution_time

google.protobuf.Int64Value

The execution timeout for SELECT statements, in milliseconds. If the value is 0, timeouts are not enabled.
For details, see MySQL documentation for the variable

Acceptable values are 0 to 4294967295, inclusive.

audit_log_policy

enum AuditLogPolicy

The policy controlling how the audit log plugin writes events to its log file
For details, see MySQL documentation for the variable

• ALL: Log all events.
• LOGINS: Log only login events.
• QUERIES: Log only query events.
• NONE: Do not log events.

replication_sender_observe_commit_only

google.protobuf.BoolValue

Limit callbacks to improve performance for semisynchronous replication
For details, see MySQL documentation for the variable.

replication_optimize_for_static_plugin_config

google.protobuf.BoolValue

Use shared locks, and avoid unnecessary lock acquisitions, to improve performance for semisynchronous replication
For details, see MySQL documentation for the variable.

innodb_lru_scan_depth

google.protobuf.Int64Value

A parameter that influences the algorithms and heuristics for the flush operation for the InnoDB buffer pool
For details, see MySQL documentation for the variable

Acceptable values are 100 to 4294967295, inclusive.

sql_require_primary_key

google.protobuf.BoolValue

Whether statements that create new tables or alter the structure of existing tables enforce the requirement that tables have a primary key
For details, see MySQL documentation for the variable.

mdb_force_ssl

google.protobuf.BoolValue

Force ssl on all hosts (require_secure_transport)

innodb_change_buffering

enum InnodbChangeBuffering

An optimization for change buffering
For details, see MySQL documentation for the variable.

• INNODB_CHANGE_BUFFERING_NONE: Do not buffer any operations.
• INNODB_CHANGE_BUFFERING_INSERTS: Buffer insert operations.
• INNODB_CHANGE_BUFFERING_DELETES: Buffer delete-marking operations.
• INNODB_CHANGE_BUFFERING_CHANGES: Buffer insert and delete-marking operations.
• INNODB_CHANGE_BUFFERING_PURGES: Buffer operations where undo log records are discarded.
• INNODB_CHANGE_BUFFERING_ALL: Buffer all types of eligible operations.

max_write_lock_count

google.protobuf.Int64Value

Permit some pending read lock requests interval
P.S. Should be UInt64, but java fails to handle UInt64 limits
For details, see Percona documentation for the variable.

The minimum value is 1.

innodb_adaptive_hash_index_parts

google.protobuf.Int64Value

Partitions the adaptive hash index search system.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 512, inclusive.

Field

Description

innodb_buffer_pool_size

google.protobuf.Int64Value

Size of the InnoDB buffer pool used for caching table and index data.
For details, see MySQL documentation for the parameter.

The minimum value is 134217728.

max_connections

google.protobuf.Int64Value

The maximum permitted number of simultaneous client connections.
For details, see MySQL documentation for the variable.

Acceptable values are 10 to 100000, inclusive.

long_query_time

google.protobuf.DoubleValue

Time that it takes to process a query before it is considered slow.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 3600, inclusive.

audit_log

google.protobuf.BoolValue

Enable writing of audit log of MySQL.
For details, see MySQL documentation for the variable.

sql_mode[]

enum SQLMode

Server SQL mode of MySQL.
For details, see MySQL documentation for the variable.

• ALLOW_INVALID_DATES: Allow dates where the day or month part is 0. See MySQL documentation.
• ANSI_QUOTES: Treat " as an identifier quote character (like the ` quote character) rather than as a string quote character. See MySQL documentation.
• ERROR_FOR_DIVISION_BY_ZERO: Produce an error for divisions by zero. See MySQL documentation.
• HIGH_NOT_PRECEDENCE: Give NOT higher precedence in negation than it has in non-high-precedence mode. See MySQL documentation.
• IGNORE_SPACE: Allow spaces between a function name and the ( character. See MySQL documentation.
• NO_AUTO_VALUE_ON_ZERO: Do not reset the AUTO_INCREMENT column to 0 when inserting 0 into it. See MySQL documentation.
• NO_BACKSLASH_ESCAPES: Disable the use of the backslash character (\) as an escape character within strings. See MySQL documentation.
• NO_ENGINE_SUBSTITUTION: Do not substitute the default storage engine when a statement specifies a storage engine that is disabled or not compiled in. See MySQL documentation.
• NO_UNSIGNED_SUBTRACTION: Disable unsigned subtraction so that subtraction results are always signed. See MySQL documentation.
• NO_ZERO_DATE: Disable the MySQL-specific date 0000-00-00. See MySQL documentation.
• NO_ZERO_IN_DATE: Disable month or day parts of 0 in dates. See MySQL documentation.
• ONLY_FULL_GROUP_BY: Reject queries for which the select list, HAVING condition, or ORDER BY list refer to non-aggregated columns that are not named in the GROUP BY clause. See MySQL documentation.
• PAD_CHAR_TO_FULL_LENGTH: Pad CHAR column values with spaces to the full column length when retrieving them. See MySQL documentation.
• PIPES_AS_CONCAT: Treat \|\| as a string concatenation operator rather than as OR. See MySQL documentation.
• REAL_AS_FLOAT: Treat REAL as a synonym for FLOAT rather than DOUBLE. See MySQL documentation.
• STRICT_ALL_TABLES: Strict mode for all storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• STRICT_TRANS_TABLES: Strict mode for transactional storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• TIME_TRUNCATE_FRACTIONAL: Causes fractional seconds to be truncated rather than rounded when inserting into a column that has a data type with a fractional seconds part. See MySQL documentation.
• ANSI: Equivalent to REAL_AS_FLOAT, PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE, and ONLY_FULL_GROUP_BY. See MySQL documentation.
• TRADITIONAL: Equivalent to STRICT_TRANS_TABLES, STRICT_ALL_TABLES, NO_ZERO_IN_DATE, NO_ZERO_DATE, ERROR_FOR_DIVISION_BY_ZERO, and NO_ENGINE_SUBSTITUTION. See MySQL documentation.
• NO_DIR_IN_CREATE: Prevent the use of .. in directory paths in CREATE TABLE statements. See MySQL documentation.

max_allowed_packet

google.protobuf.Int64Value

The maximum size in bytes of one packet.
For details, see MySQL documentation for the variable.

Acceptable values are 1048576 to 1073741824, inclusive.

innodb_flush_log_at_trx_commit

google.protobuf.Int64Value

Transaction log flush behaviour.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 2, inclusive.

innodb_lock_wait_timeout

google.protobuf.Int64Value

Max time in seconds for a transaction to wait for a row lock
For details, see MySQL documentation for the variable

Acceptable values are 1 to 28800, inclusive.

transaction_isolation

enum TransactionIsolation

Default transaction isolation level.
For details, see MySQL documentation for the variable

• READ_COMMITTED: Read committed isolation level. A consistent read within the same transaction reads the snapshot established by the first read.
• REPEATABLE_READ: Repeatable read isolation level. All consistent reads within the same transaction read the snapshot established by the first read.
• SERIALIZABLE: Serializable isolation level. All statements implicitly convert to SELECT ... FOR SHARE if autocommit is disabled.

innodb_print_all_deadlocks

google.protobuf.BoolValue

Print information about deadlocks in error log
For details, see MySQL documentation for the variable

net_read_timeout

google.protobuf.Int64Value

The number of seconds to wait for more data from a connection before aborting the read.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 1200, inclusive.

net_write_timeout

google.protobuf.Int64Value

The number of seconds to wait for a block to be written to a connection before aborting the write.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 1200, inclusive.

group_concat_max_len

google.protobuf.Int64Value

The maximum permitted result length in bytes for the GROUP_CONCAT() function.
For details, see MySQL documentation for the variable

Acceptable values are 4 to 33554432, inclusive.

tmp_table_size

google.protobuf.Int64Value

The maximum size of internal in-memory temporary tables.
For details, see MySQL documentation for the variable

Acceptable values are 1024 to 536870912, inclusive.

max_heap_table_size

google.protobuf.Int64Value

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
For details, see MySQL documentation for the variable

Acceptable values are 16384 to 536870912, inclusive.

default_time_zone

string

The servers default time zone.
For details, see MySQL documentation for the variable

character_set_server

string

The servers default character set.
For details, see MySQL documentation for the variable

collation_server

string

Set the default server collation.
For details, see MySQL documentation for the variable

innodb_adaptive_hash_index

google.protobuf.BoolValue

Enables Innodb adaptive hash index
For details, see MySQL documentation for the variable

innodb_numa_interleave

google.protobuf.BoolValue

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.
For details, see MySQL documentation for the variable

innodb_log_buffer_size

google.protobuf.Int64Value

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.
For details, see MySQL documentation for the variable

Acceptable values are 1048576 to 268435456, inclusive.

innodb_log_file_size

google.protobuf.Int64Value

The size in bytes of the single Innodb Redo log file.
For details, see MySQL documentation for the variable

Acceptable values are 268435456 to 8589934592, inclusive.

innodb_io_capacity

google.protobuf.Int64Value

Limits IO available for InnoDB background tasks
For details, see MySQL documentation for the variable

Acceptable values are 100 to 100000, inclusive.

innodb_io_capacity_max

google.protobuf.Int64Value

Limits IO available for InnoDB background tasks
For details, see MySQL documentation for the variable

Acceptable values are 100 to 100000, inclusive.

innodb_read_io_threads

google.protobuf.Int64Value

The number of I/O threads for read operations in InnoDB.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

innodb_write_io_threads

google.protobuf.Int64Value

The number of I/O threads for write operations in InnoDB.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

innodb_purge_threads

google.protobuf.Int64Value

The number of background threads devoted to the InnoDB purge operation.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

innodb_thread_concurrency

google.protobuf.Int64Value

Defines the maximum number of threads permitted inside of InnoDB.
For details, see MySQL documentation for the variable

Acceptable values are 0 to 1000, inclusive.

innodb_temp_data_file_max_size

google.protobuf.Int64Value

Limits the max size of InnoDB temp tablespace
For details, see MySQL documentation for the variable

Acceptable values are 1073741824 to 107374182400, inclusive.

thread_cache_size

google.protobuf.Int64Value

How many threads the server should cache for reuse.
For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

thread_stack

google.protobuf.Int64Value

The stack size for each thread. The default is large enough for normal operation.
For details, see MySQL documentation for the variable.

Acceptable values are 131072 to 16777216, inclusive.

join_buffer_size

google.protobuf.Int64Value

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that don't use indexes and thus perform full table scans.
For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 16777216, inclusive.

sort_buffer_size

google.protobuf.Int64Value

Each session that must perform a sort allocates a buffer of this size.
For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 16777216, inclusive.

table_definition_cache

google.protobuf.Int64Value

The number of table definitions that can be stored in the definition cache.
For details, see MySQL documentation for the variable.

Acceptable values are 400 to 524288, inclusive.

table_open_cache

google.protobuf.Int64Value

The number of open tables for all threads.
For details, see MySQL documentation for the variable.

Acceptable values are 400 to 524288, inclusive.

table_open_cache_instances

google.protobuf.Int64Value

The number of open tables cache instances.
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 32, inclusive.

explicit_defaults_for_timestamp

google.protobuf.BoolValue

This system variable determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.
For details, see MySQL documentation for the variable.

auto_increment_increment

google.protobuf.Int64Value

Can be used to control the operation of AUTO_INCREMENT columns.
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 65535, inclusive.

auto_increment_offset

google.protobuf.Int64Value

Can be used to control the operation of AUTO_INCREMENT columns.
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 65535, inclusive.

sync_binlog

google.protobuf.Int64Value

Controls how often the MySQL server synchronizes the binary log to disk.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 4096, inclusive.

binlog_cache_size

google.protobuf.Int64Value

The size of the cache to hold changes to the binary log during a transaction.
For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 67108864, inclusive.

binlog_group_commit_sync_delay

google.protobuf.Int64Value

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 50000, inclusive.

binlog_row_image

enum BinlogRowImage

For MySQL row-based replication, this variable determines how row images are written to the binary log.
For details, see MySQL documentation for the variable.

• FULL: Log all columns (full row image).
• MINIMAL: Log only changed columns and columns needed to identify the row.
• NOBLOB: Log all columns except BLOB and TEXT columns.

binlog_rows_query_log_events

google.protobuf.BoolValue

When enabled, it causes the server to write informational log events such as row query log events into its binary log.
For details, see MySQL documentation for the variable.

rpl_semi_sync_master_wait_for_slave_count

google.protobuf.Int64Value

The number of replica acknowledgments the source must receive per transaction before proceeding.
For details, see MySQL documentation for the variable.

The minimum value is 1.

slave_parallel_type

enum SlaveParallelType

When using a multithreaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica.
For details, see MySQL documentation for the variable.

• DATABASE: Transactions are parallelized per database (schema).
• LOGICAL_CLOCK: Transactions are parallelized using the logical clock algorithm based on the binary log group commit.

slave_parallel_workers

google.protobuf.Int64Value

Sets the number of applier threads for executing replication transactions in parallel.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 64, inclusive.

regexp_time_limit

google.protobuf.Int64Value

The time limit for regular expression matching operations performed by REGEXP_LIKE and similar functions
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 1048576, inclusive.

mdb_preserve_binlog_bytes

google.protobuf.Int64Value

The size of the binary log to hold.

Acceptable values are 1073741824 to 1099511627776, inclusive.

interactive_timeout

google.protobuf.Int64Value

The number of seconds the server waits for activity on an interactive connection before closing it.
For details, see MySQL documentation for the variable.

Acceptable values are 600 to 86400, inclusive.

wait_timeout

google.protobuf.Int64Value

The number of seconds the server waits for activity on a noninteractive connection before closing it.
For details, see MySQL documentation for the variable.

Acceptable values are 600 to 86400, inclusive.

mdb_offline_mode_enable_lag

google.protobuf.Int64Value

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data.

Acceptable values are 30 to 86400, inclusive.

mdb_offline_mode_disable_lag

google.protobuf.Int64Value

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'.
Should be less than mdb_offline_mode_enable_lag.

Acceptable values are 10 to 86400, inclusive.

range_optimizer_max_mem_size

google.protobuf.Int64Value

The limit on memory consumption for the range optimizer.
For details, see MySQL documentation for the variable.

Acceptable values are 60 to 268435456, inclusive.

innodb_online_alter_log_max_size

google.protobuf.Int64Value

The limit in bytes on the size of the temporary log files used during online DDL operations
For details, see MySQL documentation for the variable.

Acceptable values are 65536 to 107374182400, inclusive.

innodb_ft_min_token_size

google.protobuf.Int64Value

Minimum length of words that are stored in an InnoDB FULLTEXT index
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 16, inclusive.

innodb_ft_max_token_size

google.protobuf.Int64Value

Maximum length of words that are stored in an InnoDB FULLTEXT index
For details, see MySQL documentation for the variable.

Acceptable values are 10 to 84, inclusive.

lower_case_table_names

google.protobuf.Int64Value

Table names storage and comparison strategy
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 1, inclusive.

slow_query_log

google.protobuf.BoolValue

Manages slow query log
For details, see MySQL documentation for the variable.

slow_query_log_always_write_time

google.protobuf.DoubleValue

Query execution time, after which query to be logged unconditionally, that is, log_slow_rate_limit will not apply to it
For details, see Percona documentation for the variable.

Acceptable values are 0 to 3600, inclusive.

log_slow_rate_type

enum LogSlowRateType

Specifies slow log granularity for log_slow_rate_limit: QUERY or SESSION
For details, see Percona documentation for the variable.

• SESSION: Logging is controlled per session.
• QUERY: Logging is controlled per query.

log_slow_rate_limit

google.protobuf.Int64Value

Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query.
For details, see Percona documentation for the variable.

Acceptable values are 1 to 1000, inclusive.

log_slow_sp_statements

google.protobuf.BoolValue

When TRUE, statements executed by stored procedures are logged to the slow log
For details, see Percona documentation for the variable.

log_slow_filter[]

enum LogSlowFilterType

Filters the slow log by the query's execution plan
For details, see Percona documentation for the variable.

• FULL_SCAN: Queries that perform a full table scan.
• FULL_JOIN: Queries that perform a full join (a join without indexes).
• TMP_TABLE: Queries that create an implicit internal temporary table.
• TMP_TABLE_ON_DISK: Queries that create an implicit internal temporary table on disk.
• FILESORT: Queries that use a filesort.
• FILESORT_ON_DISK: Queries that use a filesort on disk.

mdb_priority_choice_max_lag

google.protobuf.Int64Value

Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from".
Should be less than mdb_offline_mode_disable_lag.

Acceptable values are 0 to 86400, inclusive.

innodb_page_size

google.protobuf.Int64Value

Specifies the page size for InnoDB tablespaces.
For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 65536, inclusive.

max_sp_recursion_depth

google.protobuf.Int64Value

The number of times that any given stored procedure may be called recursively.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 255, inclusive.

innodb_compression_level

google.protobuf.Int64Value

The level of zlib compression to use for InnoDB compressed tables and indexes.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 9, inclusive.

autocommit

google.protobuf.BoolValue

Config specific will be all changes to a table take effect immediately or you must use COMMIT to accept a transaction or ROLLBACK to cancel it.
For details, see MySQL documentation for the variable.

innodb_status_output

google.protobuf.BoolValue

Enables or disables periodic output for the standard InnoDB Monitor.
For details, see MySQL documentation for the variable.

innodb_strict_mode

google.protobuf.BoolValue

When innodb_strict_mode is enabled, InnoDB returns errors rather than warnings when checking for invalid or incompatible table options.
For details, see MySQL documentation for the variable.

innodb_print_lock_wait_timeout_info

google.protobuf.BoolValue

Makes InnoDB to write information about all lock wait timeout errors into the log file.
For details, see Percona documentation for the variable.

log_error_verbosity

google.protobuf.Int64Value

System variable specifies the verbosity for handling events intended for the error log
For details, see MySQL documentation for the variable.

Acceptable values are 2 to 3, inclusive.

max_digest_length

google.protobuf.Int64Value

The maximum number of bytes of memory reserved per session for computation of normalized statement digests.
For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 1048576, inclusive.

lock_wait_timeout

google.protobuf.Int64Value

This variable specifies the timeout in seconds for attempts to acquire metadata locks
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 31536000, inclusive.

max_prepared_stmt_count

google.protobuf.Int64Value

This variable limits the total number of prepared statements in the server.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 4194304, inclusive.

optimizer_switch

string

The system variable enables control over optimizer behavior.
For details, see [MySQL documentation for the variable]
https://dev.mysql.com/doc/refman/8.4/en/server-system-variables.html#sysvar_optimizer_switch
https://dev.mysql.com/doc/refman/8.4/en/switchable-optimizations.html

optimizer_search_depth

google.protobuf.Int64Value

The maximum depth of search performed by the query optimizer
For details, see MySQL documentation for the variable

Acceptable values are 0 to 62, inclusive.

userstat

google.protobuf.BoolValue

Enables or disables collection of statistics
For details, see Percona documentation for the variable.

max_execution_time

google.protobuf.Int64Value

The execution timeout for SELECT statements, in milliseconds. If the value is 0, timeouts are not enabled.
For details, see MySQL documentation for the variable

Acceptable values are 0 to 4294967295, inclusive.

audit_log_policy

enum AuditLogPolicy

The policy controlling how the audit log plugin writes events to its log file
For details, see MySQL documentation for the variable

• ALL: Log all events.
• LOGINS: Log only login events.
• QUERIES: Log only query events.
• NONE: Do not log events.

replication_sender_observe_commit_only

google.protobuf.BoolValue

Limit callbacks to improve performance for semisynchronous replication
For details, see Percona documentation for the variable.

replication_optimize_for_static_plugin_config

google.protobuf.BoolValue

Use shared locks, and avoid unnecessary lock acquisitions, to improve performance for semisynchronous replication
For details, see Percona documentation for the variable.

innodb_lru_scan_depth

google.protobuf.Int64Value

A parameter that influences the algorithms and heuristics for the flush operation for the InnoDB buffer pool
For details, see MySQL documentation for the variable

Acceptable values are 100 to 4294967295, inclusive.

sql_require_primary_key

google.protobuf.BoolValue

Whether statements that create new tables or alter the structure of existing tables enforce the requirement that tables have a primary key
For details, see Percona documentation for the variable.

mdb_use_async_replication

google.protobuf.BoolValue

Enable async replication

mdb_async_allowed_lag

google.protobuf.Int64Value

Async replication allowed lag (seconds)

Acceptable values are 0 to 86400, inclusive.

mdb_force_ssl

google.protobuf.BoolValue

Force ssl on all hosts (require_secure_transport)

innodb_change_buffering

enum InnodbChangeBuffering

An optimization for change buffering
For details, see Percona documentation for the variable.

• INNODB_CHANGE_BUFFERING_NONE: Do not buffer any operations.
• INNODB_CHANGE_BUFFERING_INSERTS: Buffer insert operations.
• INNODB_CHANGE_BUFFERING_DELETES: Buffer delete-marking operations.
• INNODB_CHANGE_BUFFERING_CHANGES: Buffer insert and delete-marking operations.
• INNODB_CHANGE_BUFFERING_PURGES: Buffer operations where undo log records are discarded.
• INNODB_CHANGE_BUFFERING_ALL: Buffer all types of eligible operations.

max_write_lock_count

google.protobuf.Int64Value

Permit some pending read lock requests interval
P.S. Should be UInt64, but java fails to handle UInt64 limits
For details, see Percona documentation for the variable.

The minimum value is 1.

innodb_adaptive_hash_index_parts

google.protobuf.Int64Value

Partitions the adaptive hash index search system.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 512, inclusive.

Field

Description

resource_preset_id

string

ID of the resource preset that defines available computational resources (vCPU, RAM, etc.) for a cluster host.
All available presets are listed in the documentation.

disk_size

int64

Volume of the storage (for each cluster host, in bytes).

disk_type_id

string

Type of the storage.
Possible values:

• network-hdd - standard network storage
• network-ssd - fast network storage
• network-ssd-nonreplicated - fast network nonreplicated storage
• local-ssd - fast local storage.
  See the documentation for details.

Field

Description

data_lens

bool

Allows access from DataLens.
See the documentation for details.

web_sql

bool

Allows SQL queries to the cluster databases from management console.
See the documentation for details.

data_transfer

bool

Allow access for DataTransfer.

yandex_query

bool

Allow access for YandexQuery.

Field

Description

enabled

bool

Flag that shows if performance statistics gathering is enabled for the cluster.

sessions_sampling_interval

int64

Interval (in seconds) for my_session sampling.

Acceptable values are 1 to 86400, inclusive.

statements_sampling_interval

int64

Interval (in seconds) for my_statements sampling.

Acceptable values are 1 to 86400, inclusive.

Field

Description

planned_usage_threshold

int64

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

Acceptable values are 0 to 100, inclusive.

emergency_usage_threshold

int64

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

Acceptable values are 0 to 100, inclusive.

disk_size_limit

int64

Limit on how large the storage for database instances can automatically grow, in bytes.

Field

Description

zone_id

string

ID of the availability zone where the host resides.
To get a list of available zones, make the yandex.cloud.compute.v1.ZoneService.List request.

The maximum string length in characters is 50.

subnet_id

string

ID of the subnet to assign to the host.
This subnet should be a part of the cluster network (the network ID is specified in the ClusterService.CreateClusterRequest.network_id).

The maximum string length in characters is 50.

assign_public_ip

bool

Option that enables public IP address for the host so that the host can be accessed from the internet.
After a host has been created, this setting cannot be changed.
To remove an assigned public IP address, or to assign a public IP address to a host without one, recreate the host with the appropriate assign_public_ip value set.
Possible values:

• false - don't assign a public IP address to the host.
• true - assign a public IP address to the host.

replication_source

string

Host.name of the host to be used as the replication source (for cascading replication).

backup_priority

int64

Host backup priority

Acceptable values are 0 to 100, inclusive.

priority

int64

Host master promotion priority

Acceptable values are 0 to 100, inclusive.

Field

Description

anytime

AnytimeMaintenanceWindow

Maintenance operation can be scheduled anytime.

Includes only one of the fields anytime, weekly_maintenance_window.

The maintenance policy in effect.

weekly_maintenance_window

WeeklyMaintenanceWindow

Maintenance operation can be scheduled on a weekly basis.

Includes only one of the fields anytime, weekly_maintenance_window.

The maintenance policy in effect.

Field

Description

Empty

Field

Description

day

enum WeekDay

Day of the week (in DDD format).

• MON
• TUE
• WED
• THU
• FRI
• SAT
• SUN

hour

int64

Hour of the day in UTC (in HH format).

Acceptable values are 1 to 24, inclusive.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Any

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.