Class Task

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

A class for modeling different type of tasks. Task implementation varies based on the TaskType.

See Also:

  • Method Details

    • connectorOperator

      public final ConnectorOperator connectorOperator()

      The operation to be performed on the provided source fields.

      Returns:
      The operation to be performed on the provided source fields.

    • destinationField

      public final String destinationField()

      A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.

      Returns:
      A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.

    • hasSourceFields

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

    • sourceFields

      public final List<String> sourceFields()

      The source fields to which a particular task is applied.

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

      Returns:
      The source fields to which a particular task is applied.

    • taskProperties

      public final Map<OperatorPropertiesKeys,String> taskProperties()

      A map used to store task-related information. The service looks for particular information based on the TaskType.

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

      Returns:
      A map used to store task-related information. The service looks for particular information based on the TaskType.

    • hasTaskProperties

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

    • taskPropertiesAsStrings

      public final Map<String,String> taskPropertiesAsStrings()

      A map used to store task-related information. The service looks for particular information based on the TaskType.

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

      Returns:
      A map used to store task-related information. The service looks for particular information based on the TaskType.

    • taskType

      public final TaskType taskType()

      Specifies the particular task implementation that Amazon AppFlow performs.

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

      Returns:
      Specifies the particular task implementation that Amazon AppFlow performs.
      See Also:

    • taskTypeAsString

      public final String taskTypeAsString()

      Specifies the particular task implementation that Amazon AppFlow performs.

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

      Returns:
      Specifies the particular task implementation that Amazon AppFlow performs.
      See Also:

    • toBuilder

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

    • builder

      public static Task.Builder builder()

    • serializableBuilderClass

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