Package software.amazon.awssdk.services.imagebuilder.model

Class WorkflowConfiguration

java.lang.Object

software.amazon.awssdk.services.imagebuilder.model.WorkflowConfiguration

All Implemented Interfaces:

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

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

Contains control settings and configurable inputs for a workflow resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkflowConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static WorkflowConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
OnWorkflowFailure	onFailure()	The action to take if the workflow fails.
String	onFailureAsString()	The action to take if the workflow fails.
String	parallelGroup()	Test workflows are defined within named runtime groups called parallel groups.
List<WorkflowParameter>	parameters()	Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
List<SdkField<?>>	sdkFields()
static Class<? extends WorkflowConfiguration.Builder>	serializableBuilderClass()
WorkflowConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workflowArn()	The Amazon Resource Name (ARN) of the workflow resource.

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

workflowArn

public final String workflowArn()

The Amazon Resource Name (ARN) of the workflow resource.

Returns:

The Amazon Resource Name (ARN) of the workflow resource.

hasParameters

public final boolean hasParameters()

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

parameters

public final List<WorkflowParameter> parameters()

Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

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

Returns:

Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

parallelGroup

public final String parallelGroup()

Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

Returns:

Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

onFailure

public final OnWorkflowFailure onFailure()

The action to take if the workflow fails.

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

Returns:

The action to take if the workflow fails.

See Also:

OnWorkflowFailure

onFailureAsString

public final String onFailureAsString()

The action to take if the workflow fails.

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

Returns:

The action to take if the workflow fails.

See Also:

OnWorkflowFailure

toBuilder

public WorkflowConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkflowConfiguration.Builder,WorkflowConfiguration>

builder

public static WorkflowConfiguration.Builder builder()

serializableBuilderClass

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