1 /** 2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 * SPDX-License-Identifier: Apache-2.0. 4 */ 5 6 #pragma once 7 #include <aws/codepipeline/CodePipeline_EXPORTS.h> 8 #include <aws/codepipeline/CodePipelineRequest.h> 9 #include <aws/core/utils/memory/stl/AWSString.h> 10 #include <aws/codepipeline/model/StageTransitionType.h> 11 #include <utility> 12 13 namespace Aws 14 { 15 namespace CodePipeline 16 { 17 namespace Model 18 { 19 20 /** 21 * <p>Represents the input of a <code>DisableStageTransition</code> 22 * action.</p><p><h3>See Also:</h3> <a 23 * href="http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/DisableStageTransitionInput">AWS 24 * API Reference</a></p> 25 */ 26 class AWS_CODEPIPELINE_API DisableStageTransitionRequest : public CodePipelineRequest 27 { 28 public: 29 DisableStageTransitionRequest(); 30 31 // Service request name is the Operation name which will send this request out, 32 // each operation should has unique request name, so that we can get operation's name from this request. 33 // Note: this is not true for response, multiple operations may have the same response name, 34 // so we can not get operation's name from response. GetServiceRequestName()35 inline virtual const char* GetServiceRequestName() const override { return "DisableStageTransition"; } 36 37 Aws::String SerializePayload() const override; 38 39 Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; 40 41 42 /** 43 * <p>The name of the pipeline in which you want to disable the flow of artifacts 44 * from one stage to another.</p> 45 */ GetPipelineName()46 inline const Aws::String& GetPipelineName() const{ return m_pipelineName; } 47 48 /** 49 * <p>The name of the pipeline in which you want to disable the flow of artifacts 50 * from one stage to another.</p> 51 */ PipelineNameHasBeenSet()52 inline bool PipelineNameHasBeenSet() const { return m_pipelineNameHasBeenSet; } 53 54 /** 55 * <p>The name of the pipeline in which you want to disable the flow of artifacts 56 * from one stage to another.</p> 57 */ SetPipelineName(const Aws::String & value)58 inline void SetPipelineName(const Aws::String& value) { m_pipelineNameHasBeenSet = true; m_pipelineName = value; } 59 60 /** 61 * <p>The name of the pipeline in which you want to disable the flow of artifacts 62 * from one stage to another.</p> 63 */ SetPipelineName(Aws::String && value)64 inline void SetPipelineName(Aws::String&& value) { m_pipelineNameHasBeenSet = true; m_pipelineName = std::move(value); } 65 66 /** 67 * <p>The name of the pipeline in which you want to disable the flow of artifacts 68 * from one stage to another.</p> 69 */ SetPipelineName(const char * value)70 inline void SetPipelineName(const char* value) { m_pipelineNameHasBeenSet = true; m_pipelineName.assign(value); } 71 72 /** 73 * <p>The name of the pipeline in which you want to disable the flow of artifacts 74 * from one stage to another.</p> 75 */ WithPipelineName(const Aws::String & value)76 inline DisableStageTransitionRequest& WithPipelineName(const Aws::String& value) { SetPipelineName(value); return *this;} 77 78 /** 79 * <p>The name of the pipeline in which you want to disable the flow of artifacts 80 * from one stage to another.</p> 81 */ WithPipelineName(Aws::String && value)82 inline DisableStageTransitionRequest& WithPipelineName(Aws::String&& value) { SetPipelineName(std::move(value)); return *this;} 83 84 /** 85 * <p>The name of the pipeline in which you want to disable the flow of artifacts 86 * from one stage to another.</p> 87 */ WithPipelineName(const char * value)88 inline DisableStageTransitionRequest& WithPipelineName(const char* value) { SetPipelineName(value); return *this;} 89 90 91 /** 92 * <p>The name of the stage where you want to disable the inbound or outbound 93 * transition of artifacts.</p> 94 */ GetStageName()95 inline const Aws::String& GetStageName() const{ return m_stageName; } 96 97 /** 98 * <p>The name of the stage where you want to disable the inbound or outbound 99 * transition of artifacts.</p> 100 */ StageNameHasBeenSet()101 inline bool StageNameHasBeenSet() const { return m_stageNameHasBeenSet; } 102 103 /** 104 * <p>The name of the stage where you want to disable the inbound or outbound 105 * transition of artifacts.</p> 106 */ SetStageName(const Aws::String & value)107 inline void SetStageName(const Aws::String& value) { m_stageNameHasBeenSet = true; m_stageName = value; } 108 109 /** 110 * <p>The name of the stage where you want to disable the inbound or outbound 111 * transition of artifacts.</p> 112 */ SetStageName(Aws::String && value)113 inline void SetStageName(Aws::String&& value) { m_stageNameHasBeenSet = true; m_stageName = std::move(value); } 114 115 /** 116 * <p>The name of the stage where you want to disable the inbound or outbound 117 * transition of artifacts.</p> 118 */ SetStageName(const char * value)119 inline void SetStageName(const char* value) { m_stageNameHasBeenSet = true; m_stageName.assign(value); } 120 121 /** 122 * <p>The name of the stage where you want to disable the inbound or outbound 123 * transition of artifacts.</p> 124 */ WithStageName(const Aws::String & value)125 inline DisableStageTransitionRequest& WithStageName(const Aws::String& value) { SetStageName(value); return *this;} 126 127 /** 128 * <p>The name of the stage where you want to disable the inbound or outbound 129 * transition of artifacts.</p> 130 */ WithStageName(Aws::String && value)131 inline DisableStageTransitionRequest& WithStageName(Aws::String&& value) { SetStageName(std::move(value)); return *this;} 132 133 /** 134 * <p>The name of the stage where you want to disable the inbound or outbound 135 * transition of artifacts.</p> 136 */ WithStageName(const char * value)137 inline DisableStageTransitionRequest& WithStageName(const char* value) { SetStageName(value); return *this;} 138 139 140 /** 141 * <p>Specifies whether artifacts are prevented from transitioning into the stage 142 * and being processed by the actions in that stage (inbound), or prevented from 143 * transitioning from the stage after they have been processed by the actions in 144 * that stage (outbound).</p> 145 */ GetTransitionType()146 inline const StageTransitionType& GetTransitionType() const{ return m_transitionType; } 147 148 /** 149 * <p>Specifies whether artifacts are prevented from transitioning into the stage 150 * and being processed by the actions in that stage (inbound), or prevented from 151 * transitioning from the stage after they have been processed by the actions in 152 * that stage (outbound).</p> 153 */ TransitionTypeHasBeenSet()154 inline bool TransitionTypeHasBeenSet() const { return m_transitionTypeHasBeenSet; } 155 156 /** 157 * <p>Specifies whether artifacts are prevented from transitioning into the stage 158 * and being processed by the actions in that stage (inbound), or prevented from 159 * transitioning from the stage after they have been processed by the actions in 160 * that stage (outbound).</p> 161 */ SetTransitionType(const StageTransitionType & value)162 inline void SetTransitionType(const StageTransitionType& value) { m_transitionTypeHasBeenSet = true; m_transitionType = value; } 163 164 /** 165 * <p>Specifies whether artifacts are prevented from transitioning into the stage 166 * and being processed by the actions in that stage (inbound), or prevented from 167 * transitioning from the stage after they have been processed by the actions in 168 * that stage (outbound).</p> 169 */ SetTransitionType(StageTransitionType && value)170 inline void SetTransitionType(StageTransitionType&& value) { m_transitionTypeHasBeenSet = true; m_transitionType = std::move(value); } 171 172 /** 173 * <p>Specifies whether artifacts are prevented from transitioning into the stage 174 * and being processed by the actions in that stage (inbound), or prevented from 175 * transitioning from the stage after they have been processed by the actions in 176 * that stage (outbound).</p> 177 */ WithTransitionType(const StageTransitionType & value)178 inline DisableStageTransitionRequest& WithTransitionType(const StageTransitionType& value) { SetTransitionType(value); return *this;} 179 180 /** 181 * <p>Specifies whether artifacts are prevented from transitioning into the stage 182 * and being processed by the actions in that stage (inbound), or prevented from 183 * transitioning from the stage after they have been processed by the actions in 184 * that stage (outbound).</p> 185 */ WithTransitionType(StageTransitionType && value)186 inline DisableStageTransitionRequest& WithTransitionType(StageTransitionType&& value) { SetTransitionType(std::move(value)); return *this;} 187 188 189 /** 190 * <p>The reason given to the user that a stage is disabled, such as waiting for 191 * manual approval or manual tests. This message is displayed in the pipeline 192 * console UI.</p> 193 */ GetReason()194 inline const Aws::String& GetReason() const{ return m_reason; } 195 196 /** 197 * <p>The reason given to the user that a stage is disabled, such as waiting for 198 * manual approval or manual tests. This message is displayed in the pipeline 199 * console UI.</p> 200 */ ReasonHasBeenSet()201 inline bool ReasonHasBeenSet() const { return m_reasonHasBeenSet; } 202 203 /** 204 * <p>The reason given to the user that a stage is disabled, such as waiting for 205 * manual approval or manual tests. This message is displayed in the pipeline 206 * console UI.</p> 207 */ SetReason(const Aws::String & value)208 inline void SetReason(const Aws::String& value) { m_reasonHasBeenSet = true; m_reason = value; } 209 210 /** 211 * <p>The reason given to the user that a stage is disabled, such as waiting for 212 * manual approval or manual tests. This message is displayed in the pipeline 213 * console UI.</p> 214 */ SetReason(Aws::String && value)215 inline void SetReason(Aws::String&& value) { m_reasonHasBeenSet = true; m_reason = std::move(value); } 216 217 /** 218 * <p>The reason given to the user that a stage is disabled, such as waiting for 219 * manual approval or manual tests. This message is displayed in the pipeline 220 * console UI.</p> 221 */ SetReason(const char * value)222 inline void SetReason(const char* value) { m_reasonHasBeenSet = true; m_reason.assign(value); } 223 224 /** 225 * <p>The reason given to the user that a stage is disabled, such as waiting for 226 * manual approval or manual tests. This message is displayed in the pipeline 227 * console UI.</p> 228 */ WithReason(const Aws::String & value)229 inline DisableStageTransitionRequest& WithReason(const Aws::String& value) { SetReason(value); return *this;} 230 231 /** 232 * <p>The reason given to the user that a stage is disabled, such as waiting for 233 * manual approval or manual tests. This message is displayed in the pipeline 234 * console UI.</p> 235 */ WithReason(Aws::String && value)236 inline DisableStageTransitionRequest& WithReason(Aws::String&& value) { SetReason(std::move(value)); return *this;} 237 238 /** 239 * <p>The reason given to the user that a stage is disabled, such as waiting for 240 * manual approval or manual tests. This message is displayed in the pipeline 241 * console UI.</p> 242 */ WithReason(const char * value)243 inline DisableStageTransitionRequest& WithReason(const char* value) { SetReason(value); return *this;} 244 245 private: 246 247 Aws::String m_pipelineName; 248 bool m_pipelineNameHasBeenSet; 249 250 Aws::String m_stageName; 251 bool m_stageNameHasBeenSet; 252 253 StageTransitionType m_transitionType; 254 bool m_transitionTypeHasBeenSet; 255 256 Aws::String m_reason; 257 bool m_reasonHasBeenSet; 258 }; 259 260 } // namespace Model 261 } // namespace CodePipeline 262 } // namespace Aws 263