Package com.gpudb.protocol
Class HasRoleRequest
java.lang.Object
com.gpudb.protocol.HasRoleRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecordA set of parameters for
GPUdb.hasRole.
Checks if the specified user has the specified role.
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA set of string constants for theHasRoleRequestparameteroptions.Constructor Summary
ConstructorsConstructorDescriptionConstructs a HasRoleRequest object with default parameters.Constructs a HasRoleRequest object with the specified parameters.Method Summary
Modifier and TypeMethodDescriptionbooleanget(int index) This method supports the Avro framework and is not intended to be called directly by the user.static org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.Optional parameters.Name of the user for which role membership is being checked.getRole()Name of role to check for membership.org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.inthashCode()voidThis method supports the Avro framework and is not intended to be called directly by the user.setOptions(Map<String, String> options) Optional parameters.setPrincipal(String principal) Name of the user for which role membership is being checked.Name of role to check for membership.toString()
Constructor Details
HasRoleRequest
Constructs a HasRoleRequest object with the specified parameters.Parameters:principal- Name of the user for which role membership is being checked. Must be an existing user. If blank, will use the current user. The default value is ”.role- Name of role to check for membership.options- Optional parameters.NO_ERROR_IF_NOT_EXISTS: IfFALSEwill return an error if the providedroledoes not exist or is blank. IfTRUEthen it will returnFALSEforhasRole. Supported values:The default value isFALSE.ONLY_DIRECT: IfFALSEwill search recursively if theprincipalis a member ofrole. IfTRUEthenprincipalmust directly be a member ofrole. Supported values:The default value isFALSE.
Map.
Method Details
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.setPrincipal
Name of the user for which role membership is being checked. Must be an existing user. If blank, will use the current user. The default value is ”.Parameters:principal- The new value forprincipal.Returns:thisto mimic the builder pattern.setRole
Name of role to check for membership.Parameters:role- The new value forrole.Returns:thisto mimic the builder pattern.getOptions
Optional parameters.NO_ERROR_IF_NOT_EXISTS: IfFALSEwill return an error if the providedroledoes not exist or is blank. IfTRUEthen it will returnFALSEforhasRole. Supported values:The default value isFALSE.ONLY_DIRECT: IfFALSEwill search recursively if theprincipalis a member ofrole. IfTRUEthenprincipalmust directly be a member ofrole. Supported values:The default value isFALSE.
Map.Returns:The current value ofoptions.setOptions
Optional parameters.NO_ERROR_IF_NOT_EXISTS: IfFALSEwill return an error if the providedroledoes not exist or is blank. IfTRUEthen it will returnFALSEforhasRole. Supported values:The default value isFALSE.ONLY_DIRECT: IfFALSEwill search recursively if theprincipalis a member ofrole. IfTRUEthenprincipalmust directly be a member ofrole. Supported values:The default value isFALSE.
Map.Parameters:options- The new value foroptions.Returns:thisto 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:getSchemain interfaceorg.apache.avro.generic.GenericContainerReturns:The schema object describing this class.get
This method supports the Avro framework and is not intended to be called directly by the user.Specified by:getin interfaceorg.apache.avro.generic.IndexedRecordParameters:index- the position of the field to getReturns:value of the field with the given index.Throws:put
This method supports the Avro framework and is not intended to be called directly by the user.Specified by:putin interfaceorg.apache.avro.generic.IndexedRecordParameters:index- the position of the field to setvalue- the value to setThrows: