com.gpudb.protocol

Class CreateCredentialRequest

java.lang.Object

com.gpudb.protocol.CreateCredentialRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.createCredential.

Create a new credential.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateCredentialRequest.Type A set of string constants for the CreateCredentialRequest parameter type.

Constructor Summary

Constructors

Constructor and Description
CreateCredentialRequest() Constructs a CreateCredentialRequest object with default parameters.
CreateCredentialRequest(String credentialName, String type, String identity, String secret, Map<String,String> options) Constructs a CreateCredentialRequest 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() Name of the credential to be created.
String	getIdentity() User of the credential to be created.
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.
String	getSecret() Password of the credential to be created.
String	getType() Type of the credential to be created.
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.
CreateCredentialRequest	setCredentialName(String credentialName) Name of the credential to be created.
CreateCredentialRequest	setIdentity(String identity) User of the credential to be created.
CreateCredentialRequest	setOptions(Map<String,String> options) Optional parameters.
CreateCredentialRequest	setSecret(String secret) Password of the credential to be created.
CreateCredentialRequest	setType(String type) Type of the credential to be created.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateCredentialRequest

public CreateCredentialRequest()

Constructs a CreateCredentialRequest object with default parameters.

CreateCredentialRequest

public CreateCredentialRequest(String credentialName,
                               String type,
                               String identity,
                               String secret,
                               Map<String,String> options)

Constructs a CreateCredentialRequest object with the specified parameters.

Parameters:

credentialName - Name of the credential to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match an existing credential name.

type - Type of the credential to be created. Supported values:

• AWS_ACCESS_KEY
• AWS_IAM_ROLE
• AZURE_AD
• AZURE_OAUTH
• AZURE_SAS
• AZURE_STORAGE_KEY
• CONFLUENT
• DOCKER
• GCS_SERVICE_ACCOUNT_ID
• GCS_SERVICE_ACCOUNT_KEYS
• HDFS
• JDBC
• KAFKA
• NVIDIA_API_KEY
• OPENAI_API_KEY

identity - User of the credential to be created.

secret - Password of the credential to be created.

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.

getCredentialName

public String getCredentialName()

Name of the credential to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match an existing credential name.

Returns:

The current value of credentialName.

setCredentialName

public CreateCredentialRequest setCredentialName(String credentialName)

Name of the credential to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match an existing credential name.

Parameters:

credentialName - The new value for credentialName.

Returns:

this to mimic the builder pattern.

getType

public String getType()

Type of the credential to be created. Supported values:

• AWS_ACCESS_KEY
• AWS_IAM_ROLE
• AZURE_AD
• AZURE_OAUTH
• AZURE_SAS
• AZURE_STORAGE_KEY
• CONFLUENT
• DOCKER
• GCS_SERVICE_ACCOUNT_ID
• GCS_SERVICE_ACCOUNT_KEYS
• HDFS
• JDBC
• KAFKA
• NVIDIA_API_KEY
• OPENAI_API_KEY

Returns:

The current value of type.

setType

public CreateCredentialRequest setType(String type)

Type of the credential to be created. Supported values:

• AWS_ACCESS_KEY
• AWS_IAM_ROLE
• AZURE_AD
• AZURE_OAUTH
• AZURE_SAS
• AZURE_STORAGE_KEY
• CONFLUENT
• DOCKER
• GCS_SERVICE_ACCOUNT_ID
• GCS_SERVICE_ACCOUNT_KEYS
• HDFS
• JDBC
• KAFKA
• NVIDIA_API_KEY
• OPENAI_API_KEY

Parameters:

type - The new value for type.

Returns:

this to mimic the builder pattern.

getIdentity

public String getIdentity()

User of the credential to be created.

Returns:

The current value of identity.

setIdentity

public CreateCredentialRequest setIdentity(String identity)

User of the credential to be created.

Parameters:

identity - The new value for identity.

Returns:

this to mimic the builder pattern.

getSecret

public String getSecret()

Password of the credential to be created.

Returns:

The current value of secret.

setSecret

public CreateCredentialRequest setSecret(String secret)

Password of the credential to be created.

Parameters:

secret - The new value for secret.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters. The default value is an empty Map.

Returns:

The current value of options.

setOptions

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

Optional parameters. 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