Package com.gpudb.protocol
Class AlterTierRequest
java.lang.Object
com.gpudb.protocol.AlterTierRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecordA set of parameters for
GPUdb.alterTier.
Alters properties of an existing tier to facilitate resource management.
To disable watermark-based eviction, set both HIGH_WATERMARK and LOW_WATERMARK to 100.
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA set of string constants for theAlterTierRequestparameteroptions.Constructor Summary
ConstructorsConstructorDescriptionConstructs an AlterTierRequest object with default parameters.AlterTierRequest(String name, Map<String, String> options) Constructs an AlterTierRequest object with the specified parameters.Method Summary
Modifier and TypeMethodDescriptionbooleanget(int index) This method supports the Avro framework and is not intended to be called directly by the user.static org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.getName()Name of the tier to be altered.Optional parameters.org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.inthashCode()voidThis method supports the Avro framework and is not intended to be called directly by the user.Name of the tier to be altered.setOptions(Map<String, String> options) Optional parameters.toString()
Constructor Details
AlterTierRequest
public AlterTierRequest()Constructs an AlterTierRequest object with default parameters.AlterTierRequest
Constructs an AlterTierRequest object with the specified parameters.Parameters:name- Name of the tier to be altered. Must be an existing tier group name: vram, ram, disk[n], persist, cold[n].options- Optional parameters.CAPACITY: Maximum size in bytes this tier may hold at once, per rank.HIGH_WATERMARK: Threshold of usage of this tier’s resource that once exceeded, will trigger watermark-based eviction from this tier. The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.LOW_WATERMARK: Threshold of resource usage that once fallen below after crossing theHIGH_WATERMARK, will cease watermark-based eviction from this tier. The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.WAIT_TIMEOUT: Timeout in seconds for reading from or writing to this resource. Applies to cold storage tiers only.PERSIST: IfTRUEthe system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values:The default value isTRUE.RANK: Apply the requested change only to a specific rank. The minimum allowed value is ‘0’. The maximum allowed value is ‘10000’.
Map.
Method Details
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.setName
Name of the tier to be altered. Must be an existing tier group name: vram, ram, disk[n], persist, cold[n].Parameters:name- The new value forname.Returns:thisto mimic the builder pattern.getOptions
Optional parameters.CAPACITY: Maximum size in bytes this tier may hold at once, per rank.HIGH_WATERMARK: Threshold of usage of this tier’s resource that once exceeded, will trigger watermark-based eviction from this tier. The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.LOW_WATERMARK: Threshold of resource usage that once fallen below after crossing theHIGH_WATERMARK, will cease watermark-based eviction from this tier. The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.WAIT_TIMEOUT: Timeout in seconds for reading from or writing to this resource. Applies to cold storage tiers only.PERSIST: IfTRUEthe system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values:The default value isTRUE.RANK: Apply the requested change only to a specific rank. The minimum allowed value is ‘0’. The maximum allowed value is ‘10000’.
Map.Returns:The current value ofoptions.setOptions
Optional parameters.CAPACITY: Maximum size in bytes this tier may hold at once, per rank.HIGH_WATERMARK: Threshold of usage of this tier’s resource that once exceeded, will trigger watermark-based eviction from this tier. The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.LOW_WATERMARK: Threshold of resource usage that once fallen below after crossing theHIGH_WATERMARK, will cease watermark-based eviction from this tier. The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.WAIT_TIMEOUT: Timeout in seconds for reading from or writing to this resource. Applies to cold storage tiers only.PERSIST: IfTRUEthe system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values:The default value isTRUE.RANK: Apply the requested change only to a specific rank. The minimum allowed value is ‘0’. The maximum allowed value is ‘10000’.
Map.Parameters:options- The new value foroptions.Returns:thisto 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:getSchemain interfaceorg.apache.avro.generic.GenericContainerReturns:The schema object describing this class.get
This method supports the Avro framework and is not intended to be called directly by the user.Specified by:getin interfaceorg.apache.avro.generic.IndexedRecordParameters:index- the position of the field to getReturns:value of the field with the given index.Throws:put
This method supports the Avro framework and is not intended to be called directly by the user.Specified by:putin interfaceorg.apache.avro.generic.IndexedRecordParameters:index- the position of the field to setvalue- the value to setThrows: