Skip to main content

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

​
Static Public Attributes

const string LOCATION = “location”
 Location of the remote storage in ‘storage_provider_type://[storage_path[:storage_port]]’ format.
 
const string USER_NAME = “user_name”
 Name of the remote system user; may be an empty string.
 
const string PASSWORD = “password”
 Password for the remote system user; may be an empty string.
 
const string SKIP_VALIDATION = “skip_validation”
 Bypass validation of connection to remote source.
 
const string TRUE = “true”
 A boolean constant for the AlterDatasourceRequest.DatasourceUpdatesMap options.
 
const string FALSE = “false”
 A boolean constant for the AlterDatasourceRequest.DatasourceUpdatesMap options.
 
const string CONNECTION_TIMEOUT = “connection_timeout”
 Timeout in seconds for connecting to this storage provider.
 
const string WAIT_TIMEOUT = “wait_timeout”
 Timeout in seconds for reading from this storage provider.
 
const string CREDENTIAL = “credential”
 Name of the credential object to be used in data source.
 
const string S3_BUCKET_NAME = “s3_bucket_name”
 Name of the Amazon S3 bucket to use as the data source.
 
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 S3_USE_VIRTUAL_ADDRESSING = “s3_use_virtual_addressing”
 Whether to use virtual addressing when referencing the Amazon S3 source.
 
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 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 source, 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 source.
 
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 source.
 
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 source.
 
const string GCS_PROJECT_ID = “gcs_project_id”
 Name of the Google Cloud project to use as the data source.
 
const string GCS_SERVICE_ACCOUNT_KEYS = “gcs_service_account_keys”
 Google Cloud service account keys to use for authenticating the data source.
 
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 as the data source.
 
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 datasource if true, otherwise use HTTP.
 
const string SCHEMA_NAME = “schema_name”
 Updates the schema name.
 
const string SCHEMA_REGISTRY_CONNECTION_RETRIES = “schema_registry_connection_retries”
 Confluent Schema registry connection timeout (in secs).
 
const string SCHEMA_REGISTRY_CONNECTION_TIMEOUT = “schema_registry_connection_timeout”
 Confluent Schema registry connection timeout (in secs).
 
const string SCHEMA_REGISTRY_CREDENTIAL = “schema_registry_credential”
 Confluent Schema Registry credential object name.
 
const string SCHEMA_REGISTRY_LOCATION = “schema_registry_location”
 Location of Confluent Schema Registry in ‘[storage_path[:storage_port]]’ format.
 
const string SCHEMA_REGISTRY_PORT = “schema_registry_port”
 Confluent Schema Registry port (optional).
 

​
Detailed Description

A set of string constants for the parameter AlterDatasourceRequest.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 kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.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 268 of file AlterDatasource.cs.

​
◆ AZURE_CONTAINER_NAME

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.AZURE_CONTAINER_NAME = “azure_container_name”
 static

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

Definition at line 185 of file AlterDatasource.cs.

​
◆ AZURE_OAUTH_TOKEN

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.AZURE_OAUTH_TOKEN = “azure_oauth_token”
 static

OAuth token to access given storage container.

Definition at line 195 of file AlterDatasource.cs.

​
◆ AZURE_SAS_TOKEN

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.AZURE_SAS_TOKEN = “azure_sas_token”
 static

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

Definition at line 192 of file AlterDatasource.cs.

​
◆ AZURE_STORAGE_ACCOUNT_NAME

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.AZURE_STORAGE_ACCOUNT_NAME = “azure_storage_account_name”
 static

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

Definition at line 181 of file AlterDatasource.cs.

​
◆ AZURE_TENANT_ID

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.AZURE_TENANT_ID = “azure_tenant_id”
 static

Active Directory tenant ID (or directory ID).

Definition at line 188 of file AlterDatasource.cs.

​
◆ AZURE_USE_VIRTUAL_ADDRESSING

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

​
◆ CONNECTION_TIMEOUT

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.CONNECTION_TIMEOUT = “connection_timeout”
 static

Timeout in seconds for connecting to this storage provider.

Definition at line 73 of file AlterDatasource.cs.

​
◆ CREDENTIAL

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.CREDENTIAL = “credential”
 static

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

Definition at line 82 of file AlterDatasource.cs.

​
◆ FALSE

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.FALSE = “false”
 static

A boolean constant for the AlterDatasourceRequest.DatasourceUpdatesMap options.

Definition at line 69 of file AlterDatasource.cs.

​
◆ GCS_BUCKET_NAME

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.GCS_BUCKET_NAME = “gcs_bucket_name”
 static

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

Definition at line 223 of file AlterDatasource.cs.

​
◆ GCS_PROJECT_ID

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.GCS_PROJECT_ID = “gcs_project_id”
 static

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

Definition at line 227 of file AlterDatasource.cs.

​
◆ GCS_SERVICE_ACCOUNT_KEYS

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.GCS_SERVICE_ACCOUNT_KEYS = “gcs_service_account_keys”
 static

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

