Kinetica   C#   API  Version 7.2.3.0
AlterSystemProperties.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica
10 {
21  public class AlterSystemPropertiesRequest : KineticaData
22  {
27  public struct PropertyUpdatesMap
28  {
44  public const string CONCURRENT_KERNEL_EXECUTION = "concurrent_kernel_execution";
45 
46  public const string TRUE = "true";
47  public const string FALSE = "false";
48 
53  public const string SUBTASK_CONCURRENCY_LIMIT = "subtask_concurrency_limit";
54 
57  public const string CHUNK_SIZE = "chunk_size";
58 
61  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
62 
65  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
66 
72  public const string EXECUTION_MODE = "execution_mode";
73 
78  public const string EXTERNAL_FILES_DIRECTORY = "external_files_directory";
79 
88  public const string REQUEST_TIMEOUT = "request_timeout";
89 
95  public const string MAX_GET_RECORDS_SIZE = "max_get_records_size";
96 
98  public const string ENABLE_AUDIT = "enable_audit";
99 
102  public const string AUDIT_HEADERS = "audit_headers";
103 
106  public const string AUDIT_BODY = "audit_body";
107 
109  public const string AUDIT_DATA = "audit_data";
110 
113  public const string AUDIT_RESPONSE = "audit_response";
114 
120  public const string SHADOW_AGG_SIZE = "shadow_agg_size";
121 
127  public const string SHADOW_FILTER_SIZE = "shadow_filter_size";
128 
131  public const string ENABLE_OVERLAPPED_EQUI_JOIN = "enable_overlapped_equi_join";
132 
136  public const string ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN = "enable_one_step_compound_equi_join";
137 
143  public const string KAFKA_BATCH_SIZE = "kafka_batch_size";
144 
150  public const string KAFKA_POLL_TIMEOUT = "kafka_poll_timeout";
151 
157  public const string KAFKA_WAIT_TIME = "kafka_wait_time";
158 
178  public const string EGRESS_PARQUET_COMPRESSION = "egress_parquet_compression";
179 
180  public const string UNCOMPRESSED = "uncompressed";
181  public const string SNAPPY = "snappy";
182  public const string GZIP = "gzip";
183 
189  public const string EGRESS_SINGLE_FILE_MAX_SIZE = "egress_single_file_max_size";
190 
195  public const string MAX_CONCURRENT_KERNELS = "max_concurrent_kernels";
196 
201  public const string SYSTEM_METADATA_RETENTION_PERIOD = "system_metadata_retention_period";
202 
209  public const string TCS_PER_TOM = "tcs_per_tom";
210 
217  public const string TPS_PER_TOM = "tps_per_tom";
218 
225  public const string BACKGROUND_WORKER_THREADS = "background_worker_threads";
226 
230  public const string LOG_DEBUG_JOB_INFO = "log_debug_job_info";
231 
236  public const string ENABLE_THREAD_HANG_LOGGING = "enable_thread_hang_logging";
237 
240  public const string AI_ENABLE_RAG = "ai_enable_rag";
241 
243  public const string AI_API_PROVIDER = "ai_api_provider";
244 
246  public const string AI_API_URL = "ai_api_url";
247 
249  public const string AI_API_KEY = "ai_api_key";
250 
252  public const string AI_API_CONNECTION_TIMEOUT = "ai_api_connection_timeout";
253 
255  public const string AI_API_EMBEDDINGS_MODEL = "ai_api_embeddings_model";
256 
259  public const string TELM_PERSIST_QUERY_METRICS = "telm_persist_query_metrics";
260 
262  public const string POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT = "postgres_proxy_idle_connection_timeout";
263 
266  public const string POSTGRES_PROXY_KEEP_ALIVE = "postgres_proxy_keep_alive";
267 
272  public const string KIFS_DIRECTORY_DATA_LIMIT = "kifs_directory_data_limit";
273 
279  public const string COMPRESSION_CODEC = "compression_codec";
280 
286  public const string DISK_AUTO_OPTIMIZE_TIMEOUT = "disk_auto_optimize_timeout";
287 
292  public const string HA_CONSUMER_REPLAY_OFFSET = "ha_consumer_replay_offset";
293  } // end struct PropertyUpdatesMap
294 
298  public struct Options
299  {
312  public const string EVICT_TO_COLD = "evict_to_cold";
313 
314  public const string TRUE = "true";
315  public const string FALSE = "false";
316 
331  public const string PERSIST = "persist";
332  } // end struct Options
333 
712  public IDictionary<string, string> property_updates_map { get; set; } = new Dictionary<string, string>();
713 
753  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
754 
758 
1179  public AlterSystemPropertiesRequest( IDictionary<string, string> property_updates_map,
1180  IDictionary<string, string> options = null)
1181  {
1182  this.property_updates_map = property_updates_map ?? new Dictionary<string, string>();
1183  this.options = options ?? new Dictionary<string, string>();
1184  } // end constructor
1185  } // end class AlterSystemPropertiesRequest
1186 
1190  public class AlterSystemPropertiesResponse : KineticaData
1191  {
1194  public IDictionary<string, string> updated_properties_map { get; set; } = new Dictionary<string, string>();
1195 
1197  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1198  } // end class AlterSystemPropertiesResponse
1199 } // end namespace kinetica
const string POSTGRES_PROXY_KEEP_ALIVE
Enable postgres proxy keep alive.
const string EGRESS_SINGLE_FILE_MAX_SIZE
Max file size (in MB) to allow saving to a single file.
AlterSystemPropertiesRequest()
Constructs an AlterSystemPropertiesRequest object with default parameters.
const string EXECUTION_MODE
Sets the execution_mode for kernel executions to the specified string value.
const string LOG_DEBUG_JOB_INFO
Outputs various job-related information to the rank logs.
const string ENABLE_THREAD_HANG_LOGGING
Log a stack trace for any thread that runs longer than a defined threshold.
const string SYSTEM_METADATA_RETENTION_PERIOD
Sets the system_metadata.retention_period value of the conf.
const string CHUNK_SIZE
Sets the number of records per chunk to be used for all new tables.
const string BACKGROUND_WORKER_THREADS
Size of the worker rank background thread pool.
const string EXTERNAL_FILES_DIRECTORY
Sets the root directory path where external table data files are accessed from.
const string ENABLE_AUDIT
Enable or disable auditing.
const string SHADOW_AGG_SIZE
Size of the shadow aggregate chunk cache in bytes.
const string ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN
Enable the one_step compound-equi-join algorithm.
const string PERSIST
If TRUE the system configuration will be written to disk upon successful application of this request.
const string KAFKA_POLL_TIMEOUT
Maximum time (milliseconds) for each poll to get records from kafka.
const string AUDIT_RESPONSE
Enable or disable auditing of response information.
AlterSystemPropertiesRequest(IDictionary< string, string > property_updates_map, IDictionary< string, string > options=null)
Constructs an AlterSystemPropertiesRequest object with the specified parameters.
const string MAX_GET_RECORDS_SIZE
The maximum number of records the database will serve for a given data retrieval call.
const string EVICT_TO_COLD
If TRUE and evict_columns is specified, the given objects will be evicted to cold storage (if such a ...
IDictionary< string, string > property_updates_map
Map containing the properties of the system to be updated.
const string REQUEST_TIMEOUT
Number of minutes after which filtering (e.g., Kinetica.filter) and aggregating (e....
const string CHUNK_MAX_MEMORY
Indicates the target maximum data size for all columns in a chunk to be used for all new tables.
const string ENABLE_OVERLAPPED_EQUI_JOIN
Enable overlapped-equi-join filter.
const string TCS_PER_TOM
Size of the worker rank data calculation thread pool.
const string MAX_CONCURRENT_KERNELS
Sets the max_concurrent_kernels value of the conf.
const string AI_API_CONNECTION_TIMEOUT
AI API connection timeout in seconds
IDictionary< string, string > info
Additional information.
IDictionary< string, string > options
Optional parameters.
const string HA_CONSUMER_REPLAY_OFFSET
Initializes HA replay from the given timestamp (as milliseconds since unix epoch).
const string AUDIT_BODY
Enable or disable auditing of request bodies.
const string CONCURRENT_KERNEL_EXECUTION
Enables concurrent kernel execution if the value is TRUE and disables it if the value is FALSE.
const string TELM_PERSIST_QUERY_METRICS
Enable or disable persisting of query metrics.
const string KIFS_DIRECTORY_DATA_LIMIT
The default maximum capacity to apply when creating a KiFS directory (bytes).
const string DISK_AUTO_OPTIMIZE_TIMEOUT
Time interval in seconds after which the database will apply optimizations/transformations to persist...
const string TPS_PER_TOM
Size of the worker rank data processing thread pool.
const string CHUNK_COLUMN_MAX_MEMORY
Sets the target maximum data size for each column in a chunk to be used for all new tables.
const string KAFKA_BATCH_SIZE
Maximum number of records to be ingested in a single batch.
const string POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT
Idle connection timeout in seconds
const string AUDIT_HEADERS
Enable or disable auditing of request headers.
const string AUDIT_DATA
Enable or disable auditing of request data.
const string KAFKA_WAIT_TIME
Maximum time (seconds) to buffer records received from kafka before ingestion.
IDictionary< string, string > updated_properties_map
Map of values updated; for speed tests, a map of values measured to the measurement
const string SUBTASK_CONCURRENCY_LIMIT
Sets the maximum number of simultaneous threads allocated to a given request, on each rank.
const string SHADOW_FILTER_SIZE
Size of the shadow filter chunk cache in bytes.
const string COMPRESSION_CODEC
The default compression algorithm applied to any column without a column-level or table-level default...
const string EGRESS_PARQUET_COMPRESSION
Parquet file compression type.