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

Public Attributes
const string	LOCATION = "location"
	Location of the remote storage in 'storage_provider_type://[storage_path[:storage_port]]' format. More...

const string	USER_NAME = "user_name"
	Name of the remote system user; may be an empty string. More...

const string	PASSWORD = "password"
	Password for the remote system user; may be an empty string. More...

const string	SKIP_VALIDATION = "skip_validation"
	Bypass validation of connection to remote source. More...

const string	TRUE = "true"

const string	FALSE = "false"

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

const string	WAIT_TIMEOUT = "wait_timeout"
	Timeout in seconds for reading from this storage provider. More...

const string	CREDENTIAL = "credential"
	Name of the credential object to be used in data source. More...

const string	S3_BUCKET_NAME = "s3_bucket_name"
	Name of the Amazon S3 bucket to use as the data source. 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	S3_USE_VIRTUAL_ADDRESSING = "s3_use_virtual_addressing"
	Whether to use virtual addressing when referencing the Amazon S3 source. 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	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 source, 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 source. 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 source. 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 source. More...

const string	GCS_PROJECT_ID = "gcs_project_id"
	Name of the Google Cloud project to use as the data source. More...

const string	GCS_SERVICE_ACCOUNT_KEYS = "gcs_service_account_keys"
	Google Cloud service account keys to use for authenticating the data source. 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 as the data source. 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 datasource if true, otherwise use HTTP. More...

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

const string	SCHEMA_REGISTRY_CONNECTION_RETRIES = "schema_registry_connection_retries"
	Confluent Schema registry connection timeout (in secs). More...

const string	SCHEMA_REGISTRY_CONNECTION_TIMEOUT = "schema_registry_connection_timeout"
	Confluent Schema registry connection timeout (in secs). More...

const string	SCHEMA_REGISTRY_CREDENTIAL = "schema_registry_credential"
	Confluent Schema Registry credential object name. More...

const string	SCHEMA_REGISTRY_LOCATION = "schema_registry_location"
	Location of Confluent Schema Registry in '[storage_path[:storage_port]]' format. More...

const string	SCHEMA_REGISTRY_PORT = "schema_registry_port"
	Confluent Schema Registry port (optional). More...

Detailed Description

A set of string constants for the parameter datasource_updates_map.

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

Definition at line 23 of file AlterDatasource.cs.

Member Data Documentation

◆ ANONYMOUS

const string AlterDatasourceRequest.DatasourceUpdatesMap.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 241 of file AlterDatasource.cs.

◆ AZURE_CONTAINER_NAME

const string AlterDatasourceRequest.DatasourceUpdatesMap.AZURE_CONTAINER_NAME = "azure_container_name"

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

Definition at line 166 of file AlterDatasource.cs.

◆ AZURE_OAUTH_TOKEN

const string AlterDatasourceRequest.DatasourceUpdatesMap.AZURE_OAUTH_TOKEN = "azure_oauth_token"

OAuth token to access given storage container.

Definition at line 176 of file AlterDatasource.cs.

◆ AZURE_SAS_TOKEN

const string AlterDatasourceRequest.DatasourceUpdatesMap.AZURE_SAS_TOKEN = "azure_sas_token"

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

Definition at line 173 of file AlterDatasource.cs.

◆ AZURE_STORAGE_ACCOUNT_NAME

const string AlterDatasourceRequest.DatasourceUpdatesMap.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.

Definition at line 162 of file AlterDatasource.cs.

◆ AZURE_TENANT_ID

const string AlterDatasourceRequest.DatasourceUpdatesMap.AZURE_TENANT_ID = "azure_tenant_id"

Active Directory tenant ID (or directory ID).

Definition at line 169 of file AlterDatasource.cs.

◆ AZURE_USE_VIRTUAL_ADDRESSING

const string AlterDatasourceRequest.DatasourceUpdatesMap.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 197 of file AlterDatasource.cs.

◆ CONNECTION_TIMEOUT

const string AlterDatasourceRequest.DatasourceUpdatesMap.CONNECTION_TIMEOUT = "connection_timeout"

Timeout in seconds for connecting to this storage provider.

Definition at line 63 of file AlterDatasource.cs.

◆ CREDENTIAL

const string AlterDatasourceRequest.DatasourceUpdatesMap.CREDENTIAL = "credential"

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

Definition at line 72 of file AlterDatasource.cs.

◆ FALSE

const string AlterDatasourceRequest.DatasourceUpdatesMap.FALSE = "false"

Definition at line 59 of file AlterDatasource.cs.

