Class RuleExecution

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

Represents information about each time a rule is run as part of the pipeline execution for a pipeline configured with conditions.

See Also:

  • Method Details

    • ruleExecutionId

      public final String ruleExecutionId()

      The execution ID for the run of the rule.

      Returns:
      The execution ID for the run of the rule.

    • status

      public final RuleExecutionStatus status()

      The status of the run of the rule, such as 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 run of the rule, such as FAILED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the run of the rule, such as 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 run of the rule, such as FAILED.
      See Also:

    • summary

      public final String summary()

      A summary of the run of the rule.

      Returns:
      A summary of the run of the rule.

    • lastStatusChange

      public final Instant lastStatusChange()

      The last status change of the rule.

      Returns:
      The last status change of the rule.

    • token

      public final String token()

      The system-generated token used to identify a unique request.

      Returns:
      The system-generated token used to identify a unique request.

    • lastUpdatedBy

      public final String lastUpdatedBy()

      The ARN of the user who last changed the rule.

      Returns:
      The ARN of the user who last changed the rule.

    • externalExecutionId

      public final String externalExecutionId()

      The external ID of the run of the rule.

      Returns:
      The external ID of the run of the rule.

    • externalExecutionUrl

      public final String externalExecutionUrl()

      The URL of a resource external to Amazon Web Services that is used when running the rule (for example, an external repository URL).

      Returns:
      The URL of a resource external to Amazon Web Services that is used when running the rule (for example, an external repository URL).

    • errorDetails

      public final ErrorDetails errorDetails()
      Returns the value of the ErrorDetails property for this object.
      Returns:
      The value of the ErrorDetails property for this object.

    • toBuilder

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

    • builder

      public static RuleExecution.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RuleExecution.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.