Skip to main content

A set of string constants for the parameter CreateDatasourceRequest.options. More…

​
Static Public Attributes

const string SKIP_VALIDATION = “skip_validation”
 Bypass validation of connection to remote source.
 
const string TRUE = “true”
 A boolean constant for the CreateDatasourceRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the CreateDatasourceRequest.Options options.
 
const string CONNECTION_TIMEOUT = “connection_timeout”
 Timeout in seconds for connecting to this storage provider.
 
const string WAIT_TIMEOUT = “wait_timeout”
 Timeout in seconds for reading from this storage provider.
 
const string CREDENTIAL = “credential”
 Name of the credential object to be used in data source.
 
const string S3_BUCKET_NAME = “s3_bucket_name”
 Name of the Amazon S3 bucket to use as the data source.
 
const string S3_REGION = “s3_region”
 Name of the Amazon S3 region where the given bucket is located.
 
const string S3_VERIFY_SSL = “s3_verify_ssl”
 Whether to verify SSL connections.
 
const string S3_USE_VIRTUAL_ADDRESSING = “s3_use_virtual_addressing”
 Whether to use virtual addressing when referencing the Amazon S3 source.
 
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.
 
const string S3_ENCRYPTION_CUSTOMER_ALGORITHM = “s3_encryption_customer_algorithm”
 Customer encryption algorithm used encrypting data.
 
const string S3_ENCRYPTION_CUSTOMER_KEY = “s3_encryption_customer_key”
 Customer encryption key to encrypt or decrypt data.
 
const string HDFS_KERBEROS_KEYTAB = “hdfs_kerberos_keytab”
 Kerberos keytab file location for the given HDFS user.
 
const string HDFS_DELEGATION_TOKEN = “hdfs_delegation_token”
 Delegation token for the given HDFS user.
 
const string HDFS_USE_KERBEROS = “hdfs_use_kerberos”
 Use kerberos authentication for the given HDFS cluster.
 
const string AZURE_STORAGE_ACCOUNT_NAME = “azure_storage_account_name”
 Name of the Azure storage account to use as the data source, this is valid only if tenant_id is specified.
 
const string AZURE_CONTAINER_NAME = “azure_container_name”
 Name of the Azure storage container to use as the data source.
 
const string AZURE_TENANT_ID = “azure_tenant_id”
 Active Directory tenant ID (or directory ID).
 
const string AZURE_SAS_TOKEN = “azure_sas_token”
 Shared access signature token for Azure storage account to use as the data source.
 
const string AZURE_OAUTH_TOKEN = “azure_oauth_token”
 OAuth token to access given storage container.
 
const string AZURE_USE_VIRTUAL_ADDRESSING = “azure_use_virtual_addressing”
 Whether to use virtual addressing when referencing the Azure source.
 
const string GCS_BUCKET_NAME = “gcs_bucket_name”
 Name of the Google Cloud Storage bucket to use as the data source.
 
const string GCS_PROJECT_ID = “gcs_project_id”
 Name of the Google Cloud project to use as the data source.
 
const string GCS_SERVICE_ACCOUNT_KEYS = “gcs_service_account_keys”
 Google Cloud service account keys to use for authenticating the data source.
 
const string IS_STREAM = “is_stream”
 To load from Azure/GCS/S3 as a stream continuously.
 
const string KAFKA_TOPIC_NAME = “kafka_topic_name”
 Name of the Kafka topic to use as the data source.
 
const string JDBC_DRIVER_JAR_PATH = “jdbc_driver_jar_path”
 JDBC driver jar file location.
 
const string JDBC_DRIVER_CLASS_NAME = “jdbc_driver_class_name”
 Name of the JDBC driver class.
 
const string ANONYMOUS = “anonymous”
 Use anonymous connection to storage provider–DEPRECATED: this is now the default.
 
const string USE_MANAGED_CREDENTIALS = “use_managed_credentials”
 When no credentials are supplied, we use anonymous access by default.
 
const string USE_HTTPS = “use_https”
 Use HTTPS to connect to datasource if true, otherwise use HTTP.
 
const string SCHEMA_REGISTRY_LOCATION = “schema_registry_location”
 Location of Confluent Schema Registry in ‘[storage_path[:storage_port]]’ format.
 
const string SCHEMA_REGISTRY_CREDENTIAL = “schema_registry_credential”
 Confluent Schema Registry credential object name.
 
const string SCHEMA_REGISTRY_PORT = “schema_registry_port”
 Confluent Schema Registry port (optional).
 
const string SCHEMA_REGISTRY_CONNECTION_RETRIES = “schema_registry_connection_retries”
 Confluent Schema registry connection timeout (in secs).
 
const string SCHEMA_REGISTRY_CONNECTION_TIMEOUT = “schema_registry_connection_timeout”
 Confluent Schema registry connection timeout (in secs).
 

​
Detailed Description

A set of string constants for the parameter CreateDatasourceRequest.options.

Optional parameters.

Definition at line 23 of file CreateDatasource.cs.

​
Member Data Documentation

​
◆ ANONYMOUS

const string kinetica.CreateDatasourceRequest.Options.ANONYMOUS = “anonymous”
 static

Use anonymous connection to storage provider–DEPRECATED: this is now the default.

Specify use_managed_credentials for non-anonymous connection. Supported values:

The default value is TRUE.

Definition at line 273 of file CreateDatasource.cs.

​
◆ AZURE_CONTAINER_NAME

const string kinetica.CreateDatasourceRequest.Options.AZURE_CONTAINER_NAME = “azure_container_name”
 static

Name of the Azure storage container to use as the data source.

Definition at line 174 of file CreateDatasource.cs.

​
◆ AZURE_OAUTH_TOKEN

const string kinetica.CreateDatasourceRequest.Options.AZURE_OAUTH_TOKEN = “azure_oauth_token”
 static

OAuth token to access given storage container.

Definition at line 184 of file CreateDatasource.cs.

​
◆ AZURE_SAS_TOKEN

const string kinetica.CreateDatasourceRequest.Options.AZURE_SAS_TOKEN = “azure_sas_token”
 static

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

Definition at line 181 of file CreateDatasource.cs.

​
◆ AZURE_STORAGE_ACCOUNT_NAME

const string kinetica.CreateDatasourceRequest.Options.AZURE_STORAGE_ACCOUNT_NAME = “azure_storage_account_name”
 static

Name of the Azure storage account to use as the data source, this is valid only if tenant_id is specified.

Definition at line 170 of file CreateDatasource.cs.

​
◆ AZURE_TENANT_ID

const string kinetica.CreateDatasourceRequest.Options.AZURE_TENANT_ID = “azure_tenant_id”
 static

Active Directory tenant ID (or directory ID).

Definition at line 177 of file CreateDatasource.cs.

​
◆ AZURE_USE_VIRTUAL_ADDRESSING

const string kinetica.CreateDatasourceRequest.Options.AZURE_USE_VIRTUAL_ADDRESSING = “azure_use_virtual_addressing”
 static

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.

Definition at line 208 of file CreateDatasource.cs.

​
◆ CONNECTION_TIMEOUT

const string kinetica.CreateDatasourceRequest.Options.CONNECTION_TIMEOUT = “connection_timeout”
 static

Timeout in seconds for connecting to this storage provider.

Definition at line 55 of file CreateDatasource.cs.

​
◆ CREDENTIAL

const string kinetica.CreateDatasourceRequest.Options.CREDENTIAL = “credential”
 static

Name of the credential object to be used in data source.

Definition at line 64 of file CreateDatasource.cs.

​
◆ FALSE

const string kinetica.CreateDatasourceRequest.Options.FALSE = “false”
 static

A boolean constant for the CreateDatasourceRequest.Options options.

Definition at line 51 of file CreateDatasource.cs.

​
◆ GCS_BUCKET_NAME

const string kinetica.CreateDatasourceRequest.Options.GCS_BUCKET_NAME = “gcs_bucket_name”
 static

