> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.AlterDatasinkRequest.DatasinkUpdatesMap > kinetica.AlterDatasinkRequest.DatasinkUpdatesMap — Kinetica C# API

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](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 244 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 161 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 171 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 168 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 157 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 164 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 195 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 323 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 199 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 203 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 207 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 133 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 130 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 153 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 214 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 211 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 320 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 222 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](http://172.123.45.67:9300)'.

Definition at line 218 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 291 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 296 of file AlterDatasink.cs.

◆ NESTED

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.NESTED = "nested"
static

Records are returned as an array per message.

Definition at line 326 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.

Definition at line 111 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 115 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 119 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 122 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 125 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 355 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 346 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 286 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 266 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 files: