A set of parameters for Kinetica.createDatasink(string,string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.CreateDatasinkRequest:

Collaboration diagram for kinetica.CreateDatasinkRequest:

Classes
struct	Options
	Optional parameters. More...

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

	CreateDatasinkRequest (string name, string destination, IDictionary< string, string > options=null)
	Constructs a CreateDatasinkRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	name `[get, set]`
	Name of the data sink to be created. More...

string	destination `[get, set]`
	Destination for the output data in format 'storage_provider_type://path[:port]'. More...

IDictionary< string, string >	options `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.createDatasink(string,string,IDictionary{string, string}).

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

Definition at line 22 of file CreateDatasink.cs.

Constructor & Destructor Documentation

kinetica.CreateDatasinkRequest.CreateDatasinkRequest ( )

inline

Constructs a CreateDatasinkRequest object with default parameters.

Definition at line 861 of file CreateDatasink.cs.

kinetica.CreateDatasinkRequest.CreateDatasinkRequest	(	string	name,
		string	destination,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateDatasinkRequest object with the specified parameters.

Parameters

name	Name of the data sink to be created.
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'.
options	Optional parameters. CONNECTION_TIMEOUT: Timeout in seconds for connecting to this data sink WAIT_TIMEOUT: Timeout in seconds for waiting for a response from this data sink CREDENTIAL: Name of the credential object to be used in this data sink S3_BUCKET_NAME: Name of the Amazon S3 bucket to use as the data sink S3_REGION: Name of the Amazon S3 region where the given bucket is located 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. Supported values: TRUE FALSE The default value is TRUE. 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. Supported values: TRUE FALSE The default value is TRUE. S3_AWS_ROLE_ARN: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user S3_ENCRYPTION_CUSTOMER_ALGORITHM: Customer encryption algorithm used encrypting data S3_ENCRYPTION_CUSTOMER_KEY: Customer encryption key to encrypt or decrypt data S3_ENCRYPTION_TYPE: Server side encryption type S3_KMS_KEY_ID: KMS key HDFS_KERBEROS_KEYTAB: Kerberos keytab file location for the given HDFS user. This may be a KIFS file. HDFS_DELEGATION_TOKEN: Delegation token for the given HDFS user HDFS_USE_KERBEROS: Use kerberos authentication for the given HDFS cluster Supported values: TRUE FALSE The default value is FALSE. 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 AZURE_CONTAINER_NAME: Name of the Azure storage container to use as the data sink AZURE_TENANT_ID: Active Directory tenant ID (or directory ID) AZURE_SAS_TOKEN: Shared access signature token for Azure storage account to use as the data sink AZURE_OAUTH_TOKEN: Oauth token to access given storage container GCS_BUCKET_NAME: Name of the Google Cloud Storage bucket to use as the data sink GCS_PROJECT_ID: Name of the Google Cloud project to use as the data sink GCS_SERVICE_ACCOUNT_KEYS: Google Cloud service account keys to use for authenticating the data sink JDBC_DRIVER_JAR_PATH: JDBC driver jar file location JDBC_DRIVER_CLASS_NAME: Name of the JDBC driver class KAFKA_TOPIC_NAME: Name of the Kafka topic to publish to if is a Kafka broker MAX_BATCH_SIZE: Maximum number of records per notification message. The default value is '1'. MAX_MESSAGE_SIZE: Maximum size in bytes of each notification message. The default value is '1000000'. 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. Supported values: FLAT NESTED The default value is FLAT. 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. Supported values: TRUE FALSE The default value is FALSE. USE_HTTPS: Use https to connect to datasink if true, otherwise use http Supported values: TRUE FALSE The default value is TRUE. SKIP_VALIDATION: Bypass validation of connection to this data sink. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 1165 of file CreateDatasink.cs.

Property Documentation

string kinetica.CreateDatasinkRequest.destination

getset

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'.

Definition at line 559 of file CreateDatasink.cs.

string kinetica.CreateDatasinkRequest.name

getset

Name of the data sink to be created.

Definition at line 552 of file CreateDatasink.cs.

IDictionary<string, string> kinetica.CreateDatasinkRequest.options

getset

Optional parameters.

CONNECTION_TIMEOUT: Timeout in seconds for connecting to this data sink
WAIT_TIMEOUT: Timeout in seconds for waiting for a response from this data sink
CREDENTIAL: Name of the credential object to be used in this data sink
S3_BUCKET_NAME: Name of the Amazon S3 bucket to use as the data sink
S3_REGION: Name of the Amazon S3 region where the given bucket is located
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. Supported values:
- TRUE
- FALSE
The default value is TRUE.
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. Supported values:
- TRUE
- FALSE
The default value is TRUE.
S3_AWS_ROLE_ARN: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
S3_ENCRYPTION_CUSTOMER_ALGORITHM: Customer encryption algorithm used encrypting data
S3_ENCRYPTION_CUSTOMER_KEY: Customer encryption key to encrypt or decrypt data
S3_ENCRYPTION_TYPE: Server side encryption type
S3_KMS_KEY_ID: KMS key
HDFS_KERBEROS_KEYTAB: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
HDFS_DELEGATION_TOKEN: Delegation token for the given HDFS user
HDFS_USE_KERBEROS: Use kerberos authentication for the given HDFS cluster Supported values:
- TRUE
- FALSE
The default value is FALSE.
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
AZURE_CONTAINER_NAME: Name of the Azure storage container to use as the data sink
AZURE_TENANT_ID: Active Directory tenant ID (or directory ID)
AZURE_SAS_TOKEN: Shared access signature token for Azure storage account to use as the data sink
AZURE_OAUTH_TOKEN: Oauth token to access given storage container
GCS_BUCKET_NAME: Name of the Google Cloud Storage bucket to use as the data sink
GCS_PROJECT_ID: Name of the Google Cloud project to use as the data sink
GCS_SERVICE_ACCOUNT_KEYS: Google Cloud service account keys to use for authenticating the data sink
JDBC_DRIVER_JAR_PATH: JDBC driver jar file location
JDBC_DRIVER_CLASS_NAME: Name of the JDBC driver class
KAFKA_TOPIC_NAME: Name of the Kafka topic to publish to if is a Kafka broker
MAX_BATCH_SIZE: Maximum number of records per notification message. The default value is '1'.
MAX_MESSAGE_SIZE: Maximum size in bytes of each notification message. The default value is '1000000'.
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. Supported values:
- FLAT
- NESTED
The default value is FLAT.
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. Supported values:
- TRUE
- FALSE
The default value is FALSE.
USE_HTTPS: Use https to connect to datasink if true, otherwise use http Supported values:
- TRUE
- FALSE
The default value is TRUE.
SKIP_VALIDATION: Bypass validation of connection to this data sink. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 856 of file CreateDatasink.cs.

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

Kinetica/Protocol/CreateDatasink.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation