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

Map containing the properties of the data sink to be updated. 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_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 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 TRUE = "true"
 
const string FALSE = "false"
 
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 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 Supported values:

The default value is TRUE. 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 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

Map containing the properties of the data sink to be updated.

Error if empty.

  • DESTINATION: Destination for the output data in format 'destination_type://path[:port]'.
    Supported destination types are 'http', 'https' and 'kafka'.
  • CONNECTION_TIMEOUT: Timeout in seconds for connecting to this sink
  • WAIT_TIMEOUT: Timeout in seconds for waiting for a response from this sink
  • CREDENTIAL: Name of the credential object to be used in this data sink
  • S3_BUCKET_NAME: Name of the Amazon S3 bucket to use as the data sink
  • S3_REGION: Name of the Amazon S3 region where the given bucket is located
  • S3_AWS_ROLE_ARN: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
  • HDFS_KERBEROS_KEYTAB: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
  • HDFS_DELEGATION_TOKEN: Delegation token for the given HDFS user
  • HDFS_USE_KERBEROS: Use kerberos authentication for the given HDFS cluster Supported values: The default value is FALSE.
  • 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
  • AZURE_CONTAINER_NAME: Name of the Azure storage container to use as the data sink
  • AZURE_TENANT_ID: Active Directory tenant ID (or directory ID)
  • AZURE_SAS_TOKEN: Shared access signature token for Azure storage account to use as the data sink
  • AZURE_OAUTH_TOKEN: Oauth token to access given storage container
  • GCS_BUCKET_NAME: Name of the Google Cloud Storage bucket to use as the data sink
  • GCS_PROJECT_ID: Name of the Google Cloud project to use as the data sink
  • GCS_SERVICE_ACCOUNT_KEYS: Google Cloud service account keys to use for authenticating the data sink
  • KAFKA_URL: The publicly-accessible full path URL to the kafka broker, e.g., 'http://172.123.45.67:9300'.
  • KAFKA_TOPIC_NAME: Name of the Kafka topic to use for this data sink, if it references a Kafka broker
  • ANONYMOUS: 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.
  • 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.
  • USE_HTTPS: Use https to connect to datasink if true, otherwise use http Supported values: The default value is TRUE.
  • MAX_BATCH_SIZE: Maximum number of records per notification message. The default value is '1'.
  • MAX_MESSAGE_SIZE: Maximum size in bytes of each notification message. The default value is '1000000'.
  • 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.
  • SKIP_VALIDATION: Bypass validation of connection to this data sink. Supported values: The default value is FALSE.
  • 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.


A set of string constants for the parameter datasink_updates_map.

Definition at line 291 of file AlterDatasink.cs.

Member Data Documentation

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.ANONYMOUS = "anonymous"

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

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_CONTAINER_NAME = "azure_container_name"

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

Definition at line 357 of file AlterDatasink.cs.

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_OAUTH_TOKEN = "azure_oauth_token"

Oauth token to access given storage container

Definition at line 368 of file AlterDatasink.cs.

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

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

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.AZURE_TENANT_ID = "azure_tenant_id"

Active Directory tenant ID (or directory ID)

Definition at line 360 of file AlterDatasink.cs.

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.CONNECTION_TIMEOUT = "connection_timeout"

Timeout in seconds for connecting to this sink

Definition at line 303 of file AlterDatasink.cs.

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.CREDENTIAL = "credential"

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

Definition at line 312 of file AlterDatasink.cs.

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.DESTINATION = "destination"

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


Supported destination types are 'http', 'https' and 'kafka'.

Definition at line 299 of file AlterDatasink.cs.

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.FALSE = "false"

Definition at line 349 of file AlterDatasink.cs.

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.FLAT = "flat"

Definition at line 470 of file AlterDatasink.cs.

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.GCS_BUCKET_NAME = "gcs_bucket_name"

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

Definition at line 372 of file AlterDatasink.cs.

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.GCS_PROJECT_ID = "gcs_project_id"

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

Definition at line 376 of file AlterDatasink.cs.

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

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.HDFS_DELEGATION_TOKEN = "hdfs_delegation_token"

Delegation token for the given HDFS user

Definition at line 331 of file AlterDatasink.cs.

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

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.HDFS_USE_KERBEROS = "hdfs_use_kerberos"

Use kerberos authentication for the given HDFS cluster Supported values:

The default value is FALSE.

Definition at line 347 of file AlterDatasink.cs.

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

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

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

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.MAX_BATCH_SIZE = "max_batch_size"

Maximum number of records per notification message.

The default value is '1'.

Definition at line 445 of file AlterDatasink.cs.

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.MAX_MESSAGE_SIZE = "max_message_size"

Maximum size in bytes of each notification message.

The default value is '1000000'.

Definition at line 449 of file AlterDatasink.cs.

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

Definition at line 471 of file AlterDatasink.cs.

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

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.S3_BUCKET_NAME = "s3_bucket_name"

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

Definition at line 316 of file AlterDatasink.cs.

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.S3_REGION = "s3_region"

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

Definition at line 320 of file AlterDatasink.cs.

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

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.SKIP_VALIDATION = "skip_validation"

Bypass validation of connection to this data sink.

Supported values:

The default value is FALSE.

Definition at line 487 of file AlterDatasink.cs.

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.TRUE = "true"

Definition at line 348 of file AlterDatasink.cs.

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

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

const string kinetica.AlterDatasinkRequest.DatasinkUpdatesMap.WAIT_TIMEOUT = "wait_timeout"

Timeout in seconds for waiting for a response from this sink

Definition at line 307 of file AlterDatasink.cs.


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