Package software.amazon.awssdk.services.codepipeline.model

Class DisableStageTransitionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest

software.amazon.awssdk.services.codepipeline.model.DisableStageTransitionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DisableStageTransitionRequest.Builder,DisableStageTransitionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DisableStageTransitionRequest
extends CodePipelineRequest
implements ToCopyableBuilder<DisableStageTransitionRequest.Builder,DisableStageTransitionRequest>

Represents the input of a DisableStageTransition action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DisableStageTransitionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DisableStageTransitionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	pipelineName()	The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
String	reason()	The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DisableStageTransitionRequest.Builder>	serializableBuilderClass()
String	stageName()	The name of the stage where you want to disable the inbound or outbound transition of artifacts.
DisableStageTransitionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
StageTransitionType	transitionType()	Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).
String	transitionTypeAsString()	Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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 in which you want to disable the flow of artifacts from one stage to another.

Returns:

The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.

stageName

public final String stageName()

The name of the stage where you want to disable the inbound or outbound transition of artifacts.

Returns:

The name of the stage where you want to disable the inbound or outbound transition of artifacts.

transitionType

public final StageTransitionType transitionType()

Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

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

Returns:

Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

See Also:

StageTransitionType

transitionTypeAsString

public final String transitionTypeAsString()

Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

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

Returns:

Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

See Also:

StageTransitionType

reason

public final String reason()

The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.

Returns:

The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.

toBuilder

public DisableStageTransitionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DisableStageTransitionRequest.Builder,DisableStageTransitionRequest>

Specified by:

toBuilder in class CodePipelineRequest

builder

public static DisableStageTransitionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo