Package com.gpudb.protocol

Class AlterCredentialRequest

java.lang.Object

com.gpudb.protocol.AlterCredentialRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.alterCredential.

Alter the properties of an existing credential.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AlterCredentialRequest.CredentialUpdatesMap	A set of string constants for the AlterCredentialRequest parameter credentialUpdatesMap.

Constructor Summary

Constructors

Constructor	Description
AlterCredentialRequest()	Constructs an AlterCredentialRequest object with default parameters.
AlterCredentialRequest(String credentialName, Map<String,String> credentialUpdatesMap, Map<String,String> options)	Constructs an AlterCredentialRequest object with the specified parameters.

Method Summary

Modifier and Type	Method	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()	Name of the credential to be altered.
Map<String,String>	getCredentialUpdatesMap()	Map containing the properties of the credential to be updated.
Map<String,String>	getOptions()	Optional parameters.
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.
AlterCredentialRequest	setCredentialName(String credentialName)	Name of the credential to be altered.
AlterCredentialRequest	setCredentialUpdatesMap(Map<String,String> credentialUpdatesMap)	Map containing the properties of the credential to be updated.
AlterCredentialRequest	setOptions(Map<String,String> options)	Optional parameters.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlterCredentialRequest

public AlterCredentialRequest()

Constructs an AlterCredentialRequest object with default parameters.

AlterCredentialRequest

public AlterCredentialRequest(String credentialName,
                              Map<String,String> credentialUpdatesMap,
                              Map<String,String> options)

Constructs an AlterCredentialRequest object with the specified parameters.

Parameters:

credentialName - Name of the credential to be altered. Must be an existing credential.

credentialUpdatesMap - Map containing the properties of the credential to be updated. Error if empty.

• TYPE: New type for the credential. Supported values:
  • AWS_ACCESS_KEY
  • AWS_IAM_ROLE
  • AZURE_AD
  • AZURE_OAUTH
  • AZURE_SAS
  • AZURE_STORAGE_KEY
  • DOCKER
  • GCS_SERVICE_ACCOUNT_ID
  • GCS_SERVICE_ACCOUNT_KEYS
  • HDFS
  • KAFKA
• IDENTITY: New user for the credential
• SECRET: New password for the credential
• SCHEMA_NAME: Updates the schema name. If SCHEMA_NAME doesn't exist, an error will be thrown. If SCHEMA_NAME is empty, then the user's default schema will be used.

options - Optional parameters.

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.

getCredentialName

public String getCredentialName()

Name of the credential to be altered. Must be an existing credential.

Returns:

The current value of credentialName.

setCredentialName

public AlterCredentialRequest setCredentialName(String credentialName)

Name of the credential to be altered. Must be an existing credential.

Parameters:

credentialName - The new value for credentialName.

Returns:

this to mimic the builder pattern.

getCredentialUpdatesMap

public Map<String,String> getCredentialUpdatesMap()

Map containing the properties of the credential to be updated. Error if empty.

• TYPE: New type for the credential. Supported values:
  • AWS_ACCESS_KEY
  • AWS_IAM_ROLE
  • AZURE_AD
  • AZURE_OAUTH
  • AZURE_SAS
  • AZURE_STORAGE_KEY
  • DOCKER
  • GCS_SERVICE_ACCOUNT_ID
  • GCS_SERVICE_ACCOUNT_KEYS
  • HDFS
  • KAFKA
• IDENTITY: New user for the credential
• SECRET: New password for the credential
• SCHEMA_NAME: Updates the schema name. If SCHEMA_NAME doesn't exist, an error will be thrown. If SCHEMA_NAME is empty, then the user's default schema will be used.

Returns:

The current value of credentialUpdatesMap.

setCredentialUpdatesMap

public AlterCredentialRequest setCredentialUpdatesMap(Map<String,String> credentialUpdatesMap)

Map containing the properties of the credential to be updated. Error if empty.

• TYPE: New type for the credential. Supported values:
  • AWS_ACCESS_KEY
  • AWS_IAM_ROLE
  • AZURE_AD
  • AZURE_OAUTH
  • AZURE_SAS
  • AZURE_STORAGE_KEY
  • DOCKER
  • GCS_SERVICE_ACCOUNT_ID
  • GCS_SERVICE_ACCOUNT_KEYS
  • HDFS
  • KAFKA
• IDENTITY: New user for the credential
• SECRET: New password for the credential
• SCHEMA_NAME: Updates the schema name. If SCHEMA_NAME doesn't exist, an error will be thrown. If SCHEMA_NAME is empty, then the user's default schema will be used.

Parameters:

credentialUpdatesMap - The new value for credentialUpdatesMap.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

Returns:

The current value of options.

setOptions

public AlterCredentialRequest setOptions(Map<String,String> options)

Optional parameters.

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