◆ GCS_BUCKET_NAME

const string AlterDatasourceRequest.DatasourceUpdatesMap.GCS_BUCKET_NAME = "gcs_bucket_name"

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

Definition at line 201 of file AlterDatasource.cs.

◆ GCS_PROJECT_ID

const string AlterDatasourceRequest.DatasourceUpdatesMap.GCS_PROJECT_ID = "gcs_project_id"

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

Definition at line 205 of file AlterDatasource.cs.

◆ GCS_SERVICE_ACCOUNT_KEYS

const string AlterDatasourceRequest.DatasourceUpdatesMap.GCS_SERVICE_ACCOUNT_KEYS = "gcs_service_account_keys"

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

Definition at line 209 of file AlterDatasource.cs.

◆ HDFS_DELEGATION_TOKEN

const string AlterDatasourceRequest.DatasourceUpdatesMap.HDFS_DELEGATION_TOKEN = "hdfs_delegation_token"

Delegation token for the given HDFS user.

Definition at line 141 of file AlterDatasource.cs.

◆ HDFS_KERBEROS_KEYTAB

const string AlterDatasourceRequest.DatasourceUpdatesMap.HDFS_KERBEROS_KEYTAB = "hdfs_kerberos_keytab"

Kerberos keytab file location for the given HDFS user.

This may be a KIFS file.

Definition at line 138 of file AlterDatasource.cs.

◆ HDFS_USE_KERBEROS

const string AlterDatasourceRequest.DatasourceUpdatesMap.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 158 of file AlterDatasource.cs.

◆ JDBC_DRIVER_CLASS_NAME

const string AlterDatasourceRequest.DatasourceUpdatesMap.JDBC_DRIVER_CLASS_NAME = "jdbc_driver_class_name"

Name of the JDBC driver class.

Definition at line 216 of file AlterDatasource.cs.

◆ JDBC_DRIVER_JAR_PATH

const string AlterDatasourceRequest.DatasourceUpdatesMap.JDBC_DRIVER_JAR_PATH = "jdbc_driver_jar_path"

JDBC driver jar file location.

This may be a KIFS file.

Definition at line 213 of file AlterDatasource.cs.

◆ KAFKA_TOPIC_NAME

const string AlterDatasourceRequest.DatasourceUpdatesMap.KAFKA_TOPIC_NAME = "kafka_topic_name"

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

Definition at line 224 of file AlterDatasource.cs.

◆ KAFKA_URL

const string AlterDatasourceRequest.DatasourceUpdatesMap.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 220 of file AlterDatasource.cs.

◆ LOCATION

const string AlterDatasourceRequest.DatasourceUpdatesMap.LOCATION = "location"

Location of the remote storage in 'storage_provider_type://[storage_path[:storage_port]]' format.

Supported storage provider types are 'azure', 'gcs', 'hdfs', 'jdbc', 'kafka', 'confluent', and 's3'.

Definition at line 31 of file AlterDatasource.cs.

◆ PASSWORD

const string AlterDatasourceRequest.DatasourceUpdatesMap.PASSWORD = "password"

Password for the remote system user; may be an empty string.

Definition at line 39 of file AlterDatasource.cs.

◆ S3_AWS_ROLE_ARN

const string AlterDatasourceRequest.DatasourceUpdatesMap.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 125 of file AlterDatasource.cs.

◆ S3_BUCKET_NAME

const string AlterDatasourceRequest.DatasourceUpdatesMap.S3_BUCKET_NAME = "s3_bucket_name"

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

Definition at line 76 of file AlterDatasource.cs.

◆ S3_ENCRYPTION_CUSTOMER_ALGORITHM

const string AlterDatasourceRequest.DatasourceUpdatesMap.S3_ENCRYPTION_CUSTOMER_ALGORITHM = "s3_encryption_customer_algorithm"

Customer encryption algorithm used encrypting data.

Definition at line 129 of file AlterDatasource.cs.

◆ S3_ENCRYPTION_CUSTOMER_KEY

const string AlterDatasourceRequest.DatasourceUpdatesMap.S3_ENCRYPTION_CUSTOMER_KEY = "s3_encryption_customer_key"

Customer encryption key to encrypt or decrypt data.

Definition at line 133 of file AlterDatasource.cs.

◆ S3_REGION

const string AlterDatasourceRequest.DatasourceUpdatesMap.S3_REGION = "s3_region"

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

Definition at line 80 of file AlterDatasource.cs.

◆ S3_USE_VIRTUAL_ADDRESSING

