/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.simplesystemsmanagement.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* <p>
* Detailed information about an the execution state of an Automation step.
* </p>
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StepExecution" target="_top">AWS API
* Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StepExecution implements Serializable, Cloneable, StructuredPojo {
/**
* <p>
* The name of this execution step.
* </p>
*/
private String stepName;
/**
* <p>
* The action this step performs. The action determines the behavior of the step.
* </p>
*/
private String action;
/**
* <p>
* The timeout seconds of the step.
* </p>
*/
private Long timeoutSeconds;
/**
* <p>
* The action to take if the step fails. The default value is <code>Abort</code>.
* </p>
*/
private String onFailure;
/**
* <p>
* The maximum number of tries to run the action of the step. The default value is <code>1</code>.
* </p>
*/
private Integer maxAttempts;
/**
* <p>
* If a step has begun execution, this contains the time the step started. If the step is in Pending status, this
* field isn't populated.
* </p>
*/
private java.util.Date executionStartTime;
/**
* <p>
* If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded,
* this field isn't populated.
* </p>
*/
private java.util.Date executionEndTime;
/**
* <p>
* The execution status for this step.
* </p>
*/
private String stepStatus;
/**
* <p>
* The response code returned by the execution of the step.
* </p>
*/
private String responseCode;
/**
* <p>
* Fully-resolved values passed into the step before execution.
* </p>
*/
private java.util.Map<String, String> inputs;
/**
* <p>
* Returned values from the execution of the step.
* </p>
*/
private java.util.Map<String, java.util.List<String>> outputs;
/**
* <p>
* A message associated with the response code for an execution.
* </p>
*/
private String response;
/**
* <p>
* If a step failed, this message explains why the execution failed.
* </p>
*/
private String failureMessage;
/**
* <p>
* Information about the Automation failure.
* </p>
*/
private FailureDetails failureDetails;
/**
* <p>
* The unique ID of a step execution.
* </p>
*/
private String stepExecutionId;
/**
* <p>
* A user-specified list of parameters to override when running a step.
* </p>
*/
private java.util.Map<String, java.util.List<String>> overriddenParameters;
/**
* <p>
* The flag which can be used to end automation no matter whether the step succeeds or fails.
* </p>
*/
private Boolean isEnd;
/**
* <p>
* The next step after the step succeeds.
* </p>
*/
private String nextStep;
/**
* <p>
* The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
* </p>
*/
private Boolean isCritical;
/**
* <p>
* Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step
* fails. Continue will ignore the failure of current step and allow automation to run the next step. With
* conditional branching, we add step:stepName to support the automation to go to another specific step.
* </p>
*/
private com.amazonaws.internal.SdkInternalList<String> validNextSteps;
/**
* <p>
* The targets for the step execution.
* </p>
*/
private com.amazonaws.internal.SdkInternalList<Target> targets;
/**
* <p>
* The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
* Automation execution.
* </p>
*/
private TargetLocation targetLocation;
/**
* <p>
* The CloudWatch alarms that were invoked by the automation.
* </p>
*/
private com.amazonaws.internal.SdkInternalList<AlarmStateInformation> triggeredAlarms;
/**
* <p>
* The name of this execution step.
* </p>
*
* @param stepName
* The name of this execution step.
*/
public void setStepName(String stepName) {
this.stepName = stepName;
}
/**
* <p>
* The name of this execution step.
* </p>
*
* @return The name of this execution step.
*/
public String getStepName() {
return this.stepName;
}
/**
* <p>
* The name of this execution step.
* </p>
*
* @param stepName
* The name of this execution step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withStepName(String stepName) {
setStepName(stepName);
return this;
}
/**
* <p>
* The action this step performs. The action determines the behavior of the step.
* </p>
*
* @param action
* The action this step performs. The action determines the behavior of the step.
*/
public void setAction(String action) {
this.action = action;
}
/**
* <p>
* The action this step performs. The action determines the behavior of the step.
* </p>
*
* @return The action this step performs. The action determines the behavior of the step.
*/
public String getAction() {
return this.action;
}
/**
* <p>
* The action this step performs. The action determines the behavior of the step.
* </p>
*
* @param action
* The action this step performs. The action determines the behavior of the step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withAction(String action) {
setAction(action);
return this;
}
/**
* <p>
* The timeout seconds of the step.
* </p>
*
* @param timeoutSeconds
* The timeout seconds of the step.
*/
public void setTimeoutSeconds(Long timeoutSeconds) {
this.timeoutSeconds = timeoutSeconds;
}
/**
* <p>
* The timeout seconds of the step.
* </p>
*
* @return The timeout seconds of the step.
*/
public Long getTimeoutSeconds() {
return this.timeoutSeconds;
}
/**
* <p>
* The timeout seconds of the step.
* </p>
*
* @param timeoutSeconds
* The timeout seconds of the step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withTimeoutSeconds(Long timeoutSeconds) {
setTimeoutSeconds(timeoutSeconds);
return this;
}
/**
* <p>
* The action to take if the step fails. The default value is <code>Abort</code>.
* </p>
*
* @param onFailure
* The action to take if the step fails. The default value is <code>Abort</code>.
*/
public void setOnFailure(String onFailure) {
this.onFailure = onFailure;
}
/**
* <p>
* The action to take if the step fails. The default value is <code>Abort</code>.
* </p>
*
* @return The action to take if the step fails. The default value is <code>Abort</code>.
*/
public String getOnFailure() {
return this.onFailure;
}
/**
* <p>
* The action to take if the step fails. The default value is <code>Abort</code>.
* </p>
*
* @param onFailure
* The action to take if the step fails. The default value is <code>Abort</code>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withOnFailure(String onFailure) {
setOnFailure(onFailure);
return this;
}
/**
* <p>
* The maximum number of tries to run the action of the step. The default value is <code>1</code>.
* </p>
*
* @param maxAttempts
* The maximum number of tries to run the action of the step. The default value is <code>1</code>.
*/
public void setMaxAttempts(Integer maxAttempts) {
this.maxAttempts = maxAttempts;
}
/**
* <p>
* The maximum number of tries to run the action of the step. The default value is <code>1</code>.
* </p>
*
* @return The maximum number of tries to run the action of the step. The default value is <code>1</code>.
*/
public Integer getMaxAttempts() {
return this.maxAttempts;
}
/**
* <p>
* The maximum number of tries to run the action of the step. The default value is <code>1</code>.
* </p>
*
* @param maxAttempts
* The maximum number of tries to run the action of the step. The default value is <code>1</code>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withMaxAttempts(Integer maxAttempts) {
setMaxAttempts(maxAttempts);
return this;
}
/**
* <p>
* If a step has begun execution, this contains the time the step started. If the step is in Pending status, this
* field isn't populated.
* </p>
*
* @param executionStartTime
* If a step has begun execution, this contains the time the step started. If the step is in Pending status,
* this field isn't populated.
*/
public void setExecutionStartTime(java.util.Date executionStartTime) {
this.executionStartTime = executionStartTime;
}
/**
* <p>
* If a step has begun execution, this contains the time the step started. If the step is in Pending status, this
* field isn't populated.
* </p>
*
* @return If a step has begun execution, this contains the time the step started. If the step is in Pending status,
* this field isn't populated.
*/
public java.util.Date getExecutionStartTime() {
return this.executionStartTime;
}
/**
* <p>
* If a step has begun execution, this contains the time the step started. If the step is in Pending status, this
* field isn't populated.
* </p>
*
* @param executionStartTime
* If a step has begun execution, this contains the time the step started. If the step is in Pending status,
* this field isn't populated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withExecutionStartTime(java.util.Date executionStartTime) {
setExecutionStartTime(executionStartTime);
return this;
}
/**
* <p>
* If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded,
* this field isn't populated.
* </p>
*
* @param executionEndTime
* If a step has finished execution, this contains the time the execution ended. If the step hasn't yet
* concluded, this field isn't populated.
*/
public void setExecutionEndTime(java.util.Date executionEndTime) {
this.executionEndTime = executionEndTime;
}
/**
* <p>
* If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded,
* this field isn't populated.
* </p>
*
* @return If a step has finished execution, this contains the time the execution ended. If the step hasn't yet
* concluded, this field isn't populated.
*/
public java.util.Date getExecutionEndTime() {
return this.executionEndTime;
}
/**
* <p>
* If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded,
* this field isn't populated.
* </p>
*
* @param executionEndTime
* If a step has finished execution, this contains the time the execution ended. If the step hasn't yet
* concluded, this field isn't populated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withExecutionEndTime(java.util.Date executionEndTime) {
setExecutionEndTime(executionEndTime);
return this;
}
/**
* <p>
* The execution status for this step.
* </p>
*
* @param stepStatus
* The execution status for this step.
* @see AutomationExecutionStatus
*/
public void setStepStatus(String stepStatus) {
this.stepStatus = stepStatus;
}
/**
* <p>
* The execution status for this step.
* </p>
*
* @return The execution status for this step.
* @see AutomationExecutionStatus
*/
public String getStepStatus() {
return this.stepStatus;
}
/**
* <p>
* The execution status for this step.
* </p>
*
* @param stepStatus
* The execution status for this step.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutomationExecutionStatus
*/
public StepExecution withStepStatus(String stepStatus) {
setStepStatus(stepStatus);
return this;
}
/**
* <p>
* The execution status for this step.
* </p>
*
* @param stepStatus
* The execution status for this step.
* @see AutomationExecutionStatus
*/
public void setStepStatus(AutomationExecutionStatus stepStatus) {
withStepStatus(stepStatus);
}
/**
* <p>
* The execution status for this step.
* </p>
*
* @param stepStatus
* The execution status for this step.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutomationExecutionStatus
*/
public StepExecution withStepStatus(AutomationExecutionStatus stepStatus) {
this.stepStatus = stepStatus.toString();
return this;
}
/**
* <p>
* The response code returned by the execution of the step.
* </p>
*
* @param responseCode
* The response code returned by the execution of the step.
*/
public void setResponseCode(String responseCode) {
this.responseCode = responseCode;
}
/**
* <p>
* The response code returned by the execution of the step.
* </p>
*
* @return The response code returned by the execution of the step.
*/
public String getResponseCode() {
return this.responseCode;
}
/**
* <p>
* The response code returned by the execution of the step.
* </p>
*
* @param responseCode
* The response code returned by the execution of the step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withResponseCode(String responseCode) {
setResponseCode(responseCode);
return this;
}
/**
* <p>
* Fully-resolved values passed into the step before execution.
* </p>
*
* @return Fully-resolved values passed into the step before execution.
*/
public java.util.Map<String, String> getInputs() {
return inputs;
}
/**
* <p>
* Fully-resolved values passed into the step before execution.
* </p>
*
* @param inputs
* Fully-resolved values passed into the step before execution.
*/
public void setInputs(java.util.Map<String, String> inputs) {
this.inputs = inputs;
}
/**
* <p>
* Fully-resolved values passed into the step before execution.
* </p>
*
* @param inputs
* Fully-resolved values passed into the step before execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withInputs(java.util.Map<String, String> inputs) {
setInputs(inputs);
return this;
}
/**
* Add a single Inputs entry
*
* @see StepExecution#withInputs
* @returns a reference to this object so that method calls can be chained together.
*/
public StepExecution addInputsEntry(String key, String value) {
if (null == this.inputs) {
this.inputs = new java.util.HashMap<String, String>();
}
if (this.inputs.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.inputs.put(key, value);
return this;
}
/**
* Removes all the entries added into Inputs.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution clearInputsEntries() {
this.inputs = null;
return this;
}
/**
* <p>
* Returned values from the execution of the step.
* </p>
*
* @return Returned values from the execution of the step.
*/
public java.util.Map<String, java.util.List<String>> getOutputs() {
return outputs;
}
/**
* <p>
* Returned values from the execution of the step.
* </p>
*
* @param outputs
* Returned values from the execution of the step.
*/
public void setOutputs(java.util.Map<String, java.util.List<String>> outputs) {
this.outputs = outputs;
}
/**
* <p>
* Returned values from the execution of the step.
* </p>
*
* @param outputs
* Returned values from the execution of the step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withOutputs(java.util.Map<String, java.util.List<String>> outputs) {
setOutputs(outputs);
return this;
}
/**
* Add a single Outputs entry
*
* @see StepExecution#withOutputs
* @returns a reference to this object so that method calls can be chained together.
*/
public StepExecution addOutputsEntry(String key, java.util.List<String> value) {
if (null == this.outputs) {
this.outputs = new java.util.HashMap<String, java.util.List<String>>();
}
if (this.outputs.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.outputs.put(key, value);
return this;
}
/**
* Removes all the entries added into Outputs.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution clearOutputsEntries() {
this.outputs = null;
return this;
}
/**
* <p>
* A message associated with the response code for an execution.
* </p>
*
* @param response
* A message associated with the response code for an execution.
*/
public void setResponse(String response) {
this.response = response;
}
/**
* <p>
* A message associated with the response code for an execution.
* </p>
*
* @return A message associated with the response code for an execution.
*/
public String getResponse() {
return this.response;
}
/**
* <p>
* A message associated with the response code for an execution.
* </p>
*
* @param response
* A message associated with the response code for an execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withResponse(String response) {
setResponse(response);
return this;
}
/**
* <p>
* If a step failed, this message explains why the execution failed.
* </p>
*
* @param failureMessage
* If a step failed, this message explains why the execution failed.
*/
public void setFailureMessage(String failureMessage) {
this.failureMessage = failureMessage;
}
/**
* <p>
* If a step failed, this message explains why the execution failed.
* </p>
*
* @return If a step failed, this message explains why the execution failed.
*/
public String getFailureMessage() {
return this.failureMessage;
}
/**
* <p>
* If a step failed, this message explains why the execution failed.
* </p>
*
* @param failureMessage
* If a step failed, this message explains why the execution failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withFailureMessage(String failureMessage) {
setFailureMessage(failureMessage);
return this;
}
/**
* <p>
* Information about the Automation failure.
* </p>
*
* @param failureDetails
* Information about the Automation failure.
*/
public void setFailureDetails(FailureDetails failureDetails) {
this.failureDetails = failureDetails;
}
/**
* <p>
* Information about the Automation failure.
* </p>
*
* @return Information about the Automation failure.
*/
public FailureDetails getFailureDetails() {
return this.failureDetails;
}
/**
* <p>
* Information about the Automation failure.
* </p>
*
* @param failureDetails
* Information about the Automation failure.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withFailureDetails(FailureDetails failureDetails) {
setFailureDetails(failureDetails);
return this;
}
/**
* <p>
* The unique ID of a step execution.
* </p>
*
* @param stepExecutionId
* The unique ID of a step execution.
*/
public void setStepExecutionId(String stepExecutionId) {
this.stepExecutionId = stepExecutionId;
}
/**
* <p>
* The unique ID of a step execution.
* </p>
*
* @return The unique ID of a step execution.
*/
public String getStepExecutionId() {
return this.stepExecutionId;
}
/**
* <p>
* The unique ID of a step execution.
* </p>
*
* @param stepExecutionId
* The unique ID of a step execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withStepExecutionId(String stepExecutionId) {
setStepExecutionId(stepExecutionId);
return this;
}
/**
* <p>
* A user-specified list of parameters to override when running a step.
* </p>
*
* @return A user-specified list of parameters to override when running a step.
*/
public java.util.Map<String, java.util.List<String>> getOverriddenParameters() {
return overriddenParameters;
}
/**
* <p>
* A user-specified list of parameters to override when running a step.
* </p>
*
* @param overriddenParameters
* A user-specified list of parameters to override when running a step.
*/
public void setOverriddenParameters(java.util.Map<String, java.util.List<String>> overriddenParameters) {
this.overriddenParameters = overriddenParameters;
}
/**
* <p>
* A user-specified list of parameters to override when running a step.
* </p>
*
* @param overriddenParameters
* A user-specified list of parameters to override when running a step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withOverriddenParameters(java.util.Map<String, java.util.List<String>> overriddenParameters) {
setOverriddenParameters(overriddenParameters);
return this;
}
/**
* Add a single OverriddenParameters entry
*
* @see StepExecution#withOverriddenParameters
* @returns a reference to this object so that method calls can be chained together.
*/
public StepExecution addOverriddenParametersEntry(String key, java.util.List<String> value) {
if (null == this.overriddenParameters) {
this.overriddenParameters = new java.util.HashMap<String, java.util.List<String>>();
}
if (this.overriddenParameters.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.overriddenParameters.put(key, value);
return this;
}
/**
* Removes all the entries added into OverriddenParameters.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution clearOverriddenParametersEntries() {
this.overriddenParameters = null;
return this;
}
/**
* <p>
* The flag which can be used to end automation no matter whether the step succeeds or fails.
* </p>
*
* @param isEnd
* The flag which can be used to end automation no matter whether the step succeeds or fails.
*/
public void setIsEnd(Boolean isEnd) {
this.isEnd = isEnd;
}
/**
* <p>
* The flag which can be used to end automation no matter whether the step succeeds or fails.
* </p>
*
* @return The flag which can be used to end automation no matter whether the step succeeds or fails.
*/
public Boolean getIsEnd() {
return this.isEnd;
}
/**
* <p>
* The flag which can be used to end automation no matter whether the step succeeds or fails.
* </p>
*
* @param isEnd
* The flag which can be used to end automation no matter whether the step succeeds or fails.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withIsEnd(Boolean isEnd) {
setIsEnd(isEnd);
return this;
}
/**
* <p>
* The flag which can be used to end automation no matter whether the step succeeds or fails.
* </p>
*
* @return The flag which can be used to end automation no matter whether the step succeeds or fails.
*/
public Boolean isEnd() {
return this.isEnd;
}
/**
* <p>
* The next step after the step succeeds.
* </p>
*
* @param nextStep
* The next step after the step succeeds.
*/
public void setNextStep(String nextStep) {
this.nextStep = nextStep;
}
/**
* <p>
* The next step after the step succeeds.
* </p>
*
* @return The next step after the step succeeds.
*/
public String getNextStep() {
return this.nextStep;
}
/**
* <p>
* The next step after the step succeeds.
* </p>
*
* @param nextStep
* The next step after the step succeeds.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withNextStep(String nextStep) {
setNextStep(nextStep);
return this;
}
/**
* <p>
* The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
* </p>
*
* @param isCritical
* The flag which can be used to help decide whether the failure of current step leads to the Automation
* failure.
*/
public void setIsCritical(Boolean isCritical) {
this.isCritical = isCritical;
}
/**
* <p>
* The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
* </p>
*
* @return The flag which can be used to help decide whether the failure of current step leads to the Automation
* failure.
*/
public Boolean getIsCritical() {
return this.isCritical;
}
/**
* <p>
* The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
* </p>
*
* @param isCritical
* The flag which can be used to help decide whether the failure of current step leads to the Automation
* failure.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withIsCritical(Boolean isCritical) {
setIsCritical(isCritical);
return this;
}
/**
* <p>
* The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
* </p>
*
* @return The flag which can be used to help decide whether the failure of current step leads to the Automation
* failure.
*/
public Boolean isCritical() {
return this.isCritical;
}
/**
* <p>
* Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step
* fails. Continue will ignore the failure of current step and allow automation to run the next step. With
* conditional branching, we add step:stepName to support the automation to go to another specific step.
* </p>
*
* @return Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the
* step fails. Continue will ignore the failure of current step and allow automation to run the next step.
* With conditional branching, we add step:stepName to support the automation to go to another specific
* step.
*/
public java.util.List<String> getValidNextSteps() {
if (validNextSteps == null) {
validNextSteps = new com.amazonaws.internal.SdkInternalList<String>();
}
return validNextSteps;
}
/**
* <p>
* Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step
* fails. Continue will ignore the failure of current step and allow automation to run the next step. With
* conditional branching, we add step:stepName to support the automation to go to another specific step.
* </p>
*
* @param validNextSteps
* Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the
* step fails. Continue will ignore the failure of current step and allow automation to run the next step.
* With conditional branching, we add step:stepName to support the automation to go to another specific step.
*/
public void setValidNextSteps(java.util.Collection<String> validNextSteps) {
if (validNextSteps == null) {
this.validNextSteps = null;
return;
}
this.validNextSteps = new com.amazonaws.internal.SdkInternalList<String>(validNextSteps);
}
/**
* <p>
* Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step
* fails. Continue will ignore the failure of current step and allow automation to run the next step. With
* conditional branching, we add step:stepName to support the automation to go to another specific step.
* </p>
* <p>
* <b>NOTE:</b> This method appends the values to the existing list (if any). Use
* {@link #setValidNextSteps(java.util.Collection)} or {@link #withValidNextSteps(java.util.Collection)} if you want
* to override the existing values.
* </p>
*
* @param validNextSteps
* Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the
* step fails. Continue will ignore the failure of current step and allow automation to run the next step.
* With conditional branching, we add step:stepName to support the automation to go to another specific step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withValidNextSteps(String... validNextSteps) {
if (this.validNextSteps == null) {
setValidNextSteps(new com.amazonaws.internal.SdkInternalList<String>(validNextSteps.length));
}
for (String ele : validNextSteps) {
this.validNextSteps.add(ele);
}
return this;
}
/**
* <p>
* Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step
* fails. Continue will ignore the failure of current step and allow automation to run the next step. With
* conditional branching, we add step:stepName to support the automation to go to another specific step.
* </p>
*
* @param validNextSteps
* Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the
* step fails. Continue will ignore the failure of current step and allow automation to run the next step.
* With conditional branching, we add step:stepName to support the automation to go to another specific step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withValidNextSteps(java.util.Collection<String> validNextSteps) {
setValidNextSteps(validNextSteps);
return this;
}
/**
* <p>
* The targets for the step execution.
* </p>
*
* @return The targets for the step execution.
*/
public java.util.List<Target> getTargets() {
if (targets == null) {
targets = new com.amazonaws.internal.SdkInternalList<Target>();
}
return targets;
}
/**
* <p>
* The targets for the step execution.
* </p>
*
* @param targets
* The targets for the step execution.
*/
public void setTargets(java.util.Collection<Target> targets) {
if (targets == null) {
this.targets = null;
return;
}
this.targets = new com.amazonaws.internal.SdkInternalList<Target>(targets);
}
/**
* <p>
* The targets for the step execution.
* </p>
* <p>
* <b>NOTE:</b> This method appends the values to the existing list (if any). Use
* {@link #setTargets(java.util.Collection)} or {@link #withTargets(java.util.Collection)} if you want to override
* the existing values.
* </p>
*
* @param targets
* The targets for the step execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withTargets(Target... targets) {
if (this.targets == null) {
setTargets(new com.amazonaws.internal.SdkInternalList<Target>(targets.length));
}
for (Target ele : targets) {
this.targets.add(ele);
}
return this;
}
/**
* <p>
* The targets for the step execution.
* </p>
*
* @param targets
* The targets for the step execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withTargets(java.util.Collection<Target> targets) {
setTargets(targets);
return this;
}
/**
* <p>
* The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
* Automation execution.
* </p>
*
* @param targetLocation
* The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
* Automation execution.
*/
public void setTargetLocation(TargetLocation targetLocation) {
this.targetLocation = targetLocation;
}
/**
* <p>
* The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
* Automation execution.
* </p>
*
* @return The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
* Automation execution.
*/
public TargetLocation getTargetLocation() {
return this.targetLocation;
}
/**
* <p>
* The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
* Automation execution.
* </p>
*
* @param targetLocation
* The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
* Automation execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withTargetLocation(TargetLocation targetLocation) {
setTargetLocation(targetLocation);
return this;
}
/**
* <p>
* The CloudWatch alarms that were invoked by the automation.
* </p>
*
* @return The CloudWatch alarms that were invoked by the automation.
*/
public java.util.List<AlarmStateInformation> getTriggeredAlarms() {
if (triggeredAlarms == null) {
triggeredAlarms = new com.amazonaws.internal.SdkInternalList<AlarmStateInformation>();
}
return triggeredAlarms;
}
/**
* <p>
* The CloudWatch alarms that were invoked by the automation.
* </p>
*
* @param triggeredAlarms
* The CloudWatch alarms that were invoked by the automation.
*/
public void setTriggeredAlarms(java.util.Collection<AlarmStateInformation> triggeredAlarms) {
if (triggeredAlarms == null) {
this.triggeredAlarms = null;
return;
}
this.triggeredAlarms = new com.amazonaws.internal.SdkInternalList<AlarmStateInformation>(triggeredAlarms);
}
/**
* <p>
* The CloudWatch alarms that were invoked by the automation.
* </p>
* <p>
* <b>NOTE:</b> This method appends the values to the existing list (if any). Use
* {@link #setTriggeredAlarms(java.util.Collection)} or {@link #withTriggeredAlarms(java.util.Collection)} if you
* want to override the existing values.
* </p>
*
* @param triggeredAlarms
* The CloudWatch alarms that were invoked by the automation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withTriggeredAlarms(AlarmStateInformation... triggeredAlarms) {
if (this.triggeredAlarms == null) {
setTriggeredAlarms(new com.amazonaws.internal.SdkInternalList<AlarmStateInformation>(triggeredAlarms.length));
}
for (AlarmStateInformation ele : triggeredAlarms) {
this.triggeredAlarms.add(ele);
}
return this;
}
/**
* <p>
* The CloudWatch alarms that were invoked by the automation.
* </p>
*
* @param triggeredAlarms
* The CloudWatch alarms that were invoked by the automation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepExecution withTriggeredAlarms(java.util.Collection<AlarmStateInformation> triggeredAlarms) {
setTriggeredAlarms(triggeredAlarms);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStepName() != null)
sb.append("StepName: ").append(getStepName()).append(",");
if (getAction() != null)
sb.append("Action: ").append(getAction()).append(",");
if (getTimeoutSeconds() != null)
sb.append("TimeoutSeconds: ").append(getTimeoutSeconds()).append(",");
if (getOnFailure() != null)
sb.append("OnFailure: ").append(getOnFailure()).append(",");
if (getMaxAttempts() != null)
sb.append("MaxAttempts: ").append(getMaxAttempts()).append(",");
if (getExecutionStartTime() != null)
sb.append("ExecutionStartTime: ").append(getExecutionStartTime()).append(",");
if (getExecutionEndTime() != null)
sb.append("ExecutionEndTime: ").append(getExecutionEndTime()).append(",");
if (getStepStatus() != null)
sb.append("StepStatus: ").append(getStepStatus()).append(",");
if (getResponseCode() != null)
sb.append("ResponseCode: ").append(getResponseCode()).append(",");
if (getInputs() != null)
sb.append("Inputs: ").append(getInputs()).append(",");
if (getOutputs() != null)
sb.append("Outputs: ").append(getOutputs()).append(",");
if (getResponse() != null)
sb.append("Response: ").append(getResponse()).append(",");
if (getFailureMessage() != null)
sb.append("FailureMessage: ").append(getFailureMessage()).append(",");
if (getFailureDetails() != null)
sb.append("FailureDetails: ").append(getFailureDetails()).append(",");
if (getStepExecutionId() != null)
sb.append("StepExecutionId: ").append(getStepExecutionId()).append(",");
if (getOverriddenParameters() != null)
sb.append("OverriddenParameters: ").append(getOverriddenParameters()).append(",");
if (getIsEnd() != null)
sb.append("IsEnd: ").append(getIsEnd()).append(",");
if (getNextStep() != null)
sb.append("NextStep: ").append(getNextStep()).append(",");
if (getIsCritical() != null)
sb.append("IsCritical: ").append(getIsCritical()).append(",");
if (getValidNextSteps() != null)
sb.append("ValidNextSteps: ").append(getValidNextSteps()).append(",");
if (getTargets() != null)
sb.append("Targets: ").append(getTargets()).append(",");
if (getTargetLocation() != null)
sb.append("TargetLocation: ").append(getTargetLocation()).append(",");
if (getTriggeredAlarms() != null)
sb.append("TriggeredAlarms: ").append(getTriggeredAlarms());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StepExecution == false)
return false;
StepExecution other = (StepExecution) obj;
if (other.getStepName() == null ^ this.getStepName() == null)
return false;
if (other.getStepName() != null && other.getStepName().equals(this.getStepName()) == false)
return false;
if (other.getAction() == null ^ this.getAction() == null)
return false;
if (other.getAction() != null && other.getAction().equals(this.getAction()) == false)
return false;
if (other.getTimeoutSeconds() == null ^ this.getTimeoutSeconds() == null)
return false;
if (other.getTimeoutSeconds() != null && other.getTimeoutSeconds().equals(this.getTimeoutSeconds()) == false)
return false;
if (other.getOnFailure() == null ^ this.getOnFailure() == null)
return false;
if (other.getOnFailure() != null && other.getOnFailure().equals(this.getOnFailure()) == false)
return false;
if (other.getMaxAttempts() == null ^ this.getMaxAttempts() == null)
return false;
if (other.getMaxAttempts() != null && other.getMaxAttempts().equals(this.getMaxAttempts()) == false)
return false;
if (other.getExecutionStartTime() == null ^ this.getExecutionStartTime() == null)
return false;
if (other.getExecutionStartTime() != null && other.getExecutionStartTime().equals(this.getExecutionStartTime()) == false)
return false;
if (other.getExecutionEndTime() == null ^ this.getExecutionEndTime() == null)
return false;
if (other.getExecutionEndTime() != null && other.getExecutionEndTime().equals(this.getExecutionEndTime()) == false)
return false;
if (other.getStepStatus() == null ^ this.getStepStatus() == null)
return false;
if (other.getStepStatus() != null && other.getStepStatus().equals(this.getStepStatus()) == false)
return false;
if (other.getResponseCode() == null ^ this.getResponseCode() == null)
return false;
if (other.getResponseCode() != null && other.getResponseCode().equals(this.getResponseCode()) == false)
return false;
if (other.getInputs() == null ^ this.getInputs() == null)
return false;
if (other.getInputs() != null && other.getInputs().equals(this.getInputs()) == false)
return false;
if (other.getOutputs() == null ^ this.getOutputs() == null)
return false;
if (other.getOutputs() != null && other.getOutputs().equals(this.getOutputs()) == false)
return false;
if (other.getResponse() == null ^ this.getResponse() == null)
return false;
if (other.getResponse() != null && other.getResponse().equals(this.getResponse()) == false)
return false;
if (other.getFailureMessage() == null ^ this.getFailureMessage() == null)
return false;
if (other.getFailureMessage() != null && other.getFailureMessage().equals(this.getFailureMessage()) == false)
return false;
if (other.getFailureDetails() == null ^ this.getFailureDetails() == null)
return false;
if (other.getFailureDetails() != null && other.getFailureDetails().equals(this.getFailureDetails()) == false)
return false;
if (other.getStepExecutionId() == null ^ this.getStepExecutionId() == null)
return false;
if (other.getStepExecutionId() != null && other.getStepExecutionId().equals(this.getStepExecutionId()) == false)
return false;
if (other.getOverriddenParameters() == null ^ this.getOverriddenParameters() == null)
return false;
if (other.getOverriddenParameters() != null && other.getOverriddenParameters().equals(this.getOverriddenParameters()) == false)
return false;
if (other.getIsEnd() == null ^ this.getIsEnd() == null)
return false;
if (other.getIsEnd() != null && other.getIsEnd().equals(this.getIsEnd()) == false)
return false;
if (other.getNextStep() == null ^ this.getNextStep() == null)
return false;
if (other.getNextStep() != null && other.getNextStep().equals(this.getNextStep()) == false)
return false;
if (other.getIsCritical() == null ^ this.getIsCritical() == null)
return false;
if (other.getIsCritical() != null && other.getIsCritical().equals(this.getIsCritical()) == false)
return false;
if (other.getValidNextSteps() == null ^ this.getValidNextSteps() == null)
return false;
if (other.getValidNextSteps() != null && other.getValidNextSteps().equals(this.getValidNextSteps()) == false)
return false;
if (other.getTargets() == null ^ this.getTargets() == null)
return false;
if (other.getTargets() != null && other.getTargets().equals(this.getTargets()) == false)
return false;
if (other.getTargetLocation() == null ^ this.getTargetLocation() == null)
return false;
if (other.getTargetLocation() != null && other.getTargetLocation().equals(this.getTargetLocation()) == false)
return false;
if (other.getTriggeredAlarms() == null ^ this.getTriggeredAlarms() == null)
return false;
if (other.getTriggeredAlarms() != null && other.getTriggeredAlarms().equals(this.getTriggeredAlarms()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStepName() == null) ? 0 : getStepName().hashCode());
hashCode = prime * hashCode + ((getAction() == null) ? 0 : getAction().hashCode());
hashCode = prime * hashCode + ((getTimeoutSeconds() == null) ? 0 : getTimeoutSeconds().hashCode());
hashCode = prime * hashCode + ((getOnFailure() == null) ? 0 : getOnFailure().hashCode());
hashCode = prime * hashCode + ((getMaxAttempts() == null) ? 0 : getMaxAttempts().hashCode());
hashCode = prime * hashCode + ((getExecutionStartTime() == null) ? 0 : getExecutionStartTime().hashCode());
hashCode = prime * hashCode + ((getExecutionEndTime() == null) ? 0 : getExecutionEndTime().hashCode());
hashCode = prime * hashCode + ((getStepStatus() == null) ? 0 : getStepStatus().hashCode());
hashCode = prime * hashCode + ((getResponseCode() == null) ? 0 : getResponseCode().hashCode());
hashCode = prime * hashCode + ((getInputs() == null) ? 0 : getInputs().hashCode());
hashCode = prime * hashCode + ((getOutputs() == null) ? 0 : getOutputs().hashCode());
hashCode = prime * hashCode + ((getResponse() == null) ? 0 : getResponse().hashCode());
hashCode = prime * hashCode + ((getFailureMessage() == null) ? 0 : getFailureMessage().hashCode());
hashCode = prime * hashCode + ((getFailureDetails() == null) ? 0 : getFailureDetails().hashCode());
hashCode = prime * hashCode + ((getStepExecutionId() == null) ? 0 : getStepExecutionId().hashCode());
hashCode = prime * hashCode + ((getOverriddenParameters() == null) ? 0 : getOverriddenParameters().hashCode());
hashCode = prime * hashCode + ((getIsEnd() == null) ? 0 : getIsEnd().hashCode());
hashCode = prime * hashCode + ((getNextStep() == null) ? 0 : getNextStep().hashCode());
hashCode = prime * hashCode + ((getIsCritical() == null) ? 0 : getIsCritical().hashCode());
hashCode = prime * hashCode + ((getValidNextSteps() == null) ? 0 : getValidNextSteps().hashCode());
hashCode = prime * hashCode + ((getTargets() == null) ? 0 : getTargets().hashCode());
hashCode = prime * hashCode + ((getTargetLocation() == null) ? 0 : getTargetLocation().hashCode());
hashCode = prime * hashCode + ((getTriggeredAlarms() == null) ? 0 : getTriggeredAlarms().hashCode());
return hashCode;
}
@Override
public StepExecution clone() {
try {
return (StepExecution) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.simplesystemsmanagement.model.transform.StepExecutionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}