software.amazon.awssdk.services.codepipeline.model

Class PipelineContext

java.lang.Object

software.amazon.awssdk.services.codepipeline.model.PipelineContext

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PipelineContext.Builder,PipelineContext>

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

Represents information about a pipeline to a job worker.

PipelineContext contains pipelineArn and pipelineExecutionId for custom action jobs. The pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PipelineContext.Builder

Method Summary

Modifier and Type	Method and Description
ActionContext	action() The context of an action to a job worker in the stage of a pipeline.
static PipelineContext.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	pipelineArn() The Amazon Resource Name (ARN) of the pipeline.
String	pipelineExecutionId() The execution ID of the pipeline.
String	pipelineName() The name of the pipeline.
List<SdkField<?>>	sdkFields()
static Class<? extends PipelineContext.Builder>	serializableBuilderClass()
StageContext	stage() The stage of the pipeline.
PipelineContext.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

pipelineName

public final String pipelineName()

The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.

Returns:

The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.

stage

public final StageContext stage()

The stage of the pipeline.

Returns:

The stage of the pipeline.

action

public final ActionContext action()

The context of an action to a job worker in the stage of a pipeline.

Returns:

The context of an action to a job worker in the stage of a pipeline.

pipelineArn

public final String pipelineArn()

The Amazon Resource Name (ARN) of the pipeline.

Returns:

The Amazon Resource Name (ARN) of the pipeline.

pipelineExecutionId

public final String pipelineExecutionId()

The execution ID of the pipeline.

Returns:

The execution ID of the pipeline.

toBuilder

public PipelineContext.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipelineContext.Builder,PipelineContext>

builder

public static PipelineContext.Builder builder()

serializableBuilderClass

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