Class DatabaseSourceDescription

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

The top level object for database source description.

Amazon Data Firehose is in preview release and is subject to change.

See Also:

  • Method Details

    • type

      public final DatabaseType type()

      The type of database engine. This can be one of the following values.

      • MySQL

      • PostgreSQL

      Amazon Data Firehose is in preview release and is subject to change.

      If the service returns an enum value that is not available in the current SDK version, type will return DatabaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of database engine. This can be one of the following values.

      • MySQL

      • PostgreSQL

      Amazon Data Firehose is in preview release and is subject to change.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of database engine. This can be one of the following values.

      • MySQL

      • PostgreSQL

      Amazon Data Firehose is in preview release and is subject to change.

      If the service returns an enum value that is not available in the current SDK version, type will return DatabaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of database engine. This can be one of the following values.

      • MySQL

      • PostgreSQL

      Amazon Data Firehose is in preview release and is subject to change.

      See Also:

    • endpoint

      public final String endpoint()

      The endpoint of the database server.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The endpoint of the database server.

      Amazon Data Firehose is in preview release and is subject to change.

    • port

      public final Integer port()

      The port of the database. This can be one of the following values.

      • 3306 for MySQL database type

      • 5432 for PostgreSQL database type

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The port of the database. This can be one of the following values.

      • 3306 for MySQL database type

      • 5432 for PostgreSQL database type

      Amazon Data Firehose is in preview release and is subject to change.

    • sslMode

      public final SSLMode sslMode()

      The mode to enable or disable SSL when Firehose connects to the database endpoint.

      Amazon Data Firehose is in preview release and is subject to change.

      If the service returns an enum value that is not available in the current SDK version, sslMode will return SSLMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().

      Returns:
      The mode to enable or disable SSL when Firehose connects to the database endpoint.

      Amazon Data Firehose is in preview release and is subject to change.

      See Also:

    • sslModeAsString

      public final String sslModeAsString()

      The mode to enable or disable SSL when Firehose connects to the database endpoint.

      Amazon Data Firehose is in preview release and is subject to change.

      If the service returns an enum value that is not available in the current SDK version, sslMode will return SSLMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().

      Returns:
      The mode to enable or disable SSL when Firehose connects to the database endpoint.

      Amazon Data Firehose is in preview release and is subject to change.

      See Also:

    • databases

      public final DatabaseList databases()

      The list of database patterns in source database endpoint for Firehose to read from.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The list of database patterns in source database endpoint for Firehose to read from.

      Amazon Data Firehose is in preview release and is subject to change.

    • tables

      public final DatabaseTableList tables()

      The list of table patterns in source database endpoint for Firehose to read from.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The list of table patterns in source database endpoint for Firehose to read from.

      Amazon Data Firehose is in preview release and is subject to change.

    • columns

      public final DatabaseColumnList columns()

      The list of column patterns in source database endpoint for Firehose to read from.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The list of column patterns in source database endpoint for Firehose to read from.

      Amazon Data Firehose is in preview release and is subject to change.

    • hasSurrogateKeys

      public final boolean hasSurrogateKeys()
      For responses, this returns true if the service returned a value for the SurrogateKeys 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.

    • surrogateKeys

      public final List<String> surrogateKeys()

      The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.

      Amazon Data Firehose is in preview release and is subject to change.

      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 hasSurrogateKeys() method.

      Returns:
      The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.

      Amazon Data Firehose is in preview release and is subject to change.

    • snapshotWatermarkTable

      public final String snapshotWatermarkTable()

      The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.

      Amazon Data Firehose is in preview release and is subject to change.

    • hasSnapshotInfo

      public final boolean hasSnapshotInfo()
      For responses, this returns true if the service returned a value for the SnapshotInfo 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.

    • snapshotInfo

      public final List<DatabaseSnapshotInfo> snapshotInfo()

      The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.

      Amazon Data Firehose is in preview release and is subject to change.

      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 hasSnapshotInfo() method.

      Returns:
      The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.

      Amazon Data Firehose is in preview release and is subject to change.

    • databaseSourceAuthenticationConfiguration

      public final DatabaseSourceAuthenticationConfiguration databaseSourceAuthenticationConfiguration()

      The structure to configure the authentication methods for Firehose to connect to source database endpoint.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The structure to configure the authentication methods for Firehose to connect to source database endpoint.

      Amazon Data Firehose is in preview release and is subject to change.

    • databaseSourceVPCConfiguration

      public final DatabaseSourceVPCConfiguration databaseSourceVPCConfiguration()

      The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.

      Amazon Data Firehose is in preview release and is subject to change.

    • toBuilder

      public DatabaseSourceDescription.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<DatabaseSourceDescription.Builder,DatabaseSourceDescription>
      Returns:
      a builder for type T

    • builder

      public static DatabaseSourceDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DatabaseSourceDescription.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.