GrantPermissionDirectoryRequest (Kinetica Java API 7.1.10.4 API)

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(GrantPermissionDirectoryRequest).
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
Permission to grant to the user or role.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GrantPermissionDirectoryRequest.Permission` Permission to grant to the user or role.

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

All Methods Static Methods Instance Methods Concrete Methods
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()`
`String`	`getName()`
`Map<String,String>`	`getOptions()`
`String`	`getPermission()`
`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)`
`GrantPermissionDirectoryRequest`	`setName(String name)`
`GrantPermissionDirectoryRequest`	`setOptions(Map<String,String> options)`
`GrantPermissionDirectoryRequest`	`setPermission(String permission)`
`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()
```
    Returns:
    
    Name of the user or role to which the permission will be granted. Must be an existing user or role.
  - setName
```
public GrantPermissionDirectoryRequest setName(String name)
```
    Parameters:
    
    name - Name of the user or role to which the permission will be granted. Must be an existing user or role.
    
    Returns:
    
    this to mimic the builder pattern.
  - getPermission
```
public String getPermission()
```
    Returns:
    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
  - setPermission
```
public GrantPermissionDirectoryRequest setPermission(String permission)
```
    Parameters:
    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
    Returns:
    
    this to mimic the builder pattern.
  - getDirectoryName
```
public String getDirectoryName()
```
    Returns:
    
    Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories
  - setDirectoryName
```
public GrantPermissionDirectoryRequest setDirectoryName(String directoryName)
```
    Parameters:
    
    directoryName - Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Returns:
    
    Optional parameters. The default value is an empty Map.
  - setOptions
```
public GrantPermissionDirectoryRequest setOptions(Map<String,String> options)
```
    Parameters:
    
    options - Optional parameters. 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

Class GrantPermissionDirectoryRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GrantPermissionDirectoryRequest

GrantPermissionDirectoryRequest

Method Detail

getClassSchema

getName

setName

getPermission

setPermission

getDirectoryName

setDirectoryName

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode