Skip to main content

A set of string constants for the parameter AlterDatasinkRequest.datasink_updates_map. More…

​
Static Public Attributes

const string DESTINATION = “destination”
 Destination for the output data in format ‘destination_type://path[:port]’.
 
const string CONNECTION_TIMEOUT = “connection_timeout”
 Timeout in seconds for connecting to this sink.
 
const string WAIT_TIMEOUT = “wait_timeout”
 Timeout in seconds for waiting for a response from this sink.
 
const string CREDENTIAL = “credential”
 Name of the credential object to be used in this data sink.
 
const string S3_BUCKET_NAME = “s3_bucket_name”
 Name of the Amazon S3 bucket to use as the data sink.
 
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 TRUE = “true”
 A boolean constant for the AlterDatasinkRequest.DatasinkUpdatesMap options.
 
const string FALSE = “false”
 A boolean constant for the AlterDatasinkRequest.DatasinkUpdatesMap options.
 
const string S3_USE_VIRTUAL_ADDRESSING = “s3_use_virtual_addressing”
 Whether to use virtual addressing when referencing the Amazon S3 sink.
 
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 S3_ENCRYPTION_TYPE = “s3_encryption_type”
 Server side encryption type.
 
const string S3_KMS_KEY_ID = “s3_kms_key_id”
 KMS key.
 
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 sink, 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 sink.
 
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 sink.
 
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 sink.
 
const string GCS_PROJECT_ID = “gcs_project_id”
 Name of the Google Cloud project to use as the data sink.
 
const string GCS_SERVICE_ACCOUNT_KEYS = “gcs_service_account_keys”
 Google Cloud service account keys to use for authenticating the data sink.
 
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 KAFKA_URL = “kafka_url”
 The publicly-accessible full path URL to the kafka broker, e.g., ‘http://172.123.45.67:9300’.
 
const string KAFKA_TOPIC_NAME = “kafka_topic_name”
 Name of the Kafka topic to use for this data sink, if it references a Kafka broker.
 
const string ANONYMOUS = “anonymous”
 Create an anonymous connection to the 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 datasink if true, otherwise use HTTP.
 
const string MAX_BATCH_SIZE = “max_batch_size”
 Maximum number of records per notification message.
 
const string MAX_MESSAGE_SIZE = “max_message_size”
 Maximum size in bytes of each notification message.
 
const string JSON_FORMAT = “json_format”
 The desired format of JSON encoded notifications message.
 
const string FLAT = “flat”
 A single record is returned per message.
 
const string NESTED = “nested”
 Records are returned as an array per message.
 
const string SKIP_VALIDATION = “skip_validation”
 Bypass validation of connection to this data sink.
 
const string SCHEMA_NAME = “schema_name”
 Updates the schema name.
 

​
Detailed Description

A set of string constants for the parameter AlterDatasinkRequest.datasink_updates_map.

Map containing the properties of the data sink to be updated. Error if empty.

Definition at line 23 of file AlterDatasink.cs.

​
Member Data Documentation

​
◆ ANONYMOUS

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.ANONYMOUS = “anonymous”
 static

Create an anonymous connection to the 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 247 of file AlterDatasink.cs.

​
◆ AZURE_CONTAINER_NAME

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_CONTAINER_NAME = “azure_container_name”
 static

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

Definition at line 164 of file AlterDatasink.cs.

​
◆ AZURE_OAUTH_TOKEN

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_OAUTH_TOKEN = “azure_oauth_token”
 static

OAuth token to access given storage container.

Definition at line 174 of file AlterDatasink.cs.

​
◆ AZURE_SAS_TOKEN

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_SAS_TOKEN = “azure_sas_token”
 static

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

Definition at line 171 of file AlterDatasink.cs.

​
◆ AZURE_STORAGE_ACCOUNT_NAME

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_STORAGE_ACCOUNT_NAME = “azure_storage_account_name”
 static

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

Definition at line 160 of file AlterDatasink.cs.

​
◆ AZURE_TENANT_ID

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_TENANT_ID = “azure_tenant_id”
 static

Active Directory tenant ID (or directory ID).

Definition at line 167 of file AlterDatasink.cs.

​
◆ AZURE_USE_VIRTUAL_ADDRESSING

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.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 198 of file AlterDatasink.cs.

​
◆ CONNECTION_TIMEOUT

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.CONNECTION_TIMEOUT = “connection_timeout”
 static

Timeout in seconds for connecting to this sink.

Definition at line 33 of file AlterDatasink.cs.

​
◆ CREDENTIAL

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.CREDENTIAL = “credential”
 static

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

Definition at line 42 of file AlterDatasink.cs.

​
◆ DESTINATION

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.DESTINATION = “destination”
 static

Destination for the output data in format ‘destination_type://path[:port]’.

Supported destination types are ‘azure’, ‘gcs’, ‘hdfs’, ‘http’, ‘https’, ‘jdbc’, ‘kafka’, and ‘s3’.

Definition at line 30 of file AlterDatasink.cs.

​
◆ FALSE

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.FALSE = “false”
 static

A boolean constant for the AlterDatasinkRequest.DatasinkUpdatesMap options.

Definition at line 83 of file AlterDatasink.cs.

​
◆ FLAT

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.FLAT = “flat”
 static

A single record is returned per message.

Definition at line 326 of file AlterDatasink.cs.

​
◆ GCS_BUCKET_NAME

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.GCS_BUCKET_NAME = “gcs_bucket_name”
 static

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

Definition at line 202 of file AlterDatasink.cs.

​
◆ GCS_PROJECT_ID

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.GCS_PROJECT_ID = “gcs_project_id”
 static

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

Definition at line 206 of file AlterDatasink.cs.

​
◆ GCS_SERVICE_ACCOUNT_KEYS

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.GCS_SERVICE_ACCOUNT_KEYS = “gcs_service_account_keys”
 static

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

Definition at line 210 of file AlterDatasink.cs.

​
◆ HDFS_DELEGATION_TOKEN

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.HDFS_DELEGATION_TOKEN = “hdfs_delegation_token”
 static

Delegation token for the given HDFS user.

Definition at line 136 of file AlterDatasink.cs.

​
◆ HDFS_KERBEROS_KEYTAB

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.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 133 of file AlterDatasink.cs.

​
◆ HDFS_USE_KERBEROS

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.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 156 of file AlterDatasink.cs.

​
◆ JDBC_DRIVER_CLASS_NAME

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.JDBC_DRIVER_CLASS_NAME = “jdbc_driver_class_name”
 static

Name of the JDBC driver class.

Definition at line 217 of file AlterDatasink.cs.

​
◆ JDBC_DRIVER_JAR_PATH

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.JDBC_DRIVER_JAR_PATH = “jdbc_driver_jar_path”
 static

JDBC driver jar file location.

This may be a KIFS file.

Definition at line 214 of file AlterDatasink.cs.

​
◆ JSON_FORMAT

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.JSON_FORMAT = “json_format”
 static

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.

Definition at line 323 of file AlterDatasink.cs.

​
◆ KAFKA_TOPIC_NAME

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.KAFKA_TOPIC_NAME = “kafka_topic_name”
 static

Name of the Kafka topic to use for this data sink, if it references a Kafka broker.

Definition at line 225 of file AlterDatasink.cs.

​
◆ KAFKA_URL

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.KAFKA_URL = “kafka_url”
 static

The publicly-accessible full path URL to the kafka broker, e.g., ‘http://172.123.45.67:9300’.

Definition at line 221 of file AlterDatasink.cs.

​
◆ MAX_BATCH_SIZE

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.MAX_BATCH_SIZE = “max_batch_size”
 static

Maximum number of records per notification message.

The default value is ‘1’.

Definition at line 294 of file AlterDatasink.cs.

​
◆ MAX_MESSAGE_SIZE

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.MAX_MESSAGE_SIZE = “max_message_size”
 static

Maximum size in bytes of each notification message.

The default value is ‘1000000’.

Definition at line 299 of file AlterDatasink.cs.

​
◆ NESTED

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.NESTED = “nested”
 static

Records are returned as an array per message.

Definition at line 329 of file AlterDatasink.cs.

​
◆ S3_AWS_ROLE_ARN

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.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 USE_MANAGED_CREDENTIALS set to true; with neither, connecting to the bucket fails.

Definition at line 114 of file AlterDatasink.cs.

​
◆ S3_BUCKET_NAME

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.S3_BUCKET_NAME = “s3_bucket_name”
 static

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

Definition at line 46 of file AlterDatasink.cs.

​
◆ S3_ENCRYPTION_CUSTOMER_ALGORITHM

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.S3_ENCRYPTION_CUSTOMER_ALGORITHM = “s3_encryption_customer_algorithm”
 static

Customer encryption algorithm used encrypting data.

Definition at line 118 of file AlterDatasink.cs.

​
◆ S3_ENCRYPTION_CUSTOMER_KEY

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.S3_ENCRYPTION_CUSTOMER_KEY = “s3_encryption_customer_key”
 static

Customer encryption key to encrypt or decrypt data.

Definition at line 122 of file AlterDatasink.cs.

​
◆ S3_ENCRYPTION_TYPE

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.S3_ENCRYPTION_TYPE = “s3_encryption_type”
 static

Server side encryption type.

Definition at line 125 of file AlterDatasink.cs.

​
◆ S3_KMS_KEY_ID

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.S3_KMS_KEY_ID = “s3_kms_key_id”
 static

KMS key.

Definition at line 128 of file AlterDatasink.cs.

​
◆ S3_REGION

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.S3_REGION = “s3_region”
 static

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

Definition at line 50 of file AlterDatasink.cs.

​
◆ S3_USE_VIRTUAL_ADDRESSING

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.S3_USE_VIRTUAL_ADDRESSING = “s3_use_virtual_addressing”
 static

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.

Definition at line 107 of file AlterDatasink.cs.

​
◆ S3_VERIFY_SSL

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.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 73 of file AlterDatasink.cs.

​
◆ SCHEMA_NAME

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.SCHEMA_NAME = “schema_name”
 static

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.

Definition at line 358 of file AlterDatasink.cs.

​
◆ SKIP_VALIDATION

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.SKIP_VALIDATION = “skip_validation”
 static

Bypass validation of connection to this data sink.

Supported values:

The default value is FALSE.

Definition at line 349 of file AlterDatasink.cs.

​
◆ TRUE

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.TRUE = “true”
 static

A boolean constant for the AlterDatasinkRequest.DatasinkUpdatesMap options.

Definition at line 78 of file AlterDatasink.cs.

​
◆ USE_HTTPS

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.USE_HTTPS = “use_https”
 static

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

Supported values:

The default value is TRUE.

Definition at line 289 of file AlterDatasink.cs.

​
◆ USE_MANAGED_CREDENTIALS

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.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 269 of file AlterDatasink.cs.

​
◆ WAIT_TIMEOUT

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.WAIT_TIMEOUT = “wait_timeout”
 static

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

Definition at line 37 of file AlterDatasink.cs.

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