Class Task
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Task.Builder,
Task>
A class for modeling different type of tasks. Task implementation varies based on the TaskType
.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic Task.Builder
builder()
final ConnectorOperator
The operation to be performed on the provided source fields.final String
A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SourceFields property.final boolean
For responses, this returns true if the service returned a value for the TaskProperties property.static Class
<? extends Task.Builder> The source fields to which a particular task is applied.final Map
<OperatorPropertiesKeys, String> A map used to store task-related information.A map used to store task-related information.final TaskType
taskType()
Specifies the particular task implementation that Amazon AppFlow performs.final String
Specifies the particular task implementation that Amazon AppFlow performs.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 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. -
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.
-
connectorOperator
The operation to be performed on the provided source fields.
- Returns:
- The operation to be performed on the provided source fields.
-
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.
-
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 returnTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskTypeAsString()
.- Returns:
- Specifies the particular task implementation that Amazon AppFlow performs.
- See Also:
-
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 returnTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskTypeAsString()
.- Returns:
- Specifies the particular task implementation that Amazon AppFlow performs.
- See Also:
-
taskProperties
A map used to store task-related information. The execution 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 execution 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 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. -
taskPropertiesAsStrings
A map used to store task-related information. The execution 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 execution service looks for particular information
based on the
TaskType
.
-
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 interfaceToCopyableBuilder<Task.Builder,
Task> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-