java.lang.Object
- software.amazon.awssdk.services.imagebuilder.model.Workflow

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Workflow.Builder,Workflow>
```
@Generated("software.amazon.awssdk:codegen")
public final class Workflow
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Workflow.Builder,Workflow>
```
Defines a process that Image Builder uses to build and test images during the image creation process.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Workflow.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the workflow resource.
`static Workflow.Builder`	`builder()`
`String`	`changeDescription()`	Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
`String`	`data()`	Contains the YAML document content for the workflow.
`String`	`dateCreated()`	The timestamp when Image Builder created the workflow resource.
`String`	`description()`	The description of the workflow.
`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.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`kmsKeyId()`	The KMS key identifier used to encrypt the workflow resource.
`String`	`name()`	The name of the workflow resource.
`String`	`owner()`	The owner of the workflow resource.
`List<WorkflowParameterDetail>`	`parameters()`	An array of input parameters that that the image workflow uses to control actions or configure settings.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Workflow.Builder>`	`serializableBuilderClass()`
`WorkflowState`	`state()`	Describes the current status of the workflow and the reason for that status.
`Map<String,String>`	`tags()`	The tags that apply to the workflow resource
`Workflow.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`WorkflowType`	`type()`	Specifies the image creation stage that the workflow applies to.
`String`	`typeAsString()`	Specifies the image creation stage that the workflow applies to.
`String`	`version()`	The workflow resource version.

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()
```
    The Amazon Resource Name (ARN) of the workflow resource.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the workflow resource.
  - name
```
public final String name()
```
    The name of the workflow resource.
    
    Returns:
    
    The name of the workflow resource.
  - version
```
public final String version()
```
    The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.
    
    Returns:
    
    The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.
  - description
```
public final String description()
```
    The description of the workflow.
    
    Returns:
    
    The description of the workflow.
  - changeDescription
```
public final String changeDescription()
```
    Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
    
    Returns:
    
    Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
  - type
```
public final WorkflowType type()
```
    Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.
    
    If the service returns an enum value that is not available in the current SDK version, type will return WorkflowType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.
    
    See Also:
    
    WorkflowType
  - typeAsString
```
public final String typeAsString()
```
    Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.
    
    If the service returns an enum value that is not available in the current SDK version, type will return WorkflowType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.
    
    See Also:
    
    WorkflowType
  - state
```
public final WorkflowState state()
```
    Describes the current status of the workflow and the reason for that status.
    
    Returns:
    
    Describes the current status of the workflow and the reason for that status.
  - owner
```
public final String owner()
```
    The owner of the workflow resource.
    
    Returns:
    
    The owner of the workflow resource.
  - data
```
public final String data()
```
    Contains the YAML document content for the workflow.
    
    Returns:
    
    Contains the YAML document content for the workflow.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The KMS key identifier used to encrypt the workflow resource.
    
    Returns:
    
    The KMS key identifier used to encrypt the workflow resource.
  - dateCreated
```
public final String dateCreated()
```
    The timestamp when Image Builder created the workflow resource.
    
    Returns:
    
    The timestamp when Image Builder created the workflow resource.
  - 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 Map<String,String> tags()
```
    The tags that apply to 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 hasTags() method.
    
    Returns:
    
    The tags that apply to 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<WorkflowParameterDetail> parameters()
```
    An array of input parameters that that the image workflow uses to control actions or configure settings.
    
    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:
    
    An array of input parameters that that the image workflow uses to control actions or configure settings.
  - toBuilder
```
public Workflow.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Workflow.Builder,Workflow>
  - builder
```
public static Workflow.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Workflow.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

Class Workflow

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

name

version

description

changeDescription

type

typeAsString

state

owner

data

kmsKeyId

dateCreated

hasTags

tags

hasParameters

parameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields