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

Class WorkflowSummary

java.lang.Object

software.amazon.awssdk.services.imagebuilder.model.WorkflowSummary

All Implemented Interfaces:

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

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

Contains metadata about the workflow resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkflowSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the workflow resource.
static WorkflowSummary.Builder	builder()
String	changeDescription()	The change description for the current version of the workflow resource.
String	dateCreated()	The original creation date of the workflow resource.
String	description()	Describes the workflow.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	The name of the workflow.
String	owner()	The owner of the workflow resource.
List<SdkField<?>>	sdkFields()
static Class<? extends WorkflowSummary.Builder>	serializableBuilderClass()
WorkflowState	state()	Describes the current state of the workflow resource.
Map<String,String>	tags()	Contains a list of tags that are defined for the workflow.
WorkflowSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
WorkflowType	type()	The image creation stage that this workflow applies to.
String	typeAsString()	The image creation stage that this workflow applies to.
String	version()	The version of 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()

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.

Returns:

The name of the workflow.

version

public final String version()

The version of the workflow.

Returns:

The version of the workflow.

description

public final String description()

Describes the workflow.

Returns:

Describes the workflow.

changeDescription

public final String changeDescription()

The change description for the current version of the workflow resource.

Returns:

The change description for the current version of the workflow resource.

type

public final WorkflowType type()

The image creation stage that this workflow applies to. Image Builder currently supports build and test stage 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:

The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows.

See Also:

WorkflowType

typeAsString

public final String typeAsString()

The image creation stage that this workflow applies to. Image Builder currently supports build and test stage 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:

The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows.

See Also:

WorkflowType

owner

public final String owner()

The owner of the workflow resource.

Returns:

The owner of the workflow resource.

state

public final WorkflowState state()

Describes the current state of the workflow resource.

Returns:

Describes the current state of the workflow resource.

dateCreated

public final String dateCreated()

The original creation date of the workflow resource.

Returns:

The original creation date of 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()

Contains a list of tags that are defined for 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 hasTags() method.

Returns:

Contains a list of tags that are defined for the workflow.

toBuilder

public WorkflowSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkflowSummary.Builder,WorkflowSummary>

builder

public static WorkflowSummary.Builder builder()

serializableBuilderClass

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