GrantPermissionRequest (Kinetica Java API 7.2.3.0 API)

java.lang.Object
- com.gpudb.protocol.GrantPermissionRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class GrantPermissionRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.grantPermission.
Grant user or role the specified permission on the specified object.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GrantPermissionRequest.ObjectType` A set of string constants for the `GrantPermissionRequest` parameter `objectType`.
`static class`	`GrantPermissionRequest.Options` A set of string constants for the `GrantPermissionRequest` parameter `options`.
`static class`	`GrantPermissionRequest.Permission` A set of string constants for the `GrantPermissionRequest` parameter `permission`.

Constructor Summary

Constructors
Constructor and Description
`GrantPermissionRequest()` Constructs a GrantPermissionRequest object with default parameters.
`GrantPermissionRequest(String principal, String object, String objectType, String permission, Map<String,String> options)` Constructs a GrantPermissionRequest 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`	`getObject()` Name of object permission is being granted to.
`String`	`getObjectType()` The type of object being granted to.
`Map<String,String>`	`getOptions()` Optional parameters.
`String`	`getPermission()` Permission being granted.
`String`	`getPrincipal()` Name of the user or role for which the permission is being granted.
`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.
`GrantPermissionRequest`	`setObject(String object)` Name of object permission is being granted to.
`GrantPermissionRequest`	`setObjectType(String objectType)` The type of object being granted to.
`GrantPermissionRequest`	`setOptions(Map<String,String> options)` Optional parameters.
`GrantPermissionRequest`	`setPermission(String permission)` Permission being granted.
`GrantPermissionRequest`	`setPrincipal(String principal)` Name of the user or role for which the permission is being granted.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GrantPermissionRequest
```
public GrantPermissionRequest()
```
    Constructs a GrantPermissionRequest object with default parameters.
  - GrantPermissionRequest
```
public GrantPermissionRequest(String principal,
                              String object,
                              String objectType,
                              String permission,
                              Map<String,String> options)
