gpudb::AlterDatasinkRequest Struct Reference

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

#include <gpudb/protocol/alter_datasink.h>

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

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

Detailed Description

A set of input parameters for const.

Alters the properties of an existing data sink

Definition at line 19 of file alter_datasink.h.

Constructor & Destructor Documentation

gpudb::AlterDatasinkRequest::AlterDatasinkRequest ( )

inline

Constructs an AlterDatasinkRequest object with default parameter values.

Definition at line 26 of file alter_datasink.h.

gpudb::AlterDatasinkRequest::AlterDatasinkRequest ( const std::string &  name_, const std::map< std::string, std::string > &  datasinkUpdatesMap_, const std::map< std::string, std::string > &  options_  )

inline

Constructs an AlterDatasinkRequest object with the specified parameters.

Parameters

[in]	name_	Name of the data sink to be altered. Must be an existing data sink.
[in]	datasinkUpdatesMap_	Map containing the properties of the data sink to be updated. Error if empty. gpudb::alter_datasink_destination: Destination for the output data in format 'destination_type://path[:port]'. Supported destination types are 'http', 'https' and 'kafka'. gpudb::alter_datasink_connection_timeout: Timeout in seconds for connecting to this sink gpudb::alter_datasink_wait_timeout: Timeout in seconds for waiting for a response from this sink gpudb::alter_datasink_credential: Name of the credential object to be used in this data sink gpudb::alter_datasink_s3_bucket_name: Name of the Amazon S3 bucket to use as the data sink gpudb::alter_datasink_s3_region: Name of the Amazon S3 region where the given bucket is located gpudb::alter_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::alter_datasink_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file. gpudb::alter_datasink_hdfs_delegation_token: Delegation token for the given HDFS user gpudb::alter_datasink_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster gpudb::alter_datasink_true gpudb::alter_datasink_false The default value is gpudb::alter_datasink_false. gpudb::alter_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::alter_datasink_azure_container_name: Name of the Azure storage container to use as the data sink gpudb::alter_datasink_azure_tenant_id: Active Directory tenant ID (or directory ID) gpudb::alter_datasink_azure_sas_token: Shared access signature token for Azure storage account to use as the data sink gpudb::alter_datasink_azure_oauth_token: Oauth token to access given storage container gpudb::alter_datasink_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data sink gpudb::alter_datasink_gcs_project_id: Name of the Google Cloud project to use as the data sink gpudb::alter_datasink_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data sink gpudb::alter_datasink_kafka_url: The publicly-accessible full path URL to the kafka broker, e.g., 'http://172.123.45.67:9300'. gpudb::alter_datasink_kafka_topic_name: Name of the Kafka topic to use for this data sink, if it references a Kafka broker gpudb::alter_datasink_anonymous: Create an anonymous connection to the storage provider–DEPRECATED: this is now the default. Specify use_managed_credentials for non-anonymous connection gpudb::alter_datasink_true gpudb::alter_datasink_false The default value is gpudb::alter_datasink_true. gpudb::alter_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::alter_datasink_true gpudb::alter_datasink_false The default value is gpudb::alter_datasink_false. gpudb::alter_datasink_use_https: Use https to connect to datasink if true, otherwise use http gpudb::alter_datasink_true gpudb::alter_datasink_false The default value is gpudb::alter_datasink_true. gpudb::alter_datasink_max_batch_size: Maximum number of records per notification message. The default value is '1'. gpudb::alter_datasink_max_message_size: Maximum size in bytes of each notification message. The default value is '1000000'. gpudb::alter_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::alter_datasink_flat gpudb::alter_datasink_nested The default value is gpudb::alter_datasink_flat. gpudb::alter_datasink_skip_validation: Bypass validation of connection to this data sink. gpudb::alter_datasink_true gpudb::alter_datasink_false The default value is gpudb::alter_datasink_false. gpudb::alter_datasink_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.
[in]	options_	Optional parameters.

Definition at line 233 of file alter_datasink.h.

Member Data Documentation

std::map<std::string, std::string> gpudb::AlterDatasinkRequest::datasinkUpdatesMap

Definition at line 241 of file alter_datasink.h.

std::string gpudb::AlterDatasinkRequest::name

Definition at line 240 of file alter_datasink.h.

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

Definition at line 242 of file alter_datasink.h.

---

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

• gpudb/protocol/alter_datasink.h