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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRuleExecutionDetail.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RuleExecutionDetail.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()RuleExecutionInputinput()Input details for the rule execution, such as role ARN, Region, and input artifacts.InstantlastUpdateTime()The date and time of the last change to the rule execution, in timestamp format.RuleExecutionOutputoutput()Output details for the rule execution, such as the rule execution result.StringpipelineExecutionId()The ID of the pipeline execution in the stage where the rule was run.IntegerpipelineVersion()The version number of the pipeline with the stage where the rule was run.StringruleExecutionId()The ID of the run for the rule.StringruleName()The name of the rule that was run in the stage.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends RuleExecutionDetail.Builder>serializableBuilderClass()StringstageName()The name of the stage where the rule was run.InstantstartTime()The start time of the rule execution.RuleExecutionStatusstatus()The status of the rule execution.StringstatusAsString()The status of the rule execution.RuleExecutionDetail.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringupdatedBy()The ARN of the user who changed the rule execution details.-
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
-
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, andFailed.If the service returns an enum value that is not available in the current SDK version,
statuswill returnRuleExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the rule execution. Status categories are
InProgress,Succeeded, andFailed. - See Also:
RuleExecutionStatus
-
statusAsString
public final String statusAsString()
The status of the rule execution. Status categories are
InProgress,Succeeded, andFailed.If the service returns an enum value that is not available in the current SDK version,
statuswill returnRuleExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the rule execution. Status categories are
InProgress,Succeeded, andFailed. - See Also:
RuleExecutionStatus
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RuleExecutionDetail.Builder,RuleExecutionDetail>
-
builder
public static RuleExecutionDetail.Builder builder()
-
serializableBuilderClass
public static Class<? extends RuleExecutionDetail.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
-
-