Class BlueprintRun
- java.lang.Object
-
- software.amazon.awssdk.services.glue.model.BlueprintRun
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<BlueprintRun.Builder,BlueprintRun>
@Generated("software.amazon.awssdk:codegen") public final class BlueprintRun extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BlueprintRun.Builder,BlueprintRun>
The details of a blueprint run.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceBlueprintRun.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringblueprintName()The name of the blueprint.static BlueprintRun.Builderbuilder()InstantcompletedOn()The date and time that the blueprint run completed.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringerrorMessage()Indicates any errors that are seen while running the blueprint.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringparameters()The blueprint parameters as a string.StringroleArn()The role ARN.StringrollbackErrorMessage()If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them.StringrunId()The run ID for this blueprint run.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends BlueprintRun.Builder>serializableBuilderClass()InstantstartedOn()The date and time that the blueprint run started.BlueprintRunStatestate()The state of the blueprint run.StringstateAsString()The state of the blueprint run.BlueprintRun.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringworkflowName()The name of a workflow that is created as a result of a successful blueprint run.-
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
-
blueprintName
public final String blueprintName()
The name of the blueprint.
- Returns:
- The name of the blueprint.
-
runId
public final String runId()
The run ID for this blueprint run.
- Returns:
- The run ID for this blueprint run.
-
workflowName
public final String workflowName()
The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
- Returns:
- The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
-
state
public final BlueprintRunState state()
The state of the blueprint run. Possible values are:
-
Running — The blueprint run is in progress.
-
Succeeded — The blueprint run completed successfully.
-
Failed — The blueprint run failed and rollback is complete.
-
Rolling Back — The blueprint run failed and rollback is in progress.
If the service returns an enum value that is not available in the current SDK version,
statewill returnBlueprintRunState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the blueprint run. Possible values are:
-
Running — The blueprint run is in progress.
-
Succeeded — The blueprint run completed successfully.
-
Failed — The blueprint run failed and rollback is complete.
-
Rolling Back — The blueprint run failed and rollback is in progress.
-
- See Also:
BlueprintRunState
-
-
stateAsString
public final String stateAsString()
The state of the blueprint run. Possible values are:
-
Running — The blueprint run is in progress.
-
Succeeded — The blueprint run completed successfully.
-
Failed — The blueprint run failed and rollback is complete.
-
Rolling Back — The blueprint run failed and rollback is in progress.
If the service returns an enum value that is not available in the current SDK version,
statewill returnBlueprintRunState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the blueprint run. Possible values are:
-
Running — The blueprint run is in progress.
-
Succeeded — The blueprint run completed successfully.
-
Failed — The blueprint run failed and rollback is complete.
-
Rolling Back — The blueprint run failed and rollback is in progress.
-
- See Also:
BlueprintRunState
-
-
startedOn
public final Instant startedOn()
The date and time that the blueprint run started.
- Returns:
- The date and time that the blueprint run started.
-
completedOn
public final Instant completedOn()
The date and time that the blueprint run completed.
- Returns:
- The date and time that the blueprint run completed.
-
errorMessage
public final String errorMessage()
Indicates any errors that are seen while running the blueprint.
- Returns:
- Indicates any errors that are seen while running the blueprint.
-
rollbackErrorMessage
public final String rollbackErrorMessage()
If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
- Returns:
- If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
-
parameters
public final String parameters()
The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the
Blueprint$ParameterSpec.- Returns:
- The blueprint parameters as a string. You will have to provide a value for each key that is required from
the parameter spec that is defined in the
Blueprint$ParameterSpec.
-
roleArn
public final String roleArn()
The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
- Returns:
- The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
-
toBuilder
public BlueprintRun.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<BlueprintRun.Builder,BlueprintRun>
-
builder
public static BlueprintRun.Builder builder()
-
serializableBuilderClass
public static Class<? extends BlueprintRun.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-