A set of parameters for GPUdb::createCredential. More...

#include <gpudb/protocol/create_credential.h>

Public Member Functions
	CreateCredentialRequest ()
	Constructs a CreateCredentialRequest object with default parameters. More...

	CreateCredentialRequest (const std::string &credentialName_, const std::string &type_, const std::string &identity_, const std::string &secret_, const std::map< std::string, std::string > &options_)
	Constructs a CreateCredentialRequest object with the specified parameters. More...

Public Attributes
std::string	credentialName
	Name of the credential to be created. More...

std::string	type
	Type of the credential to be created. More...

std::string	identity
	User of the credential to be created. More...

std::string	secret
	Password of the credential to be created. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::createCredential.

Create a new credential.

Definition at line 19 of file create_credential.h.

Constructor & Destructor Documentation

◆ CreateCredentialRequest() [1/2]

gpudb::CreateCredentialRequest::CreateCredentialRequest ( )

inline

Constructs a CreateCredentialRequest object with default parameters.

Definition at line 24 of file create_credential.h.

◆ CreateCredentialRequest() [2/2]

gpudb::CreateCredentialRequest::CreateCredentialRequest	(	const std::string &	credentialName_,
		const std::string &	type_,
		const std::string &	identity_,
		const std::string &	secret_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a CreateCredentialRequest object with the specified parameters.

Parameters

[in]	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.
[in]	type_	Type of the credential to be created. Supported values: create_credential_aws_access_key create_credential_aws_iam_role create_credential_azure_ad create_credential_azure_oauth create_credential_azure_sas create_credential_azure_storage_key create_credential_confluent create_credential_docker create_credential_gcs_service_account_id create_credential_gcs_service_account_keys create_credential_hdfs create_credential_jdbc create_credential_kafka create_credential_nvidia_api_key create_credential_openai_api_key
[in]	identity_	User of the credential to be created.
[in]	secret_	Password of the credential to be created.
[in]	options_	Optional parameters. The default value is an empty map.

Definition at line 87 of file create_credential.h.

Member Data Documentation

◆ credentialName

std::string gpudb::CreateCredentialRequest::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.

Definition at line 101 of file create_credential.h.

◆ identity

std::string gpudb::CreateCredentialRequest::identity

User of the credential to be created.

Definition at line 142 of file create_credential.h.

◆ options

std::map<std::string, std::string> gpudb::CreateCredentialRequest::options

Optional parameters.

The default value is an empty map.

Definition at line 152 of file create_credential.h.

◆ secret

std::string gpudb::CreateCredentialRequest::secret

Password of the credential to be created.

Definition at line 147 of file create_credential.h.

◆ type

std::string gpudb::CreateCredentialRequest::type

Type of the credential to be created.

Supported values:

Definition at line 137 of file create_credential.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/create_credential.h

Public Member Functions

Public Attributes