AlterSystemPropertiesRequest (Kinetica Java API 5.2.0 API)

java.lang.Object
- com.gpudb.protocol.AlterSystemPropertiesRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class AlterSystemPropertiesRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.alterSystemProperties(AlterSystemPropertiesRequest).

The alter_system_properties endpoint is primarily used to simplify the testing of GPUdb and is not expected to be used during normal execution. Commands are given through the properties_update_map whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AlterSystemPropertiesRequest.PropertyUpdatesMap
Map containing the properties of the system to be updated.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AlterSystemPropertiesRequest.PropertyUpdatesMap` Map containing the properties of the system to be updated.

Constructor Summary

Constructors
Constructor and Description
`AlterSystemPropertiesRequest()` Constructs an AlterSystemPropertiesRequest object with default parameters.
`AlterSystemPropertiesRequest(Map<String,String> propertyUpdatesMap, Map<String,String> options)` Constructs an AlterSystemPropertiesRequest object with the specified parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Object`	`get(int index)` This method supports the Avro framework and is not intended to be called directly by the user.
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`Map<String,String>`	`getOptions()`
`Map<String,String>`	`getPropertyUpdatesMap()`
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`int`	`hashCode()`
`void`	`put(int index, Object value)` This method supports the Avro framework and is not intended to be called directly by the user.
`AlterSystemPropertiesRequest`	`setOptions(Map<String,String> options)`
`AlterSystemPropertiesRequest`	`setPropertyUpdatesMap(Map<String,String> propertyUpdatesMap)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AlterSystemPropertiesRequest
```
public AlterSystemPropertiesRequest()
```
    Constructs an AlterSystemPropertiesRequest object with default parameters.
  - AlterSystemPropertiesRequest
```
public AlterSystemPropertiesRequest(Map<String,String> propertyUpdatesMap,
                                    Map<String,String> options)
```
    Constructs an AlterSystemPropertiesRequest object with the specified parameters.
    Parameters:
    propertyUpdatesMap - Map containing the properties of the system to be updated. Error if empty.
    
    sm_omp_threads: Set the number of sm_omp_threads to the specified integer value.
    kernel_omp_threads: Set the number of kernel_omp_threads to the specified integer value.
    concurrent_kernel_execution: Enables concurrent kernel execution if the value is 'true' and disables it if the value is 'false'.
    chunk_size: Sets the chunk size of all new sets to the specified integer value.
    flush_to_disk: Flushes any changes to any tables to the persistent store. These changes include updates to the vector store, object store, and text search store, Value string is ignored
    clear_cache: Clears cached results. Useful to allow repeated timing of endpoints. Value string is ignored
    communicator_test: Invoke the communicator test and report timing results. Value string is is a comma separated list of = expressions. Expressions are: num_transactions = where is the number of request reply transactions to invoke per test; message_size = where bytes is the size of the messages to send in bytes; check_values = where if enabled is true the value of the messages received are verified.
    set_message_timers_enabled: Enables the communicator test to collect additional timing statistics when the value string is 'true'. Disables the collection when the value string is 'false'
    bulk_add_test: Invoke the bulk_add test and report timing results. Value string is ignored.
    network_speed: Invoke the network speed test and report timing results. Value string is a comma separated list of = expressions. Expressions are: seconds = where time is the time in seconds to run the test; data_size = where is the size in bytes of the block to be transferred; threads = ; to_ranks = where the list of ranks is the ranks that rank 0 will send data to and get data from. If to_ranks is unspecified then all worker ranks are used.
    request_timeout: Number of minutes after which /filter/* and /aggregate/* queries will timeout.
    max_get_records_size: set max_get_records_size. default 20000
    options - Optional parameters.
- Method Detail
  - getClassSchema
```
public static org.apache.avro.Schema getClassSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Returns:
    
    the schema for the class.
  - getPropertyUpdatesMap
