software.amazon.awssdk.services.transfer.model

Class WorkflowDetails

java.lang.Object

software.amazon.awssdk.services.transfer.model.WorkflowDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkflowDetails.Builder,WorkflowDetails>

@Generated(value="software.amazon.awssdk:codegen")
public final class WorkflowDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowDetails.Builder,WorkflowDetails>

Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkflowDetails.Builder

Method Summary

Modifier and Type	Method and Description
static WorkflowDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOnPartialUpload() For responses, this returns true if the service returned a value for the OnPartialUpload property.
boolean	hasOnUpload() For responses, this returns true if the service returned a value for the OnUpload property.
List<WorkflowDetail>	onPartialUpload() A trigger that starts a workflow if a file is only partially uploaded.
List<WorkflowDetail>	onUpload() A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.
List<SdkField<?>>	sdkFields()
static Class<? extends WorkflowDetails.Builder>	serializableBuilderClass()
WorkflowDetails.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasOnUpload

public final boolean hasOnUpload()

For responses, this returns true if the service returned a value for the OnUpload 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.

onUpload

public final List<WorkflowDetail> onUpload()

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

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

Returns:

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

hasOnPartialUpload

public final boolean hasOnPartialUpload()

For responses, this returns true if the service returned a value for the OnPartialUpload 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.

onPartialUpload

public final List<WorkflowDetail> onPartialUpload()

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

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

Returns:

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

toBuilder

public WorkflowDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkflowDetails.Builder,WorkflowDetails>

builder

public static WorkflowDetails.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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