Class DataTransferApi

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

The API of the connector application that Amazon AppFlow uses to transfer your data.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the connector application API.

      Returns:
      The name of the connector application API.

    • type

      public final DataTransferApiType type()

      You can specify one of the following types:

      AUTOMATIC

      The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.

      SYNC

      A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.

      ASYNC

      An asynchronous API. This type of API optimizes a flow for large datasets.

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

      Returns:
      You can specify one of the following types:

      AUTOMATIC

      The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.

      SYNC

      A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.

      ASYNC

      An asynchronous API. This type of API optimizes a flow for large datasets.

      See Also:

    • typeAsString

      public final String typeAsString()

      You can specify one of the following types:

      AUTOMATIC

      The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.

      SYNC

      A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.

      ASYNC

      An asynchronous API. This type of API optimizes a flow for large datasets.

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

      Returns:
      You can specify one of the following types:

      AUTOMATIC

      The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.

      SYNC

      A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.

      ASYNC

      An asynchronous API. This type of API optimizes a flow for large datasets.

      See Also:

    • toBuilder

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

    • builder

      public static DataTransferApi.Builder builder()

    • serializableBuilderClass

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