Class DisableStageTransitionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DisableStageTransitionRequest.Builder,
DisableStageTransitionRequest>
Represents the input of a DisableStageTransition
action.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.final String
reason()
The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests.static Class
<? extends DisableStageTransitionRequest.Builder> final String
The name of the stage where you want to disable the inbound or outbound transition of artifacts.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final StageTransitionType
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).final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 returnStageTransitionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtransitionTypeAsString()
.- 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:
-
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 returnStageTransitionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtransitionTypeAsString()
.- 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:
-
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
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 interfaceToCopyableBuilder<DisableStageTransitionRequest.Builder,
DisableStageTransitionRequest> - Specified by:
toBuilder
in classCodePipelineRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-