com.gpudb.protocol

Class GrantPermissionCredentialRequest

java.lang.Object

com.gpudb.protocol.GrantPermissionCredentialRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.grantPermissionCredential(GrantPermissionCredentialRequest).

Grants a credential-level permission to a user or role.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrantPermissionCredentialRequest.Permission Permission to grant to the user or role.

Constructor Summary

Constructors

Constructor and Description
GrantPermissionCredentialRequest() Constructs a GrantPermissionCredentialRequest object with default parameters.
GrantPermissionCredentialRequest(String name, String permission, String credentialName, Map<String,String> options) Constructs a GrantPermissionCredentialRequest 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	getCredentialName()
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.
GrantPermissionCredentialRequest	setCredentialName(String credentialName)
GrantPermissionCredentialRequest	setName(String name)
GrantPermissionCredentialRequest	setOptions(Map<String,String> options)
GrantPermissionCredentialRequest	setPermission(String permission)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GrantPermissionCredentialRequest

public GrantPermissionCredentialRequest()

Constructs a GrantPermissionCredentialRequest object with default parameters.

GrantPermissionCredentialRequest

public GrantPermissionCredentialRequest(String name,
                                        String permission,
                                        String credentialName,
                                        Map<String,String> options)

Constructs a GrantPermissionCredentialRequest 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:

• CREDENTIAL_ADMIN: Full read/write and administrative access on the credential.
• CREDENTIAL_READ: Ability to read and use the credential.

credentialName - Name of the credential on which the permission will be granted. Must be an existing credential, or an empty string to grant access on all credentials.

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 GrantPermissionCredentialRequest 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:

• CREDENTIAL_ADMIN: Full read/write and administrative access on the credential.
• CREDENTIAL_READ: Ability to read and use the credential.

setPermission

public GrantPermissionCredentialRequest setPermission(String permission)

Parameters:

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

• CREDENTIAL_ADMIN: Full read/write and administrative access on the credential.
• CREDENTIAL_READ: Ability to read and use the credential.

Returns:

this to mimic the builder pattern.

getCredentialName

public String getCredentialName()

Returns:

Name of the credential on which the permission will be granted. Must be an existing credential, or an empty string to grant access on all credentials.

setCredentialName

public GrantPermissionCredentialRequest setCredentialName(String credentialName)

Parameters:

credentialName - Name of the credential on which the permission will be granted. Must be an existing credential, or an empty string to grant access on all credentials.

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