Package com.gpudb.protocol

Class ShowSecurityRequest

java.lang.Object

com.gpudb.protocol.ShowSecurityRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.showSecurity.

Shows security information relating to users and/or roles. If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ShowSecurityRequest()	Constructs a ShowSecurityRequest object with default parameters.
ShowSecurityRequest(List<String> names, Map<String,String> options)	Constructs a ShowSecurityRequest object with the specified parameters.

Method Summary

Modifier and Type	Method	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.
List<String>	getNames()	A list of names of users and/or roles about which security information is requested.
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.
ShowSecurityRequest	setNames(List<String> names)	A list of names of users and/or roles about which security information is requested.
ShowSecurityRequest	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

ShowSecurityRequest

public ShowSecurityRequest()

Constructs a ShowSecurityRequest object with default parameters.

ShowSecurityRequest

public ShowSecurityRequest(List<String> names,
                           Map<String,String> options)

Constructs a ShowSecurityRequest object with the specified parameters.

Parameters:

names - A list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned.

options - Optional parameters.

• SHOW_CURRENT_USER: If TRUE, returns only security information for the current user. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

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.

getNames

public List<String> getNames()

A list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned.

Returns:

The current value of names.

setNames

public ShowSecurityRequest setNames(List<String> names)

A list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned.

Parameters:

names - The new value for names.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• SHOW_CURRENT_USER: If TRUE, returns only security information for the current user. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

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

Optional parameters.

• SHOW_CURRENT_USER: If TRUE, returns only security information for the current user. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

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