Name of the Google Cloud Storage bucket to use as the data source.

Definition at line 212 of file CreateDatasource.cs.

​
◆ GCS_PROJECT_ID

const string kinetica.CreateDatasourceRequest.Options.GCS_PROJECT_ID = “gcs_project_id”
 static

Name of the Google Cloud project to use as the data source.

Definition at line 216 of file CreateDatasource.cs.

​
◆ GCS_SERVICE_ACCOUNT_KEYS

const string kinetica.CreateDatasourceRequest.Options.GCS_SERVICE_ACCOUNT_KEYS = “gcs_service_account_keys”
 static

Google Cloud service account keys to use for authenticating the data source.

Definition at line 220 of file CreateDatasource.cs.

​
◆ HDFS_DELEGATION_TOKEN

const string kinetica.CreateDatasourceRequest.Options.HDFS_DELEGATION_TOKEN = “hdfs_delegation_token”
 static

Delegation token for the given HDFS user.

Definition at line 146 of file CreateDatasource.cs.

​
◆ HDFS_KERBEROS_KEYTAB

const string kinetica.CreateDatasourceRequest.Options.HDFS_KERBEROS_KEYTAB = “hdfs_kerberos_keytab”
 static

Kerberos keytab file location for the given HDFS user.

This may be a KIFS file.

Definition at line 143 of file CreateDatasource.cs.

​
◆ HDFS_USE_KERBEROS

const string kinetica.CreateDatasourceRequest.Options.HDFS_USE_KERBEROS = “hdfs_use_kerberos”
 static

Use kerberos authentication for the given HDFS cluster.

Supported values:

The default value is FALSE.

Definition at line 166 of file CreateDatasource.cs.

​
◆ IS_STREAM

const string kinetica.CreateDatasourceRequest.Options.IS_STREAM = “is_stream”
 static

To load from Azure/GCS/S3 as a stream continuously.

Supported values:

The default value is FALSE.

Definition at line 240 of file CreateDatasource.cs.

​
◆ JDBC_DRIVER_CLASS_NAME

const string kinetica.CreateDatasourceRequest.Options.JDBC_DRIVER_CLASS_NAME = “jdbc_driver_class_name”
 static

Name of the JDBC driver class.

Definition at line 251 of file CreateDatasource.cs.

​
◆ JDBC_DRIVER_JAR_PATH

const string kinetica.CreateDatasourceRequest.Options.JDBC_DRIVER_JAR_PATH = “jdbc_driver_jar_path”
 static

JDBC driver jar file location.

This may be a KIFS file.

Definition at line 248 of file CreateDatasource.cs.

​
◆ KAFKA_TOPIC_NAME

const string kinetica.CreateDatasourceRequest.Options.KAFKA_TOPIC_NAME = “kafka_topic_name”
 static

Name of the Kafka topic to use as the data source.

Definition at line 244 of file CreateDatasource.cs.

​
◆ S3_AWS_ROLE_ARN

const string kinetica.CreateDatasourceRequest.Options.S3_AWS_ROLE_ARN = “s3_aws_role_arn”
 static

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

Assuming the role requires access keys, from the CREDENTIAL or the user name and password, or USE_MANAGED_CREDENTIALS set to true; with neither, connecting to the bucket fails.

Definition at line 130 of file CreateDatasource.cs.

​
◆ S3_BUCKET_NAME

const string kinetica.CreateDatasourceRequest.Options.S3_BUCKET_NAME = “s3_bucket_name”
 static

Name of the Amazon S3 bucket to use as the data source.

Definition at line 68 of file CreateDatasource.cs.

​
◆ S3_ENCRYPTION_CUSTOMER_ALGORITHM

const string kinetica.CreateDatasourceRequest.Options.S3_ENCRYPTION_CUSTOMER_ALGORITHM = “s3_encryption_customer_algorithm”
 static

Customer encryption algorithm used encrypting data.

Definition at line 134 of file CreateDatasource.cs.

​
◆ S3_ENCRYPTION_CUSTOMER_KEY

