Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.CreateDatasinkRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string CONNECTION_TIMEOUT = "connection_timeout"
 Timeout in seconds for connecting to this data sink More...
 
const string WAIT_TIMEOUT = "wait_timeout"
 Timeout in seconds for waiting for a response from this data sink More...
 
const string CREDENTIAL = "credential"
 Name of the credential object to be used in this data sink More...
 
const string S3_BUCKET_NAME = "s3_bucket_name"
 Name of the Amazon S3 bucket to use as the data sink More...
 
const string S3_REGION = "s3_region"
 Name of the Amazon S3 region where the given bucket is located More...
 
const string S3_VERIFY_SSL = "s3_verify_ssl"
 Set to false for testing purposes or when necessary to bypass TLS errors (e.g. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string S3_USE_VIRTUAL_ADDRESSING = "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. More...
 
const string S3_AWS_ROLE_ARN = "s3_aws_role_arn"
 Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user More...
 
const string S3_ENCRYPTION_CUSTOMER_ALGORITHM = "s3_encryption_customer_algorithm"
 Customer encryption algorithm used encrypting data More...
 
const string S3_ENCRYPTION_CUSTOMER_KEY = "s3_encryption_customer_key"
 Customer encryption key to encrypt or decrypt data More...
 
const string S3_ENCRYPTION_TYPE = "s3_encryption_type"
 Server side encryption type More...
 
const string S3_KMS_KEY_ID = "s3_kms_key_id"
 KMS key More...
 
const string HDFS_KERBEROS_KEYTAB = "hdfs_kerberos_keytab"
 Kerberos keytab file location for the given HDFS user. More...
 
const string HDFS_DELEGATION_TOKEN = "hdfs_delegation_token"
 Delegation token for the given HDFS user More...
 
const string HDFS_USE_KERBEROS = "hdfs_use_kerberos"
 Use kerberos authentication for the given HDFS cluster Supported values:

The default value is FALSE. More...

 
const string AZURE_STORAGE_ACCOUNT_NAME = "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 More...
 
const string AZURE_CONTAINER_NAME = "azure_container_name"
 Name of the Azure storage container to use as the data sink More...
 
const string AZURE_TENANT_ID = "azure_tenant_id"
 Active Directory tenant ID (or directory ID) More...
 
const string AZURE_SAS_TOKEN = "azure_sas_token"
 Shared access signature token for Azure storage account to use as the data sink More...
 
const string AZURE_OAUTH_TOKEN = "azure_oauth_token"
 Oauth token to access given storage container More...
 
const string GCS_BUCKET_NAME = "gcs_bucket_name"
 Name of the Google Cloud Storage bucket to use as the data sink More...
 
const string GCS_PROJECT_ID = "gcs_project_id"
 Name of the Google Cloud project to use as the data sink More...
 
const string GCS_SERVICE_ACCOUNT_KEYS = "gcs_service_account_keys"
 Google Cloud service account keys to use for authenticating the data sink More...
 
const string JDBC_DRIVER_JAR_PATH = "jdbc_driver_jar_path"
 JDBC driver jar file location More...
 
const string JDBC_DRIVER_CLASS_NAME = "jdbc_driver_class_name"
 Name of the JDBC driver class More...
 
const string KAFKA_TOPIC_NAME = "kafka_topic_name"
 Name of the Kafka topic to publish to if destination is a Kafka broker More...
 
const string MAX_BATCH_SIZE = "max_batch_size"
 Maximum number of records per notification message. More...
 
const string MAX_MESSAGE_SIZE = "max_message_size"
 Maximum size in bytes of each notification message. More...
 
const string JSON_FORMAT = "json_format"
 The desired format of JSON encoded notifications message. More...
 
const string FLAT = "flat"
 
const string NESTED = "nested"
 
const string USE_MANAGED_CREDENTIALS = "use_managed_credentials"
 When no credentials are supplied, we use anonymous access by default. More...
 
const string USE_HTTPS = "use_https"
 Use https to connect to datasink if true, otherwise use http Supported values:

The default value is TRUE. More...

 
const string SKIP_VALIDATION = "skip_validation"
 Bypass validation of connection to this data sink. More...
 

Detailed Description

Optional parameters.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 322 of file CreateDatasink.cs.

Member Data Documentation

const string kinetica.CreateDatasinkRequest.Options.AZURE_CONTAINER_NAME = "azure_container_name"

Name of the Azure storage container to use as the data sink

Definition at line 433 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.AZURE_OAUTH_TOKEN = "azure_oauth_token"

Oauth token to access given storage container

Definition at line 444 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.AZURE_SAS_TOKEN = "azure_sas_token"

Shared access signature token for Azure storage account to use as the data sink

Definition at line 440 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.AZURE_STORAGE_ACCOUNT_NAME = "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

Definition at line 429 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.AZURE_TENANT_ID = "azure_tenant_id"

Active Directory tenant ID (or directory ID)

Definition at line 436 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.CONNECTION_TIMEOUT = "connection_timeout"

Timeout in seconds for connecting to this data sink

Definition at line 327 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.CREDENTIAL = "credential"

Name of the credential object to be used in this data sink

Definition at line 336 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.FALSE = "false"

Definition at line 364 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.FLAT = "flat"

Definition at line 495 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.GCS_BUCKET_NAME = "gcs_bucket_name"

Name of the Google Cloud Storage bucket to use as the data sink

Definition at line 448 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.GCS_PROJECT_ID = "gcs_project_id"

Name of the Google Cloud project to use as the data sink

Definition at line 452 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.GCS_SERVICE_ACCOUNT_KEYS = "gcs_service_account_keys"

Google Cloud service account keys to use for authenticating the data sink

Definition at line 456 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.HDFS_DELEGATION_TOKEN = "hdfs_delegation_token"

Delegation token for the given HDFS user

Definition at line 409 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.HDFS_KERBEROS_KEYTAB = "hdfs_kerberos_keytab"

Kerberos keytab file location for the given HDFS user.

This may be a KIFS file.

Definition at line 406 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.HDFS_USE_KERBEROS = "hdfs_use_kerberos"

Use kerberos authentication for the given HDFS cluster Supported values:

The default value is FALSE.

Definition at line 425 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.JDBC_DRIVER_CLASS_NAME = "jdbc_driver_class_name"

Name of the JDBC driver class

Definition at line 462 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.JDBC_DRIVER_JAR_PATH = "jdbc_driver_jar_path"

JDBC driver jar file location

Definition at line 459 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.JSON_FORMAT = "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:

The default value is FLAT.

Definition at line 494 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.KAFKA_TOPIC_NAME = "kafka_topic_name"

Name of the Kafka topic to publish to if destination is a Kafka broker

Definition at line 466 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.MAX_BATCH_SIZE = "max_batch_size"

Maximum number of records per notification message.

The default value is '1'.

Definition at line 470 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.MAX_MESSAGE_SIZE = "max_message_size"

Maximum size in bytes of each notification message.

The default value is '1000000'.

Definition at line 474 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.NESTED = "nested"

Definition at line 496 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.S3_AWS_ROLE_ARN = "s3_aws_role_arn"

Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user

Definition at line 388 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.S3_BUCKET_NAME = "s3_bucket_name"

Name of the Amazon S3 bucket to use as the data sink

Definition at line 340 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.S3_ENCRYPTION_CUSTOMER_ALGORITHM = "s3_encryption_customer_algorithm"

Customer encryption algorithm used encrypting data

Definition at line 392 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.S3_ENCRYPTION_CUSTOMER_KEY = "s3_encryption_customer_key"

Customer encryption key to encrypt or decrypt data

Definition at line 396 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.S3_ENCRYPTION_TYPE = "s3_encryption_type"

Server side encryption type

Definition at line 399 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.S3_KMS_KEY_ID = "s3_kms_key_id"

KMS key

Definition at line 402 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.S3_REGION = "s3_region"

Name of the Amazon S3 region where the given bucket is located

Definition at line 344 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.S3_USE_VIRTUAL_ADDRESSING = "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:

The default value is TRUE.

Definition at line 384 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.S3_VERIFY_SSL = "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:

The default value is TRUE.

Definition at line 362 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.SKIP_VALIDATION = "skip_validation"

Bypass validation of connection to this data sink.

Supported values:

The default value is FALSE.

Definition at line 547 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.TRUE = "true"

Definition at line 363 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.USE_HTTPS = "use_https"

Use https to connect to datasink if true, otherwise use http Supported values:

The default value is TRUE.

Definition at line 531 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.USE_MANAGED_CREDENTIALS = "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:

The default value is FALSE.

Definition at line 514 of file CreateDatasink.cs.

const string kinetica.CreateDatasinkRequest.Options.WAIT_TIMEOUT = "wait_timeout"

Timeout in seconds for waiting for a response from this data sink

Definition at line 331 of file CreateDatasink.cs.


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