com.amazonaws.services.amplify.model.Step Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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.amplify.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes an execution step, for an execution job, for an Amplify app.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Step implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the execution step.
*
*/
private String stepName;
/**
*
* The start date and time of the execution step.
*
*/
private java.util.Date startTime;
/**
*
* The status of the execution step.
*
*/
private String status;
/**
*
* The end date and time of the execution step.
*
*/
private java.util.Date endTime;
/**
*
* The URL to the logs for the execution step.
*
*/
private String logUrl;
/**
*
* The URL to the artifact for the execution step.
*
*/
private String artifactsUrl;
/**
*
* The URL to the test artifact for the execution step.
*
*/
private String testArtifactsUrl;
/**
*
* The URL to the test configuration for the execution step.
*
*/
private String testConfigUrl;
/**
*
* The list of screenshot URLs for the execution step, if relevant.
*
*/
private java.util.Map screenshots;
/**
*
* The reason for the current step status.
*
*/
private String statusReason;
/**
*
* The context for the current step. Includes a build image if the step is build.
*
*/
private String context;
/**
*
* The name of the execution step.
*
*
* @param stepName
* The name of the execution step.
*/
public void setStepName(String stepName) {
this.stepName = stepName;
}
/**
*
* The name of the execution step.
*
*
* @return The name of the execution step.
*/
public String getStepName() {
return this.stepName;
}
/**
*
* The name of the execution step.
*
*
* @param stepName
* The name of the execution step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Step withStepName(String stepName) {
setStepName(stepName);
return this;
}
/**
*
* The start date and time of the execution step.
*
*
* @param startTime
* The start date and time of the execution step.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The start date and time of the execution step.
*
*
* @return The start date and time of the execution step.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The start date and time of the execution step.
*
*
* @param startTime
* The start date and time of the execution step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Step withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The status of the execution step.
*
*
* @param status
* The status of the execution step.
* @see JobStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the execution step.
*
*
* @return The status of the execution step.
* @see JobStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the execution step.
*
*
* @param status
* The status of the execution step.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public Step withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the execution step.
*
*
* @param status
* The status of the execution step.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public Step withStatus(JobStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The end date and time of the execution step.
*
*
* @param endTime
* The end date and time of the execution step.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The end date and time of the execution step.
*
*
* @return The end date and time of the execution step.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The end date and time of the execution step.
*
*
* @param endTime
* The end date and time of the execution step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Step withEndTime(java.util.Date endTime) {
setEndTime(endTime);
return this;
}
/**
*
* The URL to the logs for the execution step.
*
*
* @param logUrl
* The URL to the logs for the execution step.
*/
public void setLogUrl(String logUrl) {
this.logUrl = logUrl;
}
/**
*
* The URL to the logs for the execution step.
*
*
* @return The URL to the logs for the execution step.
*/
public String getLogUrl() {
return this.logUrl;
}
/**
*
* The URL to the logs for the execution step.
*
*
* @param logUrl
* The URL to the logs for the execution step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Step withLogUrl(String logUrl) {
setLogUrl(logUrl);
return this;
}
/**
*
* The URL to the artifact for the execution step.
*
*
* @param artifactsUrl
* The URL to the artifact for the execution step.
*/
public void setArtifactsUrl(String artifactsUrl) {
this.artifactsUrl = artifactsUrl;
}
/**
*
* The URL to the artifact for the execution step.
*
*
* @return The URL to the artifact for the execution step.
*/
public String getArtifactsUrl() {
return this.artifactsUrl;
}
/**
*
* The URL to the artifact for the execution step.
*
*
* @param artifactsUrl
* The URL to the artifact for the execution step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Step withArtifactsUrl(String artifactsUrl) {
setArtifactsUrl(artifactsUrl);
return this;
}
/**
*
* The URL to the test artifact for the execution step.
*
*
* @param testArtifactsUrl
* The URL to the test artifact for the execution step.
*/
public void setTestArtifactsUrl(String testArtifactsUrl) {
this.testArtifactsUrl = testArtifactsUrl;
}
/**
*
* The URL to the test artifact for the execution step.
*
*
* @return The URL to the test artifact for the execution step.
*/
public String getTestArtifactsUrl() {
return this.testArtifactsUrl;
}
/**
*
* The URL to the test artifact for the execution step.
*
*
* @param testArtifactsUrl
* The URL to the test artifact for the execution step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Step withTestArtifactsUrl(String testArtifactsUrl) {
setTestArtifactsUrl(testArtifactsUrl);
return this;
}
/**
*
* The URL to the test configuration for the execution step.
*
*
* @param testConfigUrl
* The URL to the test configuration for the execution step.
*/
public void setTestConfigUrl(String testConfigUrl) {
this.testConfigUrl = testConfigUrl;
}
/**
*
* The URL to the test configuration for the execution step.
*
*
* @return The URL to the test configuration for the execution step.
*/
public String getTestConfigUrl() {
return this.testConfigUrl;
}
/**
*
* The URL to the test configuration for the execution step.
*
*
* @param testConfigUrl
* The URL to the test configuration for the execution step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Step withTestConfigUrl(String testConfigUrl) {
setTestConfigUrl(testConfigUrl);
return this;
}
/**
*
* The list of screenshot URLs for the execution step, if relevant.
*
*
* @return The list of screenshot URLs for the execution step, if relevant.
*/
public java.util.Map getScreenshots() {
return screenshots;
}
/**
*
* The list of screenshot URLs for the execution step, if relevant.
*
*
* @param screenshots
* The list of screenshot URLs for the execution step, if relevant.
*/
public void setScreenshots(java.util.Map screenshots) {
this.screenshots = screenshots;
}
/**
*
* The list of screenshot URLs for the execution step, if relevant.
*
*
* @param screenshots
* The list of screenshot URLs for the execution step, if relevant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Step withScreenshots(java.util.Map screenshots) {
setScreenshots(screenshots);
return this;
}
/**
* Add a single Screenshots entry
*
* @see Step#withScreenshots
* @returns a reference to this object so that method calls can be chained together.
*/
public Step addScreenshotsEntry(String key, String value) {
if (null == this.screenshots) {
this.screenshots = new java.util.HashMap();
}
if (this.screenshots.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.screenshots.put(key, value);
return this;
}
/**
* Removes all the entries added into Screenshots.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Step clearScreenshotsEntries() {
this.screenshots = null;
return this;
}
/**
*
* The reason for the current step status.
*
*
* @param statusReason
* The reason for the current step status.
*/
public void setStatusReason(String statusReason) {
this.statusReason = statusReason;
}
/**
*
* The reason for the current step status.
*
*
* @return The reason for the current step status.
*/
public String getStatusReason() {
return this.statusReason;
}
/**
*
* The reason for the current step status.
*
*
* @param statusReason
* The reason for the current step status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Step withStatusReason(String statusReason) {
setStatusReason(statusReason);
return this;
}
/**
*
* The context for the current step. Includes a build image if the step is build.
*
*
* @param context
* The context for the current step. Includes a build image if the step is build.
*/
public void setContext(String context) {
this.context = context;
}
/**
*
* The context for the current step. Includes a build image if the step is build.
*
*
* @return The context for the current step. Includes a build image if the step is build.
*/
public String getContext() {
return this.context;
}
/**
*
* The context for the current step. Includes a build image if the step is build.
*
*
* @param context
* The context for the current step. Includes a build image if the step is build.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Step withContext(String context) {
setContext(context);
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 (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime()).append(",");
if (getLogUrl() != null)
sb.append("LogUrl: ").append(getLogUrl()).append(",");
if (getArtifactsUrl() != null)
sb.append("ArtifactsUrl: ").append(getArtifactsUrl()).append(",");
if (getTestArtifactsUrl() != null)
sb.append("TestArtifactsUrl: ").append(getTestArtifactsUrl()).append(",");
if (getTestConfigUrl() != null)
sb.append("TestConfigUrl: ").append(getTestConfigUrl()).append(",");
if (getScreenshots() != null)
sb.append("Screenshots: ").append(getScreenshots()).append(",");
if (getStatusReason() != null)
sb.append("StatusReason: ").append(getStatusReason()).append(",");
if (getContext() != null)
sb.append("Context: ").append(getContext());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Step == false)
return false;
Step other = (Step) obj;
if (other.getStepName() == null ^ this.getStepName() == null)
return false;
if (other.getStepName() != null && other.getStepName().equals(this.getStepName()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false)
return false;
if (other.getLogUrl() == null ^ this.getLogUrl() == null)
return false;
if (other.getLogUrl() != null && other.getLogUrl().equals(this.getLogUrl()) == false)
return false;
if (other.getArtifactsUrl() == null ^ this.getArtifactsUrl() == null)
return false;
if (other.getArtifactsUrl() != null && other.getArtifactsUrl().equals(this.getArtifactsUrl()) == false)
return false;
if (other.getTestArtifactsUrl() == null ^ this.getTestArtifactsUrl() == null)
return false;
if (other.getTestArtifactsUrl() != null && other.getTestArtifactsUrl().equals(this.getTestArtifactsUrl()) == false)
return false;
if (other.getTestConfigUrl() == null ^ this.getTestConfigUrl() == null)
return false;
if (other.getTestConfigUrl() != null && other.getTestConfigUrl().equals(this.getTestConfigUrl()) == false)
return false;
if (other.getScreenshots() == null ^ this.getScreenshots() == null)
return false;
if (other.getScreenshots() != null && other.getScreenshots().equals(this.getScreenshots()) == false)
return false;
if (other.getStatusReason() == null ^ this.getStatusReason() == null)
return false;
if (other.getStatusReason() != null && other.getStatusReason().equals(this.getStatusReason()) == false)
return false;
if (other.getContext() == null ^ this.getContext() == null)
return false;
if (other.getContext() != null && other.getContext().equals(this.getContext()) == 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 + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
hashCode = prime * hashCode + ((getLogUrl() == null) ? 0 : getLogUrl().hashCode());
hashCode = prime * hashCode + ((getArtifactsUrl() == null) ? 0 : getArtifactsUrl().hashCode());
hashCode = prime * hashCode + ((getTestArtifactsUrl() == null) ? 0 : getTestArtifactsUrl().hashCode());
hashCode = prime * hashCode + ((getTestConfigUrl() == null) ? 0 : getTestConfigUrl().hashCode());
hashCode = prime * hashCode + ((getScreenshots() == null) ? 0 : getScreenshots().hashCode());
hashCode = prime * hashCode + ((getStatusReason() == null) ? 0 : getStatusReason().hashCode());
hashCode = prime * hashCode + ((getContext() == null) ? 0 : getContext().hashCode());
return hashCode;
}
@Override
public Step clone() {
try {
return (Step) 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.amplify.model.transform.StepMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy