Class Workflow
- java.lang.Object
-
- software.amazon.awssdk.services.glue.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>
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:
- 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 BlueprintDetails
blueprintDetails()
This structure indicates the details of the blueprint that this particular workflow is created from.static Workflow.Builder
builder()
Instant
createdOn()
The date and time when the workflow was created.Map<String,String>
defaultRunProperties()
A collection of properties to be used as part of each execution of the workflow.String
description()
A description of the workflow.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
WorkflowGraph
graph()
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.boolean
hasDefaultRunProperties()
For responses, this returns true if the service returned a value for the DefaultRunProperties property.int
hashCode()
Instant
lastModifiedOn()
The date and time when the workflow was last modified.WorkflowRun
lastRun()
The information about the last execution of the workflow.Integer
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.String
name()
The name of the workflow.List<SdkField<?>>
sdkFields()
static Class<? extends Workflow.Builder>
serializableBuilderClass()
Workflow.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
name
public final String name()
The name of the workflow.
- Returns:
- The name of the workflow.
-
description
public final String 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
public final Map<String,String> 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
public final Instant createdOn()
The date and time when the workflow was created.
- Returns:
- The date and time when the workflow was created.
-
lastModifiedOn
public final Instant lastModifiedOn()
The date and time when the workflow was last modified.
- Returns:
- The date and time when the workflow was last modified.
-
lastRun
public final WorkflowRun lastRun()
The information about the last execution of the workflow.
- Returns:
- The information about the last execution of the workflow.
-
graph
public final WorkflowGraph 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
public final Integer 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
public final BlueprintDetails 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
public Workflow.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Workflow.Builder,Workflow>
-
builder
public static Workflow.Builder builder()
-
serializableBuilderClass
public static Class<? extends Workflow.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-