gpudb::CreateDatasinkRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/create_datasink.h>

Public Member Functions
	CreateDatasinkRequest ()
	Constructs a CreateDatasinkRequest object with default parameter values. More...
	CreateDatasinkRequest (const std::string &name_, const std::string &destination_, const std::map< std::string, std::string > &options_)
	Constructs a CreateDatasinkRequest object with the specified parameters. More...

Public Attributes
std::string	name
std::string	destination
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Creates a data sink, which contains the destination information for a data sink that is external to the database.

Definition at line 21 of file create_datasink.h.

Constructor & Destructor Documentation

gpudb::CreateDatasinkRequest::CreateDatasinkRequest ( )

inline

Constructs a CreateDatasinkRequest object with default parameter values.

Definition at line 28 of file create_datasink.h.

gpudb::CreateDatasinkRequest::CreateDatasinkRequest ( const std::string &  name_, const std::string &  destination_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a CreateDatasinkRequest object with the specified parameters.

Parameters

[in]	name_	Name of the data sink to be created.
[in]	destination_	Destination for the output data in format 'storage_provider_type://path[:port]'. Supported storage provider types are 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka' and 's3'.
[in]	options_	Optional parameters. gpudb::create_datasink_connection_timeout: Timeout in seconds for connecting to this data sink gpudb::create_datasink_wait_timeout: Timeout in seconds for waiting for a response from this data sink gpudb::create_datasink_credential: Name of the credential object to be used in this data sink gpudb::create_datasink_s3_bucket_name: Name of the Amazon S3 bucket to use as the data sink gpudb::create_datasink_s3_region: Name of the Amazon S3 region where the given bucket is located gpudb::create_datasink_s3_verify_ssl: Set to false for testing purposes or when necessary to bypass TLS errors (e.g. self-signed certificates). This value is true by default. gpudb::create_datasink_true gpudb::create_datasink_false The default value is gpudb::create_datasink_true. gpudb::create_datasink_s3_use_virtual_addressing: When true (default), the requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL. Otherwise set to false to use path-style URI for requests. gpudb::create_datasink_true gpudb::create_datasink_false The default value is gpudb::create_datasink_true. gpudb::create_datasink_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user gpudb::create_datasink_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data gpudb::create_datasink_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data gpudb::create_datasink_s3_encryption_type: Server side encryption type gpudb::create_datasink_s3_kms_key_id: KMS key gpudb::create_datasink_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file. gpudb::create_datasink_hdfs_delegation_token: Delegation token for the given HDFS user gpudb::create_datasink_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster gpudb::create_datasink_true gpudb::create_datasink_false The default value is gpudb::create_datasink_false. gpudb::create_datasink_azure_storage_account_name: Name of the Azure storage account to use as the data sink, this is valid only if tenant_id is specified gpudb::create_datasink_azure_container_name: Name of the Azure storage container to use as the data sink gpudb::create_datasink_azure_tenant_id: Active Directory tenant ID (or directory ID) gpudb::create_datasink_azure_sas_token: Shared access signature token for Azure storage account to use as the data sink gpudb::create_datasink_azure_oauth_token: Oauth token to access given storage container gpudb::create_datasink_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data sink gpudb::create_datasink_gcs_project_id: Name of the Google Cloud project to use as the data sink gpudb::create_datasink_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data sink gpudb::create_datasink_jdbc_driver_jar_path: JDBC driver jar file location gpudb::create_datasink_jdbc_driver_class_name: Name of the JDBC driver class gpudb::create_datasink_kafka_topic_name: Name of the Kafka topic to publish to if destination is a Kafka broker gpudb::create_datasink_max_batch_size: Maximum number of records per notification message. The default value is '1'. gpudb::create_datasink_max_message_size: Maximum size in bytes of each notification message. The default value is '1000000'. gpudb::create_datasink_json_format: The desired format of JSON encoded notifications message. If nested, records are returned as an array. Otherwise, only a single record per messages is returned. gpudb::create_datasink_flat gpudb::create_datasink_nested The default value is gpudb::create_datasink_flat. gpudb::create_datasink_use_managed_credentials: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. gpudb::create_datasink_true gpudb::create_datasink_false The default value is gpudb::create_datasink_false. gpudb::create_datasink_use_https: Use https to connect to datasink if true, otherwise use http gpudb::create_datasink_true gpudb::create_datasink_false The default value is gpudb::create_datasink_true. gpudb::create_datasink_skip_validation: Bypass validation of connection to this data sink. gpudb::create_datasink_true gpudb::create_datasink_false The default value is gpudb::create_datasink_false.

Definition at line 218 of file create_datasink.h.

Member Data Documentation

std::string gpudb::CreateDatasinkRequest::destination

Definition at line 226 of file create_datasink.h.

std::string gpudb::CreateDatasinkRequest::name

Definition at line 225 of file create_datasink.h.

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

Definition at line 227 of file create_datasink.h.

---

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

• gpudb/protocol/create_datasink.h