CreateDatasinkRequest.Options (Kinetica Java API 7.1.10.4 API)

java.lang.Object
- com.gpudb.protocol.CreateDatasinkRequest.Options

Enclosing class:

CreateDatasinkRequest
```
public static final class CreateDatasinkRequest.Options
extends Object
```
Optional parameters.
- CONNECTION_TIMEOUT: Timeout in seconds for connecting to this data sink
- WAIT_TIMEOUT: Timeout in seconds for waiting for a response from this data 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_VERIFY_SSL: Set to false for testing purposes or when necessary to bypass TLS errors (e.g. self-signed certificates). This value is true by default. Supported values:
  - TRUE
  - FALSE
  The default value is TRUE.
- S3_USE_VIRTUAL_ADDRESSING: When true (default), the requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
  Otherwise set to false to use path-style URI for requests. Supported values:
  - TRUE
  - FALSE
  The default value is TRUE.
- S3_AWS_ROLE_ARN: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
- S3_ENCRYPTION_CUSTOMER_ALGORITHM: Customer encryption algorithm used encrypting data
- S3_ENCRYPTION_CUSTOMER_KEY: Customer encryption key to encrypt or decrypt data
- S3_ENCRYPTION_TYPE: Server side encryption type
- S3_KMS_KEY_ID: KMS key
- 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:
  - TRUE
  - FALSE
  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
- JDBC_DRIVER_JAR_PATH: JDBC driver jar file location
- JDBC_DRIVER_CLASS_NAME: Name of the JDBC driver class
- KAFKA_TOPIC_NAME: Name of the Kafka topic to publish to if destination is a Kafka broker
- 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:
  - FLAT
  - NESTED
  The default value is FLAT.
- 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:
  - TRUE
  - FALSE
  The default value is FALSE.
- USE_HTTPS: Use https to connect to datasink if true, otherwise use http Supported values:
  - TRUE
  - FALSE
  The default value is TRUE.
- SKIP_VALIDATION: Bypass validation of connection to this data sink. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
The default value is an empty Map. A set of string constants for the parameter options.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AZURE_CONTAINER_NAME` Name of the Azure storage container to use as the data sink
`static String`	`AZURE_OAUTH_TOKEN` Oauth token to access given storage container
`static String`	`AZURE_SAS_TOKEN` Shared access signature token for Azure storage account to use as the data sink
`static String`	`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
`static String`	`AZURE_TENANT_ID` Active Directory tenant ID (or directory ID)
`static String`	`CONNECTION_TIMEOUT` Timeout in seconds for connecting to this data sink
`static String`	`CREDENTIAL` Name of the	`static String`	`FALSE`
`static String`	`FLAT`
`static String`	`GCS_BUCKET_NAME` Name of the Google Cloud Storage bucket to use as the data sink
`static String`	`GCS_PROJECT_ID` Name of the Google Cloud project to use as the data sink
`static String`	`GCS_SERVICE_ACCOUNT_KEYS` Google Cloud service account keys to use for authenticating the data sink
`static String`	`HDFS_DELEGATION_TOKEN` Delegation token for the given HDFS user
`static String`	`HDFS_KERBEROS_KEYTAB` Kerberos keytab file location for the given HDFS user.
`static String`	`HDFS_USE_KERBEROS` Use kerberos authentication for the given HDFS cluster Supported values: `TRUE` `FALSE` The default value is `FALSE`.
`static String`	`JDBC_DRIVER_CLASS_NAME` Name of the JDBC driver class
`static String`	`JDBC_DRIVER_JAR_PATH` JDBC driver jar file location
`static String`	`JSON_FORMAT` The desired format of JSON encoded notifications message.
`static String`	`KAFKA_TOPIC_NAME` Name of the Kafka topic to publish to if `destination` is a Kafka broker
`static String`	`MAX_BATCH_SIZE` Maximum number of records per notification message.
`static String`	`MAX_MESSAGE_SIZE` Maximum size in bytes of each notification message.
`static String`	`NESTED`
`static String`	`S3_AWS_ROLE_ARN` Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
`static String`	`S3_BUCKET_NAME` Name of the Amazon S3 bucket to use as the data sink
`static String`	`S3_ENCRYPTION_CUSTOMER_ALGORITHM` Customer encryption algorithm used encrypting data
`static String`	`S3_ENCRYPTION_CUSTOMER_KEY` Customer encryption key to encrypt or decrypt data
`static String`	`S3_ENCRYPTION_TYPE` Server side encryption type
`static String`	`S3_KMS_KEY_ID` KMS key
`static String`	`S3_REGION` Name of the Amazon S3 region where the given bucket is located
`static String`	`S3_USE_VIRTUAL_ADDRESSING` When true (default), the requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
`static String`	`S3_VERIFY_SSL` Set to false for testing purposes or when necessary to bypass TLS errors (e.g. self-signed certificates).
`static String`	`SKIP_VALIDATION` Bypass validation of connection to this data sink.
`static String`	`TRUE`
`static String`	`USE_HTTPS` Use https to connect to datasink if true, otherwise use http Supported values: `TRUE` `FALSE` The default value is `TRUE`.
`static String`	`USE_MANAGED_CREDENTIALS` When no credentials are supplied, we use anonymous access by default.
`static String`	`WAIT_TIMEOUT` Timeout in seconds for waiting for a response from this data sink

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONNECTION_TIMEOUT
```
public static final String CONNECTION_TIMEOUT
```
    Timeout in seconds for connecting to this data sink
    
    See Also:
    
    Constant Field Values
  - WAIT_TIMEOUT
