Class JdbcTarget
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<JdbcTarget.Builder,JdbcTarget>
Specifies a JDBC data store to crawl.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic JdbcTarget.Builderbuilder()final StringThe name of the connection to use to connect to the JDBC target.final List<JdbcMetadataEntry>Specify a value ofRAWTYPESorCOMMENTSto enable additional metadata in table responses.Specify a value ofRAWTYPESorCOMMENTSto enable additional metadata in table responses.final booleanfinal booleanequalsBySdkFields(Object obj) A list of glob patterns used to exclude from the crawl.final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the EnableAdditionalMetadata property.final booleanFor responses, this returns true if the service returned a value for the Exclusions property.final inthashCode()final Stringpath()The path of the JDBC target.static Class<? extends JdbcTarget.Builder>final StringtoString()Returns a string representation of this object.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
connectionName
The name of the connection to use to connect to the JDBC target.
- Returns:
- The name of the connection to use to connect to the JDBC target.
-
path
The path of the JDBC target.
- Returns:
- The path of the JDBC target.
-
hasExclusions
public final boolean hasExclusions()For responses, this returns true if the service returned a value for the Exclusions 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. -
exclusions
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
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
hasExclusions()method.- Returns:
- A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
-
enableAdditionalMetadata
Specify a value of
RAWTYPESorCOMMENTSto enable additional metadata in table responses.RAWTYPESprovides the native-level datatype.COMMENTSprovides comments associated with a column or table in the database.If you do not need additional metadata, keep the field empty.
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
hasEnableAdditionalMetadata()method.- Returns:
- Specify a value of
RAWTYPESorCOMMENTSto enable additional metadata in table responses.RAWTYPESprovides the native-level datatype.COMMENTSprovides comments associated with a column or table in the database.If you do not need additional metadata, keep the field empty.
-
hasEnableAdditionalMetadata
public final boolean hasEnableAdditionalMetadata()For responses, this returns true if the service returned a value for the EnableAdditionalMetadata 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. -
enableAdditionalMetadataAsStrings
Specify a value of
RAWTYPESorCOMMENTSto enable additional metadata in table responses.RAWTYPESprovides the native-level datatype.COMMENTSprovides comments associated with a column or table in the database.If you do not need additional metadata, keep the field empty.
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
hasEnableAdditionalMetadata()method.- Returns:
- Specify a value of
RAWTYPESorCOMMENTSto enable additional metadata in table responses.RAWTYPESprovides the native-level datatype.COMMENTSprovides comments associated with a column or table in the database.If you do not need additional metadata, keep the field empty.
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<JdbcTarget.Builder,JdbcTarget>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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. -
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-