com.gpudb.protocol

Class GrantPermissionDirectoryRequest

java.lang.Object

com.gpudb.protocol.GrantPermissionDirectoryRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.grantPermissionDirectory.

Grants a KiFS directory-level permission to a user or role.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrantPermissionDirectoryRequest.Permission A set of string constants for the GrantPermissionDirectoryRequest parameter permission.

Constructor Summary

Constructors

Constructor and Description
GrantPermissionDirectoryRequest() Constructs a GrantPermissionDirectoryRequest object with default parameters.
GrantPermissionDirectoryRequest(String name, String permission, String directoryName, Map<String,String> options) Constructs a GrantPermissionDirectoryRequest 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	getDirectoryName() Name of the KiFS directory to which the permission grants access.
String	getName() Name of the user or role to which the permission will be granted.
Map<String,String>	getOptions() Optional parameters.
String	getPermission() Permission to grant to the user or role.
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.
GrantPermissionDirectoryRequest	setDirectoryName(String directoryName) Name of the KiFS directory to which the permission grants access.
GrantPermissionDirectoryRequest	setName(String name) Name of the user or role to which the permission will be granted.
GrantPermissionDirectoryRequest	setOptions(Map<String,String> options) Optional parameters.
GrantPermissionDirectoryRequest	setPermission(String permission) Permission to grant to the user or role.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GrantPermissionDirectoryRequest

public GrantPermissionDirectoryRequest()

Constructs a GrantPermissionDirectoryRequest object with default parameters.

GrantPermissionDirectoryRequest

public GrantPermissionDirectoryRequest(String name,
                                       String permission,
                                       String directoryName,
                                       Map<String,String> options)

Constructs a GrantPermissionDirectoryRequest object with the specified parameters.

Parameters:

name - Name of the user or role to which the permission will be granted. Must be an existing user or role.

permission - Permission to grant to the user or role. Supported values:

• DIRECTORY_READ: For files in the directory, access to list files, download files, or use files in server side functions
• DIRECTORY_WRITE: Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read access

directoryName - Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories

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 or role to which the permission will be granted. Must be an existing user or role.

Returns:

The current value of name.

setName

public GrantPermissionDirectoryRequest setName(String name)

Name of the user or role to which the permission will be granted. Must be an existing user or role.

Parameters:

name - The new value for name.

Returns:

this to mimic the builder pattern.

getPermission

public String getPermission()

Permission to grant to the user or role. Supported values:

• DIRECTORY_READ: For files in the directory, access to list files, download files, or use files in server side functions
• DIRECTORY_WRITE: Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read access

Returns:

The current value of permission.

setPermission

public GrantPermissionDirectoryRequest setPermission(String permission)

Permission to grant to the user or role. Supported values:

• DIRECTORY_READ: For files in the directory, access to list files, download files, or use files in server side functions
• DIRECTORY_WRITE: Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read access

Parameters:

permission - The new value for permission.

Returns:

this to mimic the builder pattern.

getDirectoryName

public String getDirectoryName()

Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories

Returns:

The current value of directoryName.

setDirectoryName

public GrantPermissionDirectoryRequest setDirectoryName(String directoryName)

Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories

Parameters:

directoryName - The new value for directoryName.

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 GrantPermissionDirectoryRequest 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