```
public static final String WAIT_TIMEOUT
```
    Timeout in seconds for waiting for a response from this data sink
    
    See Also:
    
    Constant Field Values
  - CREDENTIAL
```
public static final String CREDENTIAL
```
    Name of the credential object to be used in this data sink
    
    See Also:
    
    Constant Field Values
  - S3_BUCKET_NAME
```
public static final String S3_BUCKET_NAME
```
    Name of the Amazon S3 bucket to use as the data sink
    
    See Also:
    
    Constant Field Values
  - S3_REGION
```
public static final String S3_REGION
```
    Name of the Amazon S3 region where the given bucket is located
    
    See Also:
    
    Constant Field Values
  - S3_VERIFY_SSL
```
public static final String S3_VERIFY_SSL
```
    Set to false for testing purposes or when necessary to bypass TLS errors (e.g. self-signed certificates). This value is true by default. Supported values:
    - TRUE
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    
    Constant Field Values
  - S3_USE_VIRTUAL_ADDRESSING
```
public static final String S3_USE_VIRTUAL_ADDRESSING
```
    When true (default), the requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
    Otherwise set to false to use path-style URI for requests. Supported values:
    - TRUE
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - S3_AWS_ROLE_ARN
```
public static final String S3_AWS_ROLE_ARN
```
    Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
    
    See Also:
    
    Constant Field Values
  - S3_ENCRYPTION_CUSTOMER_ALGORITHM
```
public static final String S3_ENCRYPTION_CUSTOMER_ALGORITHM
```
    Customer encryption algorithm used encrypting data
    
    See Also:
    
    Constant Field Values
  - S3_ENCRYPTION_CUSTOMER_KEY
```
public static final String S3_ENCRYPTION_CUSTOMER_KEY
```
    Customer encryption key to encrypt or decrypt data
    
    See Also:
    
    Constant Field Values
  - S3_ENCRYPTION_TYPE
```
public static final String S3_ENCRYPTION_TYPE
```
    Server side encryption type
    
    See Also:
    
    Constant Field Values
  - S3_KMS_KEY_ID
```
public static final String S3_KMS_KEY_ID
```
    KMS key
    
    See Also:
    
    Constant Field Values
  - HDFS_KERBEROS_KEYTAB
```
public static final String HDFS_KERBEROS_KEYTAB
```
    Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
    
    See Also:
    
    Constant Field Values
  - HDFS_DELEGATION_TOKEN
```
public static final String HDFS_DELEGATION_TOKEN
```
    Delegation token for the given HDFS user
    
    See Also:
    
    Constant Field Values
  - HDFS_USE_KERBEROS
```
public static final String HDFS_USE_KERBEROS
```
    Use kerberos authentication for the given HDFS cluster Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - AZURE_STORAGE_ACCOUNT_NAME
