com.gpudb.protocol

Class AlterUserRequest

java.lang.Object

com.gpudb.protocol.AlterUserRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.alterUser.

Alters a user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlterUserRequest.Action A set of string constants for the AlterUserRequest parameter action.

Constructor Summary

Constructors

Constructor and Description
AlterUserRequest() Constructs an AlterUserRequest object with default parameters.
AlterUserRequest(String name, String action, String value, Map<String,String> options) Constructs an AlterUserRequest 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	getAction() Modification operation to be applied to 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 user 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.
String	getValue() The value of the modification, depending on action.
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.
AlterUserRequest	setAction(String action) Modification operation to be applied to the user.
AlterUserRequest	setName(String name) Name of the user to be altered.
AlterUserRequest	setOptions(Map<String,String> options) Optional parameters.
AlterUserRequest	setValue(String value) The value of the modification, depending on action.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlterUserRequest

public AlterUserRequest()

Constructs an AlterUserRequest object with default parameters.

AlterUserRequest

public AlterUserRequest(String name,
                        String action,
                        String value,
                        Map<String,String> options)

Constructs an AlterUserRequest object with the specified parameters.

Parameters:

name - Name of the user to be altered. Must be an existing user.

action - Modification operation to be applied to the user. Supported values:

• SET_ACTIVATED: Is the user allowed to login.
• TRUE: User may login
• FALSE: User may not login
• SET_COMMENT: Sets the comment for an internal user.
• SET_DEFAULT_SCHEMA: Set the default_schema for an internal user. An empty string means the user will have no default schema.
• SET_PASSWORD: Sets the password of the user. The user must be an internal user.
• SET_RESOURCE_GROUP: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group.

value - The value of the modification, depending on action.

options - Optional parameters. 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 user to be altered. Must be an existing user.

Returns:

The current value of name.

setName

public AlterUserRequest setName(String name)

Name of the user to be altered. Must be an existing user.

Parameters:

name - The new value for name.

Returns:

this to mimic the builder pattern.

getAction

public String getAction()

Modification operation to be applied to the user. Supported values:

• SET_ACTIVATED: Is the user allowed to login.
• TRUE: User may login
• FALSE: User may not login
• SET_COMMENT: Sets the comment for an internal user.
• SET_DEFAULT_SCHEMA: Set the default_schema for an internal user. An empty string means the user will have no default schema.
• SET_PASSWORD: Sets the password of the user. The user must be an internal user.
• SET_RESOURCE_GROUP: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group.

Returns:

The current value of action.

setAction

public AlterUserRequest setAction(String action)

Modification operation to be applied to the user. Supported values:

• SET_ACTIVATED: Is the user allowed to login.
• TRUE: User may login
• FALSE: User may not login
• SET_COMMENT: Sets the comment for an internal user.
• SET_DEFAULT_SCHEMA: Set the default_schema for an internal user. An empty string means the user will have no default schema.
• SET_PASSWORD: Sets the password of the user. The user must be an internal user.
• SET_RESOURCE_GROUP: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group.

Parameters:

action - The new value for action.

Returns:

this to mimic the builder pattern.

getValue

public String getValue()

The value of the modification, depending on action.

Returns:

The current value of value.

setValue

public AlterUserRequest setValue(String value)

The value of the modification, depending on action.

Parameters:

value - The new value for value.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters. The default value is an empty Map.

Returns:

The current value of options.

setOptions

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

Optional parameters. 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