Class DescribedWorkflow
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DescribedWorkflow.Builder,
DescribedWorkflow>
Describes the properties of the specified workflow
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
Specifies the unique Amazon Resource Name (ARN) for the workflow.static DescribedWorkflow.Builder
builder()
final String
Specifies the text description for the workflow.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OnExceptionSteps property.final boolean
hasSteps()
For responses, this returns true if the service returned a value for the Steps property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final List
<WorkflowStep> Specifies the steps (actions) to take if errors are encountered during execution of the workflow.static Class
<? extends DescribedWorkflow.Builder> final List
<WorkflowStep> steps()
Specifies the details for the steps that are in the specified workflow.tags()
Key-value pairs that can be used to group and search for workflows.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
A unique identifier for the workflow.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
Specifies the unique Amazon Resource Name (ARN) for the workflow.
- Returns:
- Specifies the unique Amazon Resource Name (ARN) for the workflow.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribedWorkflow.Builder,
DescribedWorkflow> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-