```
public static final String 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
    
    See Also:
    
    Constant Field Values
  - AZURE_CONTAINER_NAME
```
public static final String AZURE_CONTAINER_NAME
```
    Name of the Azure storage container to use as the data sink
    
    See Also:
    
    Constant Field Values
  - AZURE_TENANT_ID
```
public static final String AZURE_TENANT_ID
```
    Active Directory tenant ID (or directory ID)
    
    See Also:
    
    Constant Field Values
  - AZURE_SAS_TOKEN
```
public static final String AZURE_SAS_TOKEN
```
    Shared access signature token for Azure storage account to use as the data sink
    
    See Also:
    
    Constant Field Values
  - AZURE_OAUTH_TOKEN
```
public static final String AZURE_OAUTH_TOKEN
```
    Oauth token to access given storage container
    
    See Also:
    
    Constant Field Values
  - GCS_BUCKET_NAME
```
public static final String GCS_BUCKET_NAME
```
    Name of the Google Cloud Storage bucket to use as the data sink
    
    See Also:
    
    Constant Field Values
  - GCS_PROJECT_ID
```
public static final String GCS_PROJECT_ID
```
    Name of the Google Cloud project to use as the data sink
    
    See Also:
    
    Constant Field Values
  - GCS_SERVICE_ACCOUNT_KEYS
```
public static final String GCS_SERVICE_ACCOUNT_KEYS
```
    Google Cloud service account keys to use for authenticating the data sink
    
    See Also:
    
    Constant Field Values
  - JDBC_DRIVER_JAR_PATH
```
public static final String JDBC_DRIVER_JAR_PATH
```
    JDBC driver jar file location
    
    See Also:
    
    Constant Field Values
  - JDBC_DRIVER_CLASS_NAME
```
public static final String JDBC_DRIVER_CLASS_NAME
```
    Name of the JDBC driver class
    
    See Also:
    
    Constant Field Values
  - KAFKA_TOPIC_NAME
```
public static final String KAFKA_TOPIC_NAME
```
    Name of the Kafka topic to publish to if destination is a Kafka broker
    
    See Also:
    
    Constant Field Values
  - MAX_BATCH_SIZE
```
public static final String MAX_BATCH_SIZE
```
    Maximum number of records per notification message. The default value is '1'.
    
    See Also:
    
    Constant Field Values
  - MAX_MESSAGE_SIZE
```
public static final String MAX_MESSAGE_SIZE
```
    Maximum size in bytes of each notification message. The default value is '1000000'.
    
    See Also:
    
    Constant Field Values
  - JSON_FORMAT
```
public static final String 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:
    - FLAT
    - NESTED
    The default value is FLAT.
    See Also:
    
    Constant Field Values
  - FLAT
```
public static final String FLAT
```
    See Also:
    
    Constant Field Values
  - NESTED
```
public static final String NESTED
```
    See Also:
    
    Constant Field Values
  - USE_MANAGED_CREDENTIALS
```
public static final String 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:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - USE_HTTPS
```
public static final String USE_HTTPS
```
    Use https to connect to datasink if true, otherwise use http Supported values:
    - TRUE
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - SKIP_VALIDATION
```
public static final String SKIP_VALIDATION
```
    Bypass validation of connection to this data sink. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values

Class CreateDatasinkRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONNECTION_TIMEOUT

WAIT_TIMEOUT

CREDENTIAL

S3_BUCKET_NAME

S3_REGION

S3_VERIFY_SSL

TRUE

FALSE

S3_USE_VIRTUAL_ADDRESSING

S3_AWS_ROLE_ARN

S3_ENCRYPTION_CUSTOMER_ALGORITHM

S3_ENCRYPTION_CUSTOMER_KEY

S3_ENCRYPTION_TYPE

S3_KMS_KEY_ID

HDFS_KERBEROS_KEYTAB

HDFS_DELEGATION_TOKEN

HDFS_USE_KERBEROS

AZURE_STORAGE_ACCOUNT_NAME

AZURE_CONTAINER_NAME

AZURE_TENANT_ID

AZURE_SAS_TOKEN

AZURE_OAUTH_TOKEN

GCS_BUCKET_NAME

GCS_PROJECT_ID

GCS_SERVICE_ACCOUNT_KEYS

JDBC_DRIVER_JAR_PATH

JDBC_DRIVER_CLASS_NAME

KAFKA_TOPIC_NAME

MAX_BATCH_SIZE

MAX_MESSAGE_SIZE

JSON_FORMAT

FLAT

NESTED

USE_MANAGED_CREDENTIALS

USE_HTTPS

SKIP_VALIDATION