PipelineExecutionSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.codepipeline.model.PipelineExecutionSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<PipelineExecutionSummary.Builder,PipelineExecutionSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class PipelineExecutionSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PipelineExecutionSummary.Builder,PipelineExecutionSummary>

Summary information about a pipeline execution.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PipelineExecutionSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PipelineExecutionSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PipelineExecutionSummary.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSourceRevisions()` For responses, this returns true if the service returned a value for the SourceRevisions property.
`Instant`	`lastUpdateTime()` The date and time of the last change to the pipeline execution, in timestamp format.
`String`	`pipelineExecutionId()` The ID of the pipeline execution.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PipelineExecutionSummary.Builder>`	`serializableBuilderClass()`
`List<SourceRevision>`	`sourceRevisions()` A list of the source artifact revisions that initiated a pipeline execution.
`Instant`	`startTime()` The date and time when the pipeline execution began, in timestamp format.
`PipelineExecutionStatus`	`status()` The status of the pipeline execution.
`String`	`statusAsString()` The status of the pipeline execution.
`StopExecutionTrigger`	`stopTrigger()` The interaction that stopped a pipeline execution.
`PipelineExecutionSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ExecutionTrigger`	`trigger()` The interaction or event that started a pipeline execution, such as automated change detection or a `StartPipelineExecution` API call.

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.
    
    Returns:
    
    The ID of the pipeline execution.
  - status
```
public final PipelineExecutionStatus status()
```
    The status of the pipeline execution.
    - InProgress: The pipeline execution is currently running.
    - Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    - Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    - Succeeded: The pipeline execution was completed successfully.
    - Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    - Failed: The pipeline execution was not completed successfully.
    If the service returns an enum value that is not available in the current SDK version, status will return PipelineExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the pipeline execution.
    
    InProgress: The pipeline execution is currently running.
    
    Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    
    Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    
    Succeeded: The pipeline execution was completed successfully.
    
    Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    
    Failed: The pipeline execution was not completed successfully.
    See Also:
    
    PipelineExecutionStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the pipeline execution.
    - InProgress: The pipeline execution is currently running.
    - Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    - Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    - Succeeded: The pipeline execution was completed successfully.
    - Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    - Failed: The pipeline execution was not completed successfully.
    If the service returns an enum value that is not available in the current SDK version, status will return PipelineExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the pipeline execution.
    
    InProgress: The pipeline execution is currently running.
    
    Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    
    Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    
    Succeeded: The pipeline execution was completed successfully.
    
    Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    
    Failed: The pipeline execution was not completed successfully.
    See Also:
    
    PipelineExecutionStatus
  - startTime
```
public final Instant startTime()
```
    The date and time when the pipeline execution began, in timestamp format.
    
    Returns:
    
    The date and time when the pipeline execution began, in timestamp format.
  - lastUpdateTime
```
public final Instant lastUpdateTime()
```
    The date and time of the last change to the pipeline execution, in timestamp format.
    
    Returns:
    
    The date and time of the last change to the pipeline execution, in timestamp format.
  - hasSourceRevisions
```
public final boolean hasSourceRevisions()
```
    For responses, this returns true if the service returned a value for the SourceRevisions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - sourceRevisions
```
public final List<SourceRevision> sourceRevisions()
```
    A list of the source artifact revisions that initiated a pipeline execution.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSourceRevisions() method.
    
    Returns:
    
    A list of the source artifact revisions that initiated a pipeline execution.
  - trigger
```
public final ExecutionTrigger trigger()
```
    The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.
    
    Returns:
    
    The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.
  - stopTrigger
```
public final StopExecutionTrigger stopTrigger()
```
    The interaction that stopped a pipeline execution.
    
    Returns:
    
    The interaction that stopped a pipeline execution.
  - toBuilder
```
public PipelineExecutionSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PipelineExecutionSummary.Builder,PipelineExecutionSummary>
  - builder
```
public static PipelineExecutionSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PipelineExecutionSummary.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class PipelineExecutionSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

pipelineExecutionId

status

statusAsString

startTime

lastUpdateTime

hasSourceRevisions

sourceRevisions

trigger

stopTrigger

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields