com.gpudb.protocol

Class AlterTierRequest

java.lang.Object

com.gpudb.protocol.AlterTierRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class AlterTierRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A 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 Classes

Modifier and Type	Class and Description
static class	AlterTierRequest.Options A set of string constants for the AlterTierRequest parameter options.

Constructor Summary

Constructors

Constructor and Description
AlterTierRequest() Constructs 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 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.
String	getName() Name of the tier to be altered.
Map<String,String>	getOptions() Optional parameters.
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.
AlterTierRequest	setName(String name) Name of the tier to be altered.
AlterTierRequest	setOptions(Map<String,String> options) Optional parameters.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AlterTierRequest

public AlterTierRequest()

Constructs an AlterTierRequest object with default parameters.

AlterTierRequest

public AlterTierRequest(String name,
                        Map<String,String> options)

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 the HIGH_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: If TRUE the 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:
  • TRUE
  • FALSE
  The default value is TRUE.
• RANK: Apply the requested change only to a specific rank. The minimum allowed value is '0'. The maximum allowed value is '10000'.

The default value is an empty Map.

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.

getName

public String getName()

Name of the tier to be altered. Must be an existing tier group name: vram, ram, disk[n], persist, cold[n].

Returns:

The current value of name.

setName

public AlterTierRequest setName(String name)

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 for name.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> 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 the HIGH_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: If TRUE the 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:
  • TRUE
  • FALSE
  The default value is TRUE.
• RANK: Apply the requested change only to a specific rank. The minimum allowed value is '0'. The maximum allowed value is '10000'.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

public AlterTierRequest setOptions(Map<String,String> 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 the HIGH_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: If TRUE the 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:
  • TRUE
  • FALSE
  The default value is TRUE.
• RANK: Apply the requested change only to a specific rank. The minimum allowed value is '0'. The maximum allowed value is '10000'.

The default value is an empty Map.

Parameters:

options - The new value for options.

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