software.amazon.awssdk.services.transfer.model

Class DescribedWorkflow

java.lang.Object

software.amazon.awssdk.services.transfer.model.DescribedWorkflow

All Implemented Interfaces:

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

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

Describes the properties of the specified workflow

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribedWorkflow.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() Specifies the unique Amazon Resource Name (ARN) for the workflow.
static DescribedWorkflow.Builder	builder()
String	description() Specifies the text description for the workflow.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOnExceptionSteps() For responses, this returns true if the service returned a value for the OnExceptionSteps property.
boolean	hasSteps() For responses, this returns true if the service returned a value for the Steps property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<WorkflowStep>	onExceptionSteps() Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribedWorkflow.Builder>	serializableBuilderClass()
List<WorkflowStep>	steps() Specifies the details for the steps that are in the specified workflow.
List<Tag>	tags() Key-value pairs that can be used to group and search for workflows.
DescribedWorkflow.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workflowId() A unique identifier for the workflow.

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

arn

public final String arn()

Specifies the unique Amazon Resource Name (ARN) for the workflow.

Returns:

Specifies the unique Amazon Resource Name (ARN) for the workflow.

description

public final String description()

Specifies the text description for the workflow.

Returns:

Specifies the text description for the workflow.

hasSteps

public final boolean hasSteps()

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

steps

public final List<WorkflowStep> steps()

Specifies the details for the steps that are in the specified workflow.

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

Returns:

Specifies the details for the steps that are in the specified workflow.

hasOnExceptionSteps

public final boolean hasOnExceptionSteps()

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

onExceptionSteps

public final List<WorkflowStep> onExceptionSteps()

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

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

Returns:

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

workflowId

public final String workflowId()

A unique identifier for the workflow.

Returns:

A unique identifier for the workflow.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

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

Returns:

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

toBuilder

public DescribedWorkflow.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribedWorkflow.Builder,DescribedWorkflow>

builder

public static DescribedWorkflow.Builder builder()

serializableBuilderClass

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