Definition at line 231 of file AlterDatasource.cs.

​
◆ HDFS_DELEGATION_TOKEN

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.HDFS_DELEGATION_TOKEN = “hdfs_delegation_token”
 static

Delegation token for the given HDFS user.

Definition at line 157 of file AlterDatasource.cs.

​
◆ HDFS_KERBEROS_KEYTAB

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

​
◆ HDFS_USE_KERBEROS

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

​
◆ JDBC_DRIVER_CLASS_NAME

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.JDBC_DRIVER_CLASS_NAME = “jdbc_driver_class_name”
 static

Name of the JDBC driver class.

Definition at line 238 of file AlterDatasource.cs.

​
◆ JDBC_DRIVER_JAR_PATH

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.JDBC_DRIVER_JAR_PATH = “jdbc_driver_jar_path”
 static

JDBC driver jar file location.

This may be a KIFS file.

Definition at line 235 of file AlterDatasource.cs.

​
◆ KAFKA_TOPIC_NAME

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.KAFKA_TOPIC_NAME = “kafka_topic_name”
 static

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

Definition at line 246 of file AlterDatasource.cs.

​
◆ KAFKA_URL

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

​
◆ LOCATION

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.LOCATION = “location”
 static

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 kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.PASSWORD = “password”
 static

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 kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.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 141 of file AlterDatasource.cs.

​
◆ S3_BUCKET_NAME

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.S3_BUCKET_NAME = “s3_bucket_name”
 static

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

Definition at line 86 of file AlterDatasource.cs.

​
◆ S3_ENCRYPTION_CUSTOMER_ALGORITHM

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.S3_ENCRYPTION_CUSTOMER_ALGORITHM = “s3_encryption_customer_algorithm”
 static

Customer encryption algorithm used encrypting data.

Definition at line 145 of file AlterDatasource.cs.

​
◆ S3_ENCRYPTION_CUSTOMER_KEY

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.S3_ENCRYPTION_CUSTOMER_KEY = “s3_encryption_customer_key”
 static

Customer encryption key to encrypt or decrypt data.

Definition at line 149 of file AlterDatasource.cs.

​
◆ S3_REGION

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.S3_REGION = “s3_region”
 static

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

Definition at line 90 of file AlterDatasource.cs.

​
◆ S3_USE_VIRTUAL_ADDRESSING

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.S3_USE_VIRTUAL_ADDRESSING = “s3_use_virtual_addressing”
 static

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

​
◆ S3_VERIFY_SSL

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

​
◆ SCHEMA_NAME

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

​
◆ SCHEMA_REGISTRY_CONNECTION_RETRIES

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.SCHEMA_REGISTRY_CONNECTION_RETRIES = “schema_registry_connection_retries”
 static

Confluent Schema registry connection timeout (in secs).

Definition at line 323 of file AlterDatasource.cs.

​
◆ SCHEMA_REGISTRY_CONNECTION_TIMEOUT

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.SCHEMA_REGISTRY_CONNECTION_TIMEOUT = “schema_registry_connection_timeout”
 static

Confluent Schema registry connection timeout (in secs).

Definition at line 327 of file AlterDatasource.cs.

​
◆ SCHEMA_REGISTRY_CREDENTIAL

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.SCHEMA_REGISTRY_CREDENTIAL = “schema_registry_credential”
 static

Confluent Schema Registry credential object name.

Definition at line 332 of file AlterDatasource.cs.

​
◆ SCHEMA_REGISTRY_LOCATION

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.SCHEMA_REGISTRY_LOCATION = “schema_registry_location”
 static

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

Definition at line 336 of file AlterDatasource.cs.

​
◆ SCHEMA_REGISTRY_PORT

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.SCHEMA_REGISTRY_PORT = “schema_registry_port”
 static

Confluent Schema Registry port (optional).

Definition at line 339 of file AlterDatasource.cs.

​
◆ SKIP_VALIDATION

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.SKIP_VALIDATION = “skip_validation”
 static

Bypass validation of connection to remote source.

Supported values:

The default value is FALSE.

Definition at line 59 of file AlterDatasource.cs.

​
◆ TRUE

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.TRUE = “true”
 static

A boolean constant for the AlterDatasourceRequest.DatasourceUpdatesMap options.

Definition at line 64 of file AlterDatasource.cs.

​
◆ USE_HTTPS

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.USE_HTTPS = “use_https”
 static

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

Supported values:

The default value is TRUE.

Definition at line 310 of file AlterDatasource.cs.

​
◆ USE_MANAGED_CREDENTIALS

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

​
◆ USER_NAME

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.USER_NAME = “user_name”
 static

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

Definition at line 35 of file AlterDatasource.cs.

​
◆ WAIT_TIMEOUT

const string kinetica.AlterDatasourceRequest.DatasourceUpdatesMap.WAIT_TIMEOUT = “wait_timeout”
 static

Timeout in seconds for reading from this storage provider.

Definition at line 77 of file AlterDatasource.cs.

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