Package software.amazon.awssdk.services.glue.model

Class JDBCConnectorOptions

java.lang.Object
software.amazon.awssdk.services.glue.model.JDBCConnectorOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<JDBCConnectorOptions.Builder,JDBCConnectorOptions>
@Generated("software.amazon.awssdk:codegen") public final class JDBCConnectorOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JDBCConnectorOptions.Builder,JDBCConnectorOptions>

Additional connection options for the connector.

See Also:

  • Method Details

    • filterPredicate

      public final String filterPredicate()

      Extra condition clause to filter data from source. For example:

      BillingCity='Mountain View'

      When using a query instead of a table name, you should validate that the query works with the specified filterPredicate.

      Returns:
      Extra condition clause to filter data from source. For example:

      BillingCity='Mountain View'

      When using a query instead of a table name, you should validate that the query works with the specified filterPredicate.

    • partitionColumn

      public final String partitionColumn()

      The name of an integer column that is used for partitioning. This option works only when it's included with lowerBound, upperBound, and numPartitions. This option works the same way as in the Spark SQL JDBC reader.

      Returns:
      The name of an integer column that is used for partitioning. This option works only when it's included with lowerBound, upperBound, and numPartitions. This option works the same way as in the Spark SQL JDBC reader.

    • lowerBound

      public final Long lowerBound()

      The minimum value of partitionColumn that is used to decide partition stride.

      Returns:
      The minimum value of partitionColumn that is used to decide partition stride.

    • upperBound

      public final Long upperBound()

      The maximum value of partitionColumn that is used to decide partition stride.

      Returns:
      The maximum value of partitionColumn that is used to decide partition stride.

    • numPartitions

      public final Long numPartitions()

      The number of partitions. This value, along with lowerBound (inclusive) and upperBound (exclusive), form partition strides for generated WHERE clause expressions that are used to split the partitionColumn.

      Returns:
      The number of partitions. This value, along with lowerBound (inclusive) and upperBound (exclusive), form partition strides for generated WHERE clause expressions that are used to split the partitionColumn.

    • hasJobBookmarkKeys

      public final boolean hasJobBookmarkKeys()
      For responses, this returns true if the service returned a value for the JobBookmarkKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • jobBookmarkKeys

      public final List<String> jobBookmarkKeys()

      The name of the job bookmark keys on which to sort.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasJobBookmarkKeys() method.

      Returns:
      The name of the job bookmark keys on which to sort.

    • jobBookmarkKeysSortOrder

      public final String jobBookmarkKeysSortOrder()

      Specifies an ascending or descending sort order.

      Returns:
      Specifies an ascending or descending sort order.

    • dataTypeMapping

      public final Map<JDBCDataType,GlueRecordType> dataTypeMapping()

      Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option "dataTypeMapping":{"FLOAT":"STRING"} maps data fields of JDBC type FLOAT into the Java String type by calling the ResultSet.getString() method of the driver, and uses it to build the Glue record. The ResultSet object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDataTypeMapping() method.

      Returns:
      Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option "dataTypeMapping":{"FLOAT":"STRING"} maps data fields of JDBC type FLOAT into the Java String type by calling the ResultSet.getString() method of the driver, and uses it to build the Glue record. The ResultSet object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.

    • hasDataTypeMapping

      public final boolean hasDataTypeMapping()
      For responses, this returns true if the service returned a value for the DataTypeMapping property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • dataTypeMappingAsStrings

      public final Map<String,String> dataTypeMappingAsStrings()

      Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option "dataTypeMapping":{"FLOAT":"STRING"} maps data fields of JDBC type FLOAT into the Java String type by calling the ResultSet.getString() method of the driver, and uses it to build the Glue record. The ResultSet object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDataTypeMapping() method.

      Returns:
      Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option "dataTypeMapping":{"FLOAT":"STRING"} maps data fields of JDBC type FLOAT into the Java String type by calling the ResultSet.getString() method of the driver, and uses it to build the Glue record. The ResultSet object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.

    • toBuilder

      public JDBCConnectorOptions.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<JDBCConnectorOptions.Builder,JDBCConnectorOptions>
      Returns:
      a builder for type T

    • builder

      public static JDBCConnectorOptions.Builder builder()

    • serializableBuilderClass

      public static Class<? extends JDBCConnectorOptions.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.