A set of parameters for Kinetica.createDatasink. More...

Inheritance diagram for kinetica.CreateDatasinkRequest:

Collaboration diagram for kinetica.CreateDatasinkRequest:

Classes
struct	Options
	A set of string constants for the parameter CreateDatasinkRequest.options. More...

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

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

	CreateDatasinkRequest ()
	Constructs a CreateDatasinkRequest object with default parameters.

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

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

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

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

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

	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

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

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

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

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

string	destination `\[get, set]`
	Destination for the output data in format 'storage\_provider\_type://path\[:port]'.

IDictionary\< string, string >	options = new Dictionary\() `\[get, set]`
	Optional parameters.

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

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.

static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

Detailed Description

A set of parameters for Kinetica.createDatasink.

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

Definition at line 17 of file CreateDatasink.cs.

Constructor & Destructor Documentation

◆ CreateDatasinkRequest() \[1/4]

kinetica.CreateDatasinkRequest.CreateDatasinkRequest

(

)

inline

Constructs a CreateDatasinkRequest object with default parameters.

Definition at line 705 of file CreateDatasink.cs.

◆ CreateDatasinkRequest() \[2/4]

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: Whether to verify SSL connections. Supported values: TRUE: Connect with SSL verification. FALSE: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc. The default value is TRUE. S3\_USE\_VIRTUAL\_ADDRESSING: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values: TRUE: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL. FALSE: Use path-style URI for requests. 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. AZURE\_USE\_VIRTUAL\_ADDRESSING: Whether to use virtual addressing when referencing the Azure source. Supported values: TRUE: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL. FALSE: Use path-style URI for requests. The default value is TRUE. 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 destination 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. Supported values: FLAT: A single record is returned per message. NESTED: Records are returned as an array per message. 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 1096 of file CreateDatasink.cs.

◆ CreateDatasinkRequest() \[3/4]

kinetica.CreateDatasinkRequest.CreateDatasinkRequest

(

)

inline

Constructs a CreateDatasinkRequest object with default parameters.

Definition at line 705 of file CreateDatasink.cs.

◆ CreateDatasinkRequest() \[4/4]

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: Whether to verify SSL connections. Supported values: TRUE: Connect with SSL verification. FALSE: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc. The default value is TRUE. S3\_USE\_VIRTUAL\_ADDRESSING: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values: TRUE: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL. FALSE: Use path-style URI for requests. 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. AZURE\_USE\_VIRTUAL\_ADDRESSING: Whether to use virtual addressing when referencing the Azure source. Supported values: TRUE: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL. FALSE: Use path-style URI for requests. The default value is TRUE. 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 destination 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. Supported values: FLAT: A single record is returned per message. NESTED: Records are returned as an array per message. 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 1096 of file CreateDatasink.cs.

Property Documentation

◆ destination

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 317 of file CreateDatasink.cs.

◆ name

string kinetica.CreateDatasinkRequest.name

getset

Name of the data sink to be created.

Definition at line 311 of file CreateDatasink.cs.

◆ options

IDictionary\< string, string > kinetica.CreateDatasinkRequest.options = new Dictionary\()

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: Whether to verify SSL connections. Supported values:
- TRUE: Connect with SSL verification.
- FALSE: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
The default value is TRUE.
S3\_USE\_VIRTUAL\_ADDRESSING: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values:
- TRUE: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- FALSE: Use path-style URI for requests.
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.
AZURE\_USE\_VIRTUAL\_ADDRESSING: Whether to use virtual addressing when referencing the Azure source. Supported values:
- TRUE: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- FALSE: Use path-style URI for requests.
The default value is TRUE.
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 CreateDatasinkRequest.destination 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. Supported values:
- FLAT: A single record is returned per message.
- NESTED: Records are returned as an array per message.
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 701 of file CreateDatasink.cs.

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

\_build/public-os\_ubuntu24.04-arch\_amd64-cc\_gcc\_13.3.0/install/Kinetica/Protocol/CreateDatasink.cs
Kinetica/Protocol/CreateDatasink.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateDatasinkRequest() \[1/4]

◆ CreateDatasinkRequest() \[2/4]

◆ CreateDatasinkRequest() \[3/4]

◆ CreateDatasinkRequest() \[4/4]

Property Documentation

◆ destination

◆ name

◆ options