Package com.gpudb.protocol

Class AlterDatasinkRequest

java.lang.Object

com.gpudb.protocol.AlterDatasinkRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class AlterDatasinkRequest extends Object implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.alterDatasink.

Alters the properties of an existing data sink.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static final class

AlterDatasinkRequest.DatasinkUpdatesMap

A set of string constants for the AlterDatasinkRequest parameter datasinkUpdatesMap.
Constructor Summary

Constructors

Constructor

Description

AlterDatasinkRequest()

Constructs an AlterDatasinkRequest object with default parameters.

AlterDatasinkRequest(String name, Map\<String,String> datasinkUpdatesMap, Map\<String,String> options)

Constructs an AlterDatasinkRequest object with the specified parameters.
Method Summary

Modifier and Type

Method

Description

boolean

equals(Object obj)

Object

get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

static org.apache.avro.Schema

getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Map\<String,String>

getDatasinkUpdatesMap()

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

String

getName()

Name of the data sink to be altered.

Map\<String,String>

getOptions()

Optional parameters.

org.apache.avro.Schema

getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

int

hashCode()

void

put(int index, Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

AlterDatasinkRequest

setDatasinkUpdatesMap(Map\<String,String> datasinkUpdatesMap)

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

AlterDatasinkRequest

setName(String name)

Name of the data sink to be altered.

AlterDatasinkRequest

setOptions(Map\<String,String> options)

Optional parameters.

String

toString()

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- AlterDatasinkRequest
  
  public AlterDatasinkRequest()
  
  Constructs an AlterDatasinkRequest object with default parameters.
- AlterDatasinkRequest
  
  public AlterDatasinkRequest(String name, Map\<String,String> datasinkUpdatesMap, Map\<String,String> options)
  
  Constructs an AlterDatasinkRequest object with the specified parameters.
  Parameters:
  
  name - Name of the data sink to be altered. Must be an existing data sink.
  
  datasinkUpdatesMap - 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 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'.
  
  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\_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.
  
  S3\_USE\_VIRTUAL\_ADDRESSING: 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.
  
  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.
  
  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.
  
  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. This may be a KIFS file.
  
  JDBC\_DRIVER\_CLASS\_NAME: Name of the JDBC driver class.
  
  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)'.
  
  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:
  
  TRUE
  
  FALSE
  
  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:
  
  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.
  
  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. Supported values:
  
  FLAT: A single record is returned per message.
  
  NESTED: Records are returned as an array per message.
  
  The default value is FLAT.
  
  SKIP\_VALIDATION: Bypass validation of connection to this data sink. Supported values:
  
  TRUE
  
  FALSE
  
  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.
  
  options - Optional parameters.
Method Details
- getClassSchema
  
  public static org.apache.avro.Schema getClassSchema()
  
  This method supports the Avro framework and is not intended to be called directly by the user.
  
  Returns:
  
  The schema for the class.
- getName
  
  public String getName()
  
  Name of the data sink to be altered. Must be an existing data sink.
  
  Returns:
  
  The current value of name.
- setName
  
  public AlterDatasinkRequest setName(String name)
  
  Name of the data sink to be altered. Must be an existing data sink.
  
  Parameters:
  
  name - The new value for name.
  
  Returns:
  
  this to mimic the builder pattern.
- getDatasinkUpdatesMap
  
  public Map\<String,String> getDatasinkUpdatesMap()
  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 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'.
  
  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\_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.
  
  S3\_USE\_VIRTUAL\_ADDRESSING: 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.
  
  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.
  
  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.
  
  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. This may be a KIFS file.
  
  JDBC\_DRIVER\_CLASS\_NAME: Name of the JDBC driver class.
  
  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)'.
  
  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:
  
  TRUE
  
  FALSE
  
  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:
  
  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.
  
  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. Supported values:
  
  FLAT: A single record is returned per message.
  
  NESTED: Records are returned as an array per message.
  
  The default value is FLAT.
  
  SKIP\_VALIDATION: Bypass validation of connection to this data sink. Supported values:
  
  TRUE
  
  FALSE
  
  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.
  Returns:
  
  The current value of datasinkUpdatesMap.
- setDatasinkUpdatesMap
  
  public AlterDatasinkRequest setDatasinkUpdatesMap(Map\<String,String> datasinkUpdatesMap)
  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 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'.
  
  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\_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.
  
  S3\_USE\_VIRTUAL\_ADDRESSING: 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.
  
  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.
  
  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.
  
  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. This may be a KIFS file.
  
  JDBC\_DRIVER\_CLASS\_NAME: Name of the JDBC driver class.
  
  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)'.
  
  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:
  
  TRUE
  
  FALSE
  
  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:
  
  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.
  
  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. Supported values:
  
  FLAT: A single record is returned per message.
  
  NESTED: Records are returned as an array per message.
  
  The default value is FLAT.
  
  SKIP\_VALIDATION: Bypass validation of connection to this data sink. Supported values:
  
  TRUE
  
  FALSE
  
  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.
  Parameters:
  
  datasinkUpdatesMap - The new value for datasinkUpdatesMap.
  
  Returns:
  
  this to mimic the builder pattern.
- getOptions
  
  public Map\<String,String> getOptions()
  
  Optional parameters.
  
  Returns:
  
  The current value of options.
- setOptions
  
  public AlterDatasinkRequest setOptions(Map\<String,String> options)
  
  Optional parameters.
  
  Parameters:
  
  options - The new value for options.
  
  Returns:
  
  this to mimic the builder pattern.
- getSchema
  
  public org.apache.avro.Schema getSchema()
  
  This method supports the Avro framework and is not intended to be called directly by the user.
  
  Specified by:
  
  getSchema in interface org.apache.avro.generic.GenericContainer
  
  Returns:
  
  The schema object describing this class.
- get
  
  public Object get(int index)
  
  This method supports the Avro framework and is not intended to be called directly by the user.
  
  Specified by:
  
  get in interface org.apache.avro.generic.IndexedRecord
  
  Parameters:
  
  index - the position of the field to get
  
  Returns:
  
  value of the field with the given index.
  
  Throws:
  
  IndexOutOfBoundsException
- put
  
  public void put(int index, Object value)
  
  This method supports the Avro framework and is not intended to be called directly by the user.
  
  Specified by:
  
  put in interface org.apache.avro.generic.IndexedRecord
  
  Parameters:
  
  index - the position of the field to set
  
  value - the value to set
  
  Throws:
  
  IndexOutOfBoundsException
- equals
  
  public boolean equals(Object obj)
  
  Overrides:
  
  equals in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object

Class AlterDatasinkRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

AlterDatasinkRequest

AlterDatasinkRequest

Method Details

getClassSchema

getName

setName

getDatasinkUpdatesMap

setDatasinkUpdatesMap

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode