Class BlueprintRun

    • 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, state will return BlueprintRunState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

        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, state will return BlueprintRunState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

        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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)