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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceJDBCConnectorOptions.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static JDBCConnectorOptions.Builderbuilder()Map<JDBCDataType,GlueRecordType>dataTypeMapping()Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type.Map<String,String>dataTypeMappingAsStrings()Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfilterPredicate()Extra condition clause to filter data from source.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDataTypeMapping()For responses, this returns true if the service returned a value for the DataTypeMapping property.inthashCode()booleanhasJobBookmarkKeys()For responses, this returns true if the service returned a value for the JobBookmarkKeys property.List<String>jobBookmarkKeys()The name of the job bookmark keys on which to sort.StringjobBookmarkKeysSortOrder()Specifies an ascending or descending sort order.LonglowerBound()The minimum value ofpartitionColumnthat is used to decide partition stride.LongnumPartitions()The number of partitions.StringpartitionColumn()The name of an integer column that is used for partitioning.List<SdkField<?>>sdkFields()static Class<? extends JDBCConnectorOptions.Builder>serializableBuilderClass()JDBCConnectorOptions.BuildertoBuilder()StringtoString()Returns a string representation of this object.LongupperBound()The maximum value ofpartitionColumnthat is used to decide partition stride.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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, andnumPartitions. 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, andnumPartitions. This option works the same way as in the Spark SQL JDBC reader.
-
lowerBound
public final Long lowerBound()
The minimum value of
partitionColumnthat is used to decide partition stride.- Returns:
- The minimum value of
partitionColumnthat is used to decide partition stride.
-
upperBound
public final Long upperBound()
The maximum value of
partitionColumnthat is used to decide partition stride.- Returns:
- The maximum value of
partitionColumnthat is used to decide partition stride.
-
numPartitions
public final Long numPartitions()
The number of partitions. This value, along with
lowerBound(inclusive) andupperBound(exclusive), form partition strides for generatedWHEREclause expressions that are used to split thepartitionColumn.- Returns:
- The number of partitions. This value, along with
lowerBound(inclusive) andupperBound(exclusive), form partition strides for generatedWHEREclause expressions that are used to split thepartitionColumn.
-
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 theisEmpty()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 typeFLOATinto the JavaStringtype by calling theResultSet.getString()method of the driver, and uses it to build the Glue record. TheResultSetobject 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 typeFLOATinto the JavaStringtype by calling theResultSet.getString()method of the driver, and uses it to build the Glue record. TheResultSetobject 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 theisEmpty()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 typeFLOATinto the JavaStringtype by calling theResultSet.getString()method of the driver, and uses it to build the Glue record. TheResultSetobject 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 typeFLOATinto the JavaStringtype by calling theResultSet.getString()method of the driver, and uses it to build the Glue record. TheResultSetobject 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<JDBCConnectorOptions.Builder,JDBCConnectorOptions>
-
builder
public static JDBCConnectorOptions.Builder builder()
-
serializableBuilderClass
public static Class<? extends JDBCConnectorOptions.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-