const string kinetica.CreateDatasourceRequest.Options.S3_ENCRYPTION_CUSTOMER_KEY = “s3_encryption_customer_key”
 static

Customer encryption key to encrypt or decrypt data.

Definition at line 138 of file CreateDatasource.cs.

​
◆ S3_REGION

const string kinetica.CreateDatasourceRequest.Options.S3_REGION = “s3_region”
 static

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

Definition at line 72 of file CreateDatasource.cs.

​
◆ S3_USE_VIRTUAL_ADDRESSING

const string kinetica.CreateDatasourceRequest.Options.S3_USE_VIRTUAL_ADDRESSING = “s3_use_virtual_addressing”
 static

Whether to use virtual addressing when referencing the Amazon S3 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.

Definition at line 119 of file CreateDatasource.cs.

​
◆ S3_VERIFY_SSL

const string kinetica.CreateDatasourceRequest.Options.S3_VERIFY_SSL = “s3_verify_ssl”
 static

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.

Definition at line 95 of file CreateDatasource.cs.

​
◆ SCHEMA_REGISTRY_CONNECTION_RETRIES

const string kinetica.CreateDatasourceRequest.Options.SCHEMA_REGISTRY_CONNECTION_RETRIES = “schema_registry_connection_retries”
 static

Confluent Schema registry connection timeout (in secs).

Definition at line 331 of file CreateDatasource.cs.

​
◆ SCHEMA_REGISTRY_CONNECTION_TIMEOUT

const string kinetica.CreateDatasourceRequest.Options.SCHEMA_REGISTRY_CONNECTION_TIMEOUT = “schema_registry_connection_timeout”
 static

Confluent Schema registry connection timeout (in secs).

Definition at line 335 of file CreateDatasource.cs.

​
◆ SCHEMA_REGISTRY_CREDENTIAL

const string kinetica.CreateDatasourceRequest.Options.SCHEMA_REGISTRY_CREDENTIAL = “schema_registry_credential”
 static

Confluent Schema Registry credential object name.

Definition at line 324 of file CreateDatasource.cs.

​
◆ SCHEMA_REGISTRY_LOCATION

const string kinetica.CreateDatasourceRequest.Options.SCHEMA_REGISTRY_LOCATION = “schema_registry_location”
 static

Location of Confluent Schema Registry in ‘[storage_path[:storage_port]]’ format.

Definition at line 319 of file CreateDatasource.cs.

​
◆ SCHEMA_REGISTRY_PORT

const string kinetica.CreateDatasourceRequest.Options.SCHEMA_REGISTRY_PORT = “schema_registry_port”
 static

Confluent Schema Registry port (optional).

Definition at line 327 of file CreateDatasource.cs.

​
◆ SKIP_VALIDATION

const string kinetica.CreateDatasourceRequest.Options.SKIP_VALIDATION = “skip_validation”
 static

Bypass validation of connection to remote source.

Supported values:

The default value is FALSE.

Definition at line 43 of file CreateDatasource.cs.

​
◆ TRUE

const string kinetica.CreateDatasourceRequest.Options.TRUE = “true”
 static

A boolean constant for the CreateDatasourceRequest.Options options.

Definition at line 47 of file CreateDatasource.cs.

​
◆ USE_HTTPS

const string kinetica.CreateDatasourceRequest.Options.USE_HTTPS = “use_https”
 static

Use HTTPS to connect to datasource if true, otherwise use HTTP.

Supported values:

The default value is TRUE.

Definition at line 315 of file CreateDatasource.cs.

​
◆ USE_MANAGED_CREDENTIALS

const string kinetica.CreateDatasourceRequest.Options.USE_MANAGED_CREDENTIALS = “use_managed_credentials”
 static

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 295 of file CreateDatasource.cs.

​
◆ WAIT_TIMEOUT

const string kinetica.CreateDatasourceRequest.Options.WAIT_TIMEOUT = “wait_timeout”
 static

Timeout in seconds for reading from this storage provider.

Definition at line 59 of file CreateDatasource.cs.

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