const string AlterDatasourceRequest.DatasourceUpdatesMap.S3_USE_VIRTUAL_ADDRESSING = "s3_use_virtual_addressing"

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 121 of file AlterDatasource.cs.

◆ S3_VERIFY_SSL

const string AlterDatasourceRequest.DatasourceUpdatesMap.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 100 of file AlterDatasource.cs.

◆ SCHEMA_NAME

const string AlterDatasourceRequest.DatasourceUpdatesMap.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 283 of file AlterDatasource.cs.

◆ SCHEMA_REGISTRY_CONNECTION_RETRIES

const string AlterDatasourceRequest.DatasourceUpdatesMap.SCHEMA_REGISTRY_CONNECTION_RETRIES = "schema_registry_connection_retries"

Confluent Schema registry connection timeout (in secs).

Definition at line 287 of file AlterDatasource.cs.

◆ SCHEMA_REGISTRY_CONNECTION_TIMEOUT

const string AlterDatasourceRequest.DatasourceUpdatesMap.SCHEMA_REGISTRY_CONNECTION_TIMEOUT = "schema_registry_connection_timeout"

Confluent Schema registry connection timeout (in secs).

Definition at line 291 of file AlterDatasource.cs.

◆ SCHEMA_REGISTRY_CREDENTIAL

const string AlterDatasourceRequest.DatasourceUpdatesMap.SCHEMA_REGISTRY_CREDENTIAL = "schema_registry_credential"

Confluent Schema Registry credential object name.

Definition at line 296 of file AlterDatasource.cs.

◆ SCHEMA_REGISTRY_LOCATION

const string AlterDatasourceRequest.DatasourceUpdatesMap.SCHEMA_REGISTRY_LOCATION = "schema_registry_location"

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

Definition at line 300 of file AlterDatasource.cs.

◆ SCHEMA_REGISTRY_PORT

const string AlterDatasourceRequest.DatasourceUpdatesMap.SCHEMA_REGISTRY_PORT = "schema_registry_port"

Confluent Schema Registry port (optional).

Definition at line 303 of file AlterDatasource.cs.

◆ SKIP_VALIDATION

const string AlterDatasourceRequest.DatasourceUpdatesMap.SKIP_VALIDATION = "skip_validation"

Bypass validation of connection to remote source.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 56 of file AlterDatasource.cs.

◆ TRUE

const string AlterDatasourceRequest.DatasourceUpdatesMap.TRUE = "true"

Definition at line 58 of file AlterDatasource.cs.

◆ USE_HTTPS

const string AlterDatasourceRequest.DatasourceUpdatesMap.USE_HTTPS = "use_https"

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

Supported values:

TRUE
FALSE

The default value is TRUE.

Definition at line 275 of file AlterDatasource.cs.

◆ USE_MANAGED_CREDENTIALS

const string AlterDatasourceRequest.DatasourceUpdatesMap.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 258 of file AlterDatasource.cs.

◆ USER_NAME

const string AlterDatasourceRequest.DatasourceUpdatesMap.USER_NAME = "user_name"

Name of the remote system user; may be an empty string.

Definition at line 35 of file AlterDatasource.cs.

◆ WAIT_TIMEOUT

const string AlterDatasourceRequest.DatasourceUpdatesMap.WAIT_TIMEOUT = "wait_timeout"

Timeout in seconds for reading from this storage provider.

Definition at line 67 of file AlterDatasource.cs.

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

Kinetica/Protocol/AlterDatasource.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

◆ FALSE

◆ 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

◆ KAFKA_TOPIC_NAME

◆ KAFKA_URL

◆ LOCATION

◆ PASSWORD

◆ S3_AWS_ROLE_ARN

◆ S3_BUCKET_NAME

◆ S3_ENCRYPTION_CUSTOMER_ALGORITHM

◆ S3_ENCRYPTION_CUSTOMER_KEY

◆ S3_REGION

◆ S3_USE_VIRTUAL_ADDRESSING

◆ S3_VERIFY_SSL

◆ SCHEMA_NAME

◆ SCHEMA_REGISTRY_CONNECTION_RETRIES

◆ SCHEMA_REGISTRY_CONNECTION_TIMEOUT

◆ SCHEMA_REGISTRY_CREDENTIAL

◆ SCHEMA_REGISTRY_LOCATION

◆ SCHEMA_REGISTRY_PORT

◆ SKIP_VALIDATION

◆ TRUE

◆ USE_HTTPS

◆ USE_MANAGED_CREDENTIALS

◆ USER_NAME

◆ WAIT_TIMEOUT