Class RuleExecutionDetail

java.lang.Object
software.amazon.awssdk.services.codepipeline.model.RuleExecutionDetail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RuleExecutionDetail.Builder,RuleExecutionDetail>
@Generated("software.amazon.awssdk:codegen") public final class RuleExecutionDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RuleExecutionDetail.Builder,RuleExecutionDetail>

The details of the runs for a rule and the results produced on an artifact as it passes through stages in the pipeline.

See Also:

  • Method Details

    • pipelineExecutionId

      public final String pipelineExecutionId()

      The ID of the pipeline execution in the stage where the rule was run. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the stage.

      Returns:
      The ID of the pipeline execution in the stage where the rule was run. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the stage.

    • ruleExecutionId

      public final String ruleExecutionId()

      The ID of the run for the rule.

      Returns:
      The ID of the run for the rule.

    • pipelineVersion

      public final Integer pipelineVersion()

      The version number of the pipeline with the stage where the rule was run.

      Returns:
      The version number of the pipeline with the stage where the rule was run.

    • stageName

      public final String stageName()

      The name of the stage where the rule was run.

      Returns:
      The name of the stage where the rule was run.

    • ruleName

      public final String ruleName()

      The name of the rule that was run in the stage.

      Returns:
      The name of the rule that was run in the stage.

    • startTime

      public final Instant startTime()

      The start time of the rule execution.

      Returns:
      The start time of the rule execution.

    • lastUpdateTime

      public final Instant lastUpdateTime()

      The date and time of the last change to the rule execution, in timestamp format.

      Returns:
      The date and time of the last change to the rule execution, in timestamp format.

    • updatedBy

      public final String updatedBy()

      The ARN of the user who changed the rule execution details.

      Returns:
      The ARN of the user who changed the rule execution details.

    • status

      public final RuleExecutionStatus status()

      The status of the rule execution. Status categories are InProgress, Succeeded, and Failed.

      If the service returns an enum value that is not available in the current SDK version, status will return RuleExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the rule execution. Status categories are InProgress, Succeeded, and Failed.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the rule execution. Status categories are InProgress, Succeeded, and Failed.

      If the service returns an enum value that is not available in the current SDK version, status will return RuleExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the rule execution. Status categories are InProgress, Succeeded, and Failed.
      See Also:

    • input

      public final RuleExecutionInput input()

      Input details for the rule execution, such as role ARN, Region, and input artifacts.

      Returns:
      Input details for the rule execution, such as role ARN, Region, and input artifacts.

    • output

      public final RuleExecutionOutput output()

      Output details for the rule execution, such as the rule execution result.

      Returns:
      Output details for the rule execution, such as the rule execution result.

    • toBuilder

      public RuleExecutionDetail.Builder 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 interface ToCopyableBuilder<RuleExecutionDetail.Builder,RuleExecutionDetail>
      Returns:
      a builder for type T

    • builder

      public static RuleExecutionDetail.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RuleExecutionDetail.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.