Class Workflow
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Workflow.Builder,
Workflow>
A workflow is a collection of multiple dependent Glue jobs and crawlers that are run to complete a complex ETL task. A workflow manages the execution and monitoring of all its jobs and crawlers.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal BlueprintDetails
This structure indicates the details of the blueprint that this particular workflow is created from.static Workflow.Builder
builder()
final Instant
The date and time when the workflow was created.A collection of properties to be used as part of each execution of the workflow.final String
A description of 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 WorkflowGraph
graph()
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.final boolean
For responses, this returns true if the service returned a value for the DefaultRunProperties property.final int
hashCode()
final Instant
The date and time when the workflow was last modified.final WorkflowRun
lastRun()
The information about the last execution of the workflow.final Integer
You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs.final String
name()
The name of the workflow.static Class
<? extends Workflow.Builder> 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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the workflow.
- Returns:
- The name of the workflow.
-
description
A description of the workflow.
- Returns:
- A description of the workflow.
-
hasDefaultRunProperties
public final boolean hasDefaultRunProperties()For responses, this returns true if the service returned a value for the DefaultRunProperties 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. -
defaultRunProperties
A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
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
hasDefaultRunProperties()
method.- Returns:
- A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
-
createdOn
The date and time when the workflow was created.
- Returns:
- The date and time when the workflow was created.
-
lastModifiedOn
The date and time when the workflow was last modified.
- Returns:
- The date and time when the workflow was last modified.
-
lastRun
The information about the last execution of the workflow.
- Returns:
- The information about the last execution of the workflow.
-
graph
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
- Returns:
- The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
-
maxConcurrentRuns
You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
- Returns:
- You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
-
blueprintDetails
This structure indicates the details of the blueprint that this particular workflow is created from.
- Returns:
- This structure indicates the details of the blueprint that this particular workflow is created from.
-
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<Workflow.Builder,
Workflow> - 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
-