com.gpudb.protocol

Class RevokePermissionCredentialRequest

java.lang.Object

com.gpudb.protocol.RevokePermissionCredentialRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.revokePermissionCredential(RevokePermissionCredentialRequest).

Revokes a credential-level permission from a user or role.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RevokePermissionCredentialRequest.Permission Permission to revoke from the user or role.

Constructor Summary

Constructors

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RevokePermissionCredentialRequest

public RevokePermissionCredentialRequest()

Constructs a RevokePermissionCredentialRequest object with default parameters.

RevokePermissionCredentialRequest

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

Constructs a RevokePermissionCredentialRequest object with the specified parameters.

Parameters:

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

permission - Permission to revoke from 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 revoked. Must be an existing credential, or an empty string to revoke 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 from which the permission will be revoked. Must be an existing user or role.

setName

public RevokePermissionCredentialRequest setName(String name)

Parameters:

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

Returns:

this to mimic the builder pattern.

getPermission

public String getPermission()

Returns:

Permission to revoke from 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 RevokePermissionCredentialRequest setPermission(String permission)

Parameters:

permission - Permission to revoke from 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 revoked. Must be an existing credential, or an empty string to revoke access on all credentials.

setCredentialName

public RevokePermissionCredentialRequest setCredentialName(String credentialName)

Parameters:

credentialName - Name of the credential on which the permission will be revoked. Must be an existing credential, or an empty string to revoke 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 RevokePermissionCredentialRequest 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