Class BlueprintRun
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BlueprintRun.Builder,
BlueprintRun>
The details of a blueprint run.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of the blueprint.static BlueprintRun.Builder
builder()
final Instant
The date and time that the blueprint run completed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Indicates any errors that are seen while running the blueprint.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The blueprint parameters as a string.final String
roleArn()
The role ARN.final String
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.final String
runId()
The run ID for this blueprint run.static Class
<? extends BlueprintRun.Builder> final Instant
The date and time that the blueprint run started.final BlueprintRunState
state()
The state of the blueprint run.final String
The state of the blueprint run.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
The name of a workflow that is created as a result of a successful blueprint run.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
blueprintName
The name of the blueprint.
- Returns:
- The name of the blueprint.
-
runId
The run ID for this blueprint run.
- Returns:
- The run ID for this blueprint run.
-
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
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,
state
will 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:
-
-
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,
state
will 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:
-
-
startedOn
The date and time that the blueprint run started.
- Returns:
- The date and time that the blueprint run started.
-
completedOn
The date and time that the blueprint run completed.
- Returns:
- The date and time that the blueprint run completed.
-
errorMessage
Indicates any errors that are seen while running the blueprint.
- Returns:
- Indicates any errors that are seen while running the blueprint.
-
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
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
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
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<BlueprintRun.Builder,
BlueprintRun> - 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
-