```
    Constructs a GrantPermissionRequest object with the specified parameters.
    Parameters:
    
    principal - Name of the user or role for which the permission is being granted. Must be an existing user or role. The default value is ''.
    
    object - Name of object permission is being granted to. It is recommended to use a fully-qualified name when possible.
    objectType - The type of object being granted to. Supported values:
    
    CONTEXT: Context
    CREDENTIAL: Credential
    DATASINK: Data Sink
    DATASOURCE: Data Source
    DIRECTORY: KIFS File Directory
    GRAPH: A Graph object
    PROC: UDF Procedure
    SCHEMA: Schema
    SQL_PROC: SQL Procedure
    SYSTEM: System-level access
    TABLE: Database Table
    TABLE_MONITOR: Table monitor
    permission - Permission being granted. Supported values:
    
    ADMIN: Full read/write and administrative access on the object.
    CONNECT: Connect access on the given data source or data sink.
    CREATE: Ability to create new objects of this type.
    DELETE: Delete rows from tables.
    EXECUTE: Ability to Execute the Procedure object.
    INSERT: Insert access to tables.
    READ: Ability to read, list and use the object.
    UPDATE: Update access to the table.
    USER_ADMIN: Access to administer users and roles that do not have system_admin permission.
    WRITE: Access to write, change and delete objects.
    options - Optional parameters.
    
    COLUMNS: Apply table security to these columns, comma-separated. The default value is ''.
    FILTER_EXPRESSION: Optional filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''.
    WITH_GRANT_OPTION: Allow the recipient to grant the same permission (or subset) to others. 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.
  - getPrincipal
```
public String getPrincipal()
```
    Name of the user or role for which the permission is being granted. Must be an existing user or role. The default value is ''.
    
    Returns:
    
    The current value of principal.
  - setPrincipal
```
public GrantPermissionRequest setPrincipal(String principal)
```
    Name of the user or role for which the permission is being granted. Must be an existing user or role. The default value is ''.
    
    Parameters:
    
    principal - The new value for principal.
    
    Returns:
    
    this to mimic the builder pattern.
  - getObject
```
public String getObject()
```
    Name of object permission is being granted to. It is recommended to use a fully-qualified name when possible.
    
    Returns:
    
    The current value of object.
  - setObject
```
public GrantPermissionRequest setObject(String object)
```
    Name of object permission is being granted to. It is recommended to use a fully-qualified name when possible.
    
    Parameters:
    
    object - The new value for object.
    
    Returns:
    
    this to mimic the builder pattern.
  - getObjectType
```
public String getObjectType()
```
    The type of object being granted to. Supported values:
    - CONTEXT: Context
    - CREDENTIAL: Credential
    - DATASINK: Data Sink
    - DATASOURCE: Data Source
    - DIRECTORY: KIFS File Directory
    - GRAPH: A Graph object
    - PROC: UDF Procedure
    - SCHEMA: Schema
    - SQL_PROC: SQL Procedure
    - SYSTEM: System-level access
    - TABLE: Database Table
    - TABLE_MONITOR: Table monitor
    Returns:
    
    The current value of objectType.
  - setObjectType
```
public GrantPermissionRequest setObjectType(String objectType)
```
    The type of object being granted to. Supported values:
    - CONTEXT: Context
    - CREDENTIAL: Credential
    - DATASINK: Data Sink
    - DATASOURCE: Data Source
    - DIRECTORY: KIFS File Directory
    - GRAPH: A Graph object
    - PROC: UDF Procedure
    - SCHEMA: Schema
    - SQL_PROC: SQL Procedure
    - SYSTEM: System-level access
    - TABLE: Database Table
    - TABLE_MONITOR: Table monitor
    Parameters:
    
    objectType - The new value for objectType.
    
    Returns:
    
    this to mimic the builder pattern.
  - getPermission
```
public String getPermission()
```
    Permission being granted. Supported values:
    - ADMIN: Full read/write and administrative access on the object.
    - CONNECT: Connect access on the given data source or data sink.
    - CREATE: Ability to create new objects of this type.
    - DELETE: Delete rows from tables.
    - EXECUTE: Ability to Execute the Procedure object.
    - INSERT: Insert access to tables.
    - READ: Ability to read, list and use the object.
    - UPDATE: Update access to the table.
    - USER_ADMIN: Access to administer users and roles that do not have system_admin permission.
    - WRITE: Access to write, change and delete objects.
    Returns:
    
    The current value of permission.
  - setPermission
```
public GrantPermissionRequest setPermission(String permission)
```
    Permission being granted. Supported values:
    - ADMIN: Full read/write and administrative access on the object.
    - CONNECT: Connect access on the given data source or data sink.
    - CREATE: Ability to create new objects of this type.
    - DELETE: Delete rows from tables.
    - EXECUTE: Ability to Execute the Procedure object.
    - INSERT: Insert access to tables.
    - READ: Ability to read, list and use the object.
    - UPDATE: Update access to the table.
    - USER_ADMIN: Access to administer users and roles that do not have system_admin permission.
    - WRITE: Access to write, change and delete objects.
    Parameters:
    
    permission - The new value for permission.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Optional parameters.
    - COLUMNS: Apply table security to these columns, comma-separated. The default value is ''.
    - FILTER_EXPRESSION: Optional filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''.
    - WITH_GRANT_OPTION: Allow the recipient to grant the same permission (or subset) to others. Supported values:
      
      TRUE
      FALSE
      The default value is FALSE.
    The default value is an empty Map.
    Returns:
    
    The current value of options.
  - setOptions
```
public GrantPermissionRequest setOptions(Map<String,String> options)
```
    Optional parameters.
    - COLUMNS: Apply table security to these columns, comma-separated. The default value is ''.
    - FILTER_EXPRESSION: Optional filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''.
    - WITH_GRANT_OPTION: Allow the recipient to grant the same permission (or subset) to others. 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

Class GrantPermissionRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GrantPermissionRequest

GrantPermissionRequest

Method Detail

getClassSchema

getPrincipal

setPrincipal

getObject

setObject

getObjectType

setObjectType

getPermission

setPermission

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode