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

Public Attributes
const string	DESTINATION = "destination"
	Destination for the output data in format 'destination_type://path[:port]'. More...

const string	CONNECTION_TIMEOUT = "connection_timeout"
	Timeout in seconds for connecting to this sink. More...

const string	WAIT_TIMEOUT = "wait_timeout"
	Timeout in seconds for waiting for a response from this 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"
	Whether to verify SSL connections. More...

const string	TRUE = "true"

const string	FALSE = "false"

const string	S3_USE_VIRTUAL_ADDRESSING = "s3_use_virtual_addressing"
	Whether to use virtual addressing when referencing the Amazon S3 sink. 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. 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	AZURE_USE_VIRTUAL_ADDRESSING = "azure_use_virtual_addressing"
	Whether to use virtual addressing when referencing the Azure source. 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_URL = "kafka_url"
	The publicly-accessible full path URL to the kafka broker, e.g., 'http://172.123.45.67:9300'. More...

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

const string	ANONYMOUS = "anonymous"
	Create an anonymous connection to the storage provider–DEPRECATED: this is now the default. More...

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. 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"
	A single record is returned per message. More...

const string	NESTED = "nested"
	Records are returned as an array per message. More...

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

const string	SCHEMA_NAME = "schema_name"
	Updates the schema name. More...

Detailed Description

A set of string constants for the parameter 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 AlterDatasinkRequest.DatasinkUpdatesMap.ANONYMOUS = "anonymous"

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

Supported values:

TRUE
FALSE

The default value is TRUE.

Definition at line 218 of file AlterDatasink.cs.

◆ AZURE_CONTAINER_NAME

const string AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_CONTAINER_NAME = "azure_container_name"

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

Definition at line 144 of file AlterDatasink.cs.

◆ AZURE_OAUTH_TOKEN

const string AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_OAUTH_TOKEN = "azure_oauth_token"

OAuth token to access given storage container.

Definition at line 154 of file AlterDatasink.cs.

◆ AZURE_SAS_TOKEN

const string AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_SAS_TOKEN = "azure_sas_token"

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

Definition at line 151 of file AlterDatasink.cs.

◆ AZURE_STORAGE_ACCOUNT_NAME

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

◆ AZURE_TENANT_ID

const string AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_TENANT_ID = "azure_tenant_id"

Active Directory tenant ID (or directory ID).

Definition at line 147 of file AlterDatasink.cs.

◆ AZURE_USE_VIRTUAL_ADDRESSING

const string AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_USE_VIRTUAL_ADDRESSING = "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.

Definition at line 175 of file AlterDatasink.cs.

◆ CONNECTION_TIMEOUT

const string AlterDatasinkRequest.DatasinkUpdatesMap.CONNECTION_TIMEOUT = "connection_timeout"

Timeout in seconds for connecting to this sink.

Definition at line 33 of file AlterDatasink.cs.

◆ CREDENTIAL

const string AlterDatasinkRequest.DatasinkUpdatesMap.CREDENTIAL = "credential"

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

Definition at line 42 of file AlterDatasink.cs.

◆ DESTINATION

const string AlterDatasinkRequest.DatasinkUpdatesMap.DESTINATION = "destination"

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 AlterDatasinkRequest.DatasinkUpdatesMap.FALSE = "false"

Definition at line 73 of file AlterDatasink.cs.

◆ FLAT

const string AlterDatasinkRequest.DatasinkUpdatesMap.FLAT = "flat"

A single record is returned per message.

Definition at line 284 of file AlterDatasink.cs.

◆ GCS_BUCKET_NAME

const string AlterDatasinkRequest.DatasinkUpdatesMap.GCS_BUCKET_NAME = "gcs_bucket_name"

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

Definition at line 179 of file AlterDatasink.cs.

◆ GCS_PROJECT_ID

const string AlterDatasinkRequest.DatasinkUpdatesMap.GCS_PROJECT_ID = "gcs_project_id"

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

Definition at line 183 of file AlterDatasink.cs.

◆ GCS_SERVICE_ACCOUNT_KEYS

const string AlterDatasinkRequest.DatasinkUpdatesMap.GCS_SERVICE_ACCOUNT_KEYS = "gcs_service_account_keys"

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

Definition at line 187 of file AlterDatasink.cs.

◆ HDFS_DELEGATION_TOKEN

const string AlterDatasinkRequest.DatasinkUpdatesMap.HDFS_DELEGATION_TOKEN = "hdfs_delegation_token"

Delegation token for the given HDFS user.

Definition at line 120 of file AlterDatasink.cs.

◆ HDFS_KERBEROS_KEYTAB

const string AlterDatasinkRequest.DatasinkUpdatesMap.HDFS_KERBEROS_KEYTAB = "hdfs_kerberos_keytab"

Kerberos keytab file location for the given HDFS user.

This may be a KIFS file.

Definition at line 117 of file AlterDatasink.cs.

◆ HDFS_USE_KERBEROS

const string AlterDatasinkRequest.DatasinkUpdatesMap.HDFS_USE_KERBEROS = "hdfs_use_kerberos"

Use kerberos authentication for the given HDFS cluster.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 136 of file AlterDatasink.cs.

◆ JDBC_DRIVER_CLASS_NAME

const string AlterDatasinkRequest.DatasinkUpdatesMap.JDBC_DRIVER_CLASS_NAME = "jdbc_driver_class_name"

Name of the JDBC driver class.

Definition at line 194 of file AlterDatasink.cs.

◆ JDBC_DRIVER_JAR_PATH

const string AlterDatasinkRequest.DatasinkUpdatesMap.JDBC_DRIVER_JAR_PATH = "jdbc_driver_jar_path"

JDBC driver jar file location.

This may be a KIFS file.

Definition at line 191 of file AlterDatasink.cs.

◆ JSON_FORMAT

const string AlterDatasinkRequest.DatasinkUpdatesMap.JSON_FORMAT = "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.

Definition at line 281 of file AlterDatasink.cs.

◆ KAFKA_TOPIC_NAME

const string AlterDatasinkRequest.DatasinkUpdatesMap.KAFKA_TOPIC_NAME = "kafka_topic_name"

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

Definition at line 202 of file AlterDatasink.cs.

◆ KAFKA_URL

const string AlterDatasinkRequest.DatasinkUpdatesMap.KAFKA_URL = "kafka_url"

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

Definition at line 198 of file AlterDatasink.cs.

◆ MAX_BATCH_SIZE

const string AlterDatasinkRequest.DatasinkUpdatesMap.MAX_BATCH_SIZE = "max_batch_size"

Maximum number of records per notification message.

The default value is '1'.

Definition at line 255 of file AlterDatasink.cs.

◆ MAX_MESSAGE_SIZE

const string AlterDatasinkRequest.DatasinkUpdatesMap.MAX_MESSAGE_SIZE = "max_message_size"

Maximum size in bytes of each notification message.

The default value is '1000000'.

Definition at line 260 of file AlterDatasink.cs.

◆ NESTED

const string AlterDatasinkRequest.DatasinkUpdatesMap.NESTED = "nested"

Records are returned as an array per message.

Definition at line 287 of file AlterDatasink.cs.

◆ S3_AWS_ROLE_ARN

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

◆ S3_BUCKET_NAME

const string AlterDatasinkRequest.DatasinkUpdatesMap.S3_BUCKET_NAME = "s3_bucket_name"

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 AlterDatasinkRequest.DatasinkUpdatesMap.S3_ENCRYPTION_CUSTOMER_ALGORITHM = "s3_encryption_customer_algorithm"

Customer encryption algorithm used encrypting data.

Definition at line 102 of file AlterDatasink.cs.

◆ S3_ENCRYPTION_CUSTOMER_KEY

const string AlterDatasinkRequest.DatasinkUpdatesMap.S3_ENCRYPTION_CUSTOMER_KEY = "s3_encryption_customer_key"

Customer encryption key to encrypt or decrypt data.

Definition at line 106 of file AlterDatasink.cs.

◆ S3_ENCRYPTION_TYPE

const string AlterDatasinkRequest.DatasinkUpdatesMap.S3_ENCRYPTION_TYPE = "s3_encryption_type"

Server side encryption type.

Definition at line 109 of file AlterDatasink.cs.

◆ S3_KMS_KEY_ID

const string AlterDatasinkRequest.DatasinkUpdatesMap.S3_KMS_KEY_ID = "s3_kms_key_id"

KMS key.

Definition at line 112 of file AlterDatasink.cs.

◆ S3_REGION

const string AlterDatasinkRequest.DatasinkUpdatesMap.S3_REGION = "s3_region"

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 AlterDatasinkRequest.DatasinkUpdatesMap.S3_USE_VIRTUAL_ADDRESSING = "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.

Definition at line 94 of file AlterDatasink.cs.

◆ S3_VERIFY_SSL

const string AlterDatasinkRequest.DatasinkUpdatesMap.S3_VERIFY_SSL = "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.

Definition at line 70 of file AlterDatasink.cs.

◆ SCHEMA_NAME

const string AlterDatasinkRequest.DatasinkUpdatesMap.SCHEMA_NAME = "schema_name"

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 311 of file AlterDatasink.cs.

◆ SKIP_VALIDATION

const string AlterDatasinkRequest.DatasinkUpdatesMap.SKIP_VALIDATION = "skip_validation"

Bypass validation of connection to this data sink.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 303 of file AlterDatasink.cs.

◆ TRUE

const string AlterDatasinkRequest.DatasinkUpdatesMap.TRUE = "true"

Definition at line 72 of file AlterDatasink.cs.

◆ USE_HTTPS

const string AlterDatasinkRequest.DatasinkUpdatesMap.USE_HTTPS = "use_https"

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

Supported values:

TRUE
FALSE

The default value is TRUE.

Definition at line 250 of file AlterDatasink.cs.

◆ USE_MANAGED_CREDENTIALS

const string AlterDatasinkRequest.DatasinkUpdatesMap.USE_MANAGED_CREDENTIALS = "use_managed_credentials"

When no credentials are supplied, we use anonymous access by default.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 234 of file AlterDatasink.cs.

◆ WAIT_TIMEOUT

const string AlterDatasinkRequest.DatasinkUpdatesMap.WAIT_TIMEOUT = "wait_timeout"

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:

Kinetica/Protocol/AlterDatasink.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ ANONYMOUS

◆ AZURE_CONTAINER_NAME

◆ AZURE_OAUTH_TOKEN

◆ AZURE_SAS_TOKEN

◆ AZURE_STORAGE_ACCOUNT_NAME

◆ AZURE_TENANT_ID

◆ AZURE_USE_VIRTUAL_ADDRESSING

◆ CONNECTION_TIMEOUT

◆ CREDENTIAL

◆ DESTINATION

◆ FALSE

◆ FLAT

◆ GCS_BUCKET_NAME

◆ GCS_PROJECT_ID

◆ GCS_SERVICE_ACCOUNT_KEYS

◆ HDFS_DELEGATION_TOKEN

◆ HDFS_KERBEROS_KEYTAB

◆ HDFS_USE_KERBEROS

◆ JDBC_DRIVER_CLASS_NAME

◆ JDBC_DRIVER_JAR_PATH

◆ JSON_FORMAT

◆ KAFKA_TOPIC_NAME

◆ KAFKA_URL

◆ MAX_BATCH_SIZE

◆ MAX_MESSAGE_SIZE

◆ NESTED

◆ S3_AWS_ROLE_ARN

◆ S3_BUCKET_NAME

◆ S3_ENCRYPTION_CUSTOMER_ALGORITHM

◆ S3_ENCRYPTION_CUSTOMER_KEY

◆ S3_ENCRYPTION_TYPE

◆ S3_KMS_KEY_ID

◆ S3_REGION

◆ S3_USE_VIRTUAL_ADDRESSING

◆ S3_VERIFY_SSL

◆ SCHEMA_NAME

◆ SKIP_VALIDATION

◆ TRUE

◆ USE_HTTPS

◆ USE_MANAGED_CREDENTIALS

◆ WAIT_TIMEOUT