com.gpudb.protocol

Class CreateResourceGroupRequest

java.lang.Object

com.gpudb.protocol.CreateResourceGroupRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.createResourceGroup(CreateResourceGroupRequest).

Creates a new resource group to facilitate resource management.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateResourceGroupRequest.Options Optional parameters.
static class	CreateResourceGroupRequest.Ranking Indicates the relative ranking among existing resource groups where this new resource group will be placed.
static class	CreateResourceGroupRequest.TierAttributes Optional map containing tier names and their respective attribute group limits.

Constructor Summary

Constructors

Constructor and Description
CreateResourceGroupRequest() Constructs a CreateResourceGroupRequest object with default parameters.
CreateResourceGroupRequest(String name, Map<String,Map<String,String>> tierAttributes, String ranking, String adjoiningResourceGroup, Map<String,String> options) Constructs a CreateResourceGroupRequest 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.
String	getAdjoiningResourceGroup()
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()
Map<String,String>	getOptions()
String	getRanking()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
Map<String,Map<String,String>>	getTierAttributes()
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.
CreateResourceGroupRequest	setAdjoiningResourceGroup(String adjoiningResourceGroup)
CreateResourceGroupRequest	setName(String name)
CreateResourceGroupRequest	setOptions(Map<String,String> options)
CreateResourceGroupRequest	setRanking(String ranking)
CreateResourceGroupRequest	setTierAttributes(Map<String,Map<String,String>> tierAttributes)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateResourceGroupRequest

public CreateResourceGroupRequest()

Constructs a CreateResourceGroupRequest object with default parameters.

CreateResourceGroupRequest

public CreateResourceGroupRequest(String name,
                                  Map<String,Map<String,String>> tierAttributes,
                                  String ranking,
                                  String adjoiningResourceGroup,
                                  Map<String,String> options)

Constructs a CreateResourceGroupRequest object with the specified parameters.

Parameters:

name - Name of the group to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match existing resource group name.

tierAttributes - Optional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers. For instance, to set max VRAM capacity to 1GB and max RAM capacity to 10GB, use: {'VRAM':{'max_memory':'1000000000'}, 'RAM':{'max_memory':'10000000000'}}

• MAX_MEMORY: Maximum amount of memory usable in the given tier at one time for this group.

The default value is an empty Map.

ranking - Indicates the relative ranking among existing resource groups where this new resource group will be placed. When using before or after, specify which resource group this one will be inserted before or after in adjoiningResourceGroup. Supported values:

• FIRST
• LAST
• BEFORE
• AFTER

adjoiningResourceGroup - If ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. The default value is ''.

options - Optional parameters.

• MAX_CPU_CONCURRENCY: Maximum number of simultaneous threads that will be used to execute a request for this group.
• MAX_DATA: Maximum amount of cumulative ram usage regardless of tier status for this group.
• MAX_SCHEDULING_PRIORITY: Maximum priority of a scheduled task for this group.
• MAX_TIER_PRIORITY: Maximum priority of a tiered object for this group.

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()

Returns:

Name of the group to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match existing resource group name.

setName

public CreateResourceGroupRequest setName(String name)

Parameters:

name - Name of the group to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match existing resource group name.

Returns:

this to mimic the builder pattern.

getTierAttributes

public Map<String,Map<String,String>> getTierAttributes()

Returns:

Optional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers. For instance, to set max VRAM capacity to 1GB and max RAM capacity to 10GB, use: {'VRAM':{'max_memory':'1000000000'}, 'RAM':{'max_memory':'10000000000'}}

• MAX_MEMORY: Maximum amount of memory usable in the given tier at one time for this group.

The default value is an empty Map.

setTierAttributes

public CreateResourceGroupRequest setTierAttributes(Map<String,Map<String,String>> tierAttributes)

Parameters:

tierAttributes - Optional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers. For instance, to set max VRAM capacity to 1GB and max RAM capacity to 10GB, use: {'VRAM':{'max_memory':'1000000000'}, 'RAM':{'max_memory':'10000000000'}}

• MAX_MEMORY: Maximum amount of memory usable in the given tier at one time for this group.

The default value is an empty Map.

Returns:

this to mimic the builder pattern.

getRanking

public String getRanking()

Returns:

Indicates the relative ranking among existing resource groups where this new resource group will be placed. When using before or after, specify which resource group this one will be inserted before or after in adjoiningResourceGroup. Supported values:

• FIRST
• LAST
• BEFORE
• AFTER

setRanking

public CreateResourceGroupRequest setRanking(String ranking)

Parameters:

ranking - Indicates the relative ranking among existing resource groups where this new resource group will be placed. When using before or after, specify which resource group this one will be inserted before or after in adjoiningResourceGroup. Supported values:

• FIRST
• LAST
• BEFORE
• AFTER

Returns:

this to mimic the builder pattern.

getAdjoiningResourceGroup

public String getAdjoiningResourceGroup()

Returns:

If ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. The default value is ''.

setAdjoiningResourceGroup

public CreateResourceGroupRequest setAdjoiningResourceGroup(String adjoiningResourceGroup)

Parameters:

adjoiningResourceGroup - If ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. The default value is ''.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• MAX_CPU_CONCURRENCY: Maximum number of simultaneous threads that will be used to execute a request for this group.
• MAX_DATA: Maximum amount of cumulative ram usage regardless of tier status for this group.
• MAX_SCHEDULING_PRIORITY: Maximum priority of a scheduled task for this group.
• MAX_TIER_PRIORITY: Maximum priority of a tiered object for this group.

The default value is an empty Map.

setOptions

public CreateResourceGroupRequest setOptions(Map<String,String> options)

Parameters:

options - Optional parameters.

• MAX_CPU_CONCURRENCY: Maximum number of simultaneous threads that will be used to execute a request for this group.
• MAX_DATA: Maximum amount of cumulative ram usage regardless of tier status for this group.
• MAX_SCHEDULING_PRIORITY: Maximum priority of a scheduled task for this group.
• MAX_TIER_PRIORITY: Maximum priority of a tiered object for this group.

The default value is an empty Map.

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