```
public Map<String,String> getPropertyUpdatesMap()
```
    Returns:
    Map containing the properties of the system to be updated. Error if empty.
    
    sm_omp_threads: Set the number of sm_omp_threads to the specified integer value.
    kernel_omp_threads: Set the number of kernel_omp_threads to the specified integer value.
    concurrent_kernel_execution: Enables concurrent kernel execution if the value is 'true' and disables it if the value is 'false'.
    chunk_size: Sets the chunk size of all new sets to the specified integer value.
    flush_to_disk: Flushes any changes to any tables to the persistent store. These changes include updates to the vector store, object store, and text search store, Value string is ignored
    clear_cache: Clears cached results. Useful to allow repeated timing of endpoints. Value string is ignored
    communicator_test: Invoke the communicator test and report timing results. Value string is is a comma separated list of = expressions. Expressions are: num_transactions = where is the number of request reply transactions to invoke per test; message_size = where bytes is the size of the messages to send in bytes; check_values = where if enabled is true the value of the messages received are verified.
    set_message_timers_enabled: Enables the communicator test to collect additional timing statistics when the value string is 'true'. Disables the collection when the value string is 'false'
    bulk_add_test: Invoke the bulk_add test and report timing results. Value string is ignored.
    network_speed: Invoke the network speed test and report timing results. Value string is a comma separated list of = expressions. Expressions are: seconds = where time is the time in seconds to run the test; data_size = where is the size in bytes of the block to be transferred; threads = ; to_ranks = where the list of ranks is the ranks that rank 0 will send data to and get data from. If to_ranks is unspecified then all worker ranks are used.
    request_timeout: Number of minutes after which /filter/* and /aggregate/* queries will timeout.
    max_get_records_size: set max_get_records_size. default 20000
  - setPropertyUpdatesMap
```
public AlterSystemPropertiesRequest setPropertyUpdatesMap(Map<String,String> propertyUpdatesMap)
```
    Parameters:
    propertyUpdatesMap - Map containing the properties of the system to be updated. Error if empty.
    
    sm_omp_threads: Set the number of sm_omp_threads to the specified integer value.
    kernel_omp_threads: Set the number of kernel_omp_threads to the specified integer value.
    concurrent_kernel_execution: Enables concurrent kernel execution if the value is 'true' and disables it if the value is 'false'.
    chunk_size: Sets the chunk size of all new sets to the specified integer value.
    flush_to_disk: Flushes any changes to any tables to the persistent store. These changes include updates to the vector store, object store, and text search store, Value string is ignored
    clear_cache: Clears cached results. Useful to allow repeated timing of endpoints. Value string is ignored
    communicator_test: Invoke the communicator test and report timing results. Value string is is a comma separated list of = expressions. Expressions are: num_transactions = where is the number of request reply transactions to invoke per test; message_size = where bytes is the size of the messages to send in bytes; check_values = where if enabled is true the value of the messages received are verified.
    set_message_timers_enabled: Enables the communicator test to collect additional timing statistics when the value string is 'true'. Disables the collection when the value string is 'false'
    bulk_add_test: Invoke the bulk_add test and report timing results. Value string is ignored.
    network_speed: Invoke the network speed test and report timing results. Value string is a comma separated list of = expressions. Expressions are: seconds = where time is the time in seconds to run the test; data_size = where is the size in bytes of the block to be transferred; threads = ; to_ranks = where the list of ranks is the ranks that rank 0 will send data to and get data from. If to_ranks is unspecified then all worker ranks are used.
    request_timeout: Number of minutes after which /filter/* and /aggregate/* queries will timeout.
    max_get_records_size: set max_get_records_size. default 20000
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Returns:
    
    Optional parameters.
  - setOptions
```
public AlterSystemPropertiesRequest setOptions(Map<String,String> options)
```
    Parameters:
    
    options - Optional parameters.
    
    Returns:
    
    this to mimic the builder pattern.
  - getSchema
```
public org.apache.avro.Schema getSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    getSchema in interface org.apache.avro.generic.GenericContainer
    
    Returns:
    
    the schema object describing this class.
  - get
```
public Object get(int index)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    get in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to get
    
    Returns:
    
    value of the field with the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - put
```
public void put(int index,
                Object value)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    put in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to set
    
    value - the value to set
    
    Throws:
    
    IndexOutOfBoundsException
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AlterSystemPropertiesRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlterSystemPropertiesRequest

AlterSystemPropertiesRequest

Method Detail

getClassSchema

getPropertyUpdatesMap

setPropertyUpdatesMap

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode