com.amazonaws.services.iot.model.JobExecution Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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.iot.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The job execution object represents the execution of a job on a particular device.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class JobExecution implements Serializable, Cloneable, StructuredPojo {
/**
*
* The unique identifier you assigned to the job when it was created.
*
*/
private String jobId;
/**
*
* The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
*
*/
private String status;
/**
*
* Will be true if the job execution was canceled with the optional force parameter set to
* true.
*
*/
private Boolean forceCanceled;
/**
*
* A collection of name/value pairs that describe the status of the job execution.
*
*/
private JobExecutionStatusDetails statusDetails;
/**
*
* The ARN of the thing on which the job execution is running.
*
*/
private String thingArn;
/**
*
* The time, in seconds since the epoch, when the job execution was queued.
*
*/
private java.util.Date queuedAt;
/**
*
* The time, in seconds since the epoch, when the job execution started.
*
*/
private java.util.Date startedAt;
/**
*
* The time, in seconds since the epoch, when the job execution was last updated.
*
*/
private java.util.Date lastUpdatedAt;
/**
*
* A string (consisting of the digits "0" through "9") which identifies this particular job execution on this
* particular device. It can be used in commands which return or update job execution information.
*
*/
private Long executionNumber;
/**
*
* The version of the job execution. Job execution versions are incremented each time they are updated by a device.
*
*/
private Long versionNumber;
/**
*
* The estimated number of seconds that remain before the job execution status will be changed to
* TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes).
* The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will
* not be included if the job execution has reached a terminal status.
*
*/
private Long approximateSecondsBeforeTimedOut;
/**
*
* The unique identifier you assigned to the job when it was created.
*
*
* @param jobId
* The unique identifier you assigned to the job when it was created.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* The unique identifier you assigned to the job when it was created.
*
*
* @return The unique identifier you assigned to the job when it was created.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* The unique identifier you assigned to the job when it was created.
*
*
* @param jobId
* The unique identifier you assigned to the job when it was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobExecution withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
*
* The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
*
*
* @param status
* The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or
* REJECTED).
* @see JobExecutionStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
*
*
* @return The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or
* REJECTED).
* @see JobExecutionStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
*
*
* @param status
* The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or
* REJECTED).
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobExecutionStatus
*/
public JobExecution withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
*
*
* @param status
* The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or
* REJECTED).
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobExecutionStatus
*/
public JobExecution withStatus(JobExecutionStatus status) {
this.status = status.toString();
return this;
}
/**
*
* Will be true if the job execution was canceled with the optional force parameter set to
* true.
*
*
* @param forceCanceled
* Will be true if the job execution was canceled with the optional force parameter
* set to true.
*/
public void setForceCanceled(Boolean forceCanceled) {
this.forceCanceled = forceCanceled;
}
/**
*
* Will be true if the job execution was canceled with the optional force parameter set to
* true.
*
*
* @return Will be true if the job execution was canceled with the optional force
* parameter set to true.
*/
public Boolean getForceCanceled() {
return this.forceCanceled;
}
/**
*
* Will be true if the job execution was canceled with the optional force parameter set to
* true.
*
*
* @param forceCanceled
* Will be true if the job execution was canceled with the optional force parameter
* set to true.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobExecution withForceCanceled(Boolean forceCanceled) {
setForceCanceled(forceCanceled);
return this;
}
/**
*
* Will be true if the job execution was canceled with the optional force parameter set to
* true.
*
*
* @return Will be true if the job execution was canceled with the optional force
* parameter set to true.
*/
public Boolean isForceCanceled() {
return this.forceCanceled;
}
/**
*
* A collection of name/value pairs that describe the status of the job execution.
*
*
* @param statusDetails
* A collection of name/value pairs that describe the status of the job execution.
*/
public void setStatusDetails(JobExecutionStatusDetails statusDetails) {
this.statusDetails = statusDetails;
}
/**
*
* A collection of name/value pairs that describe the status of the job execution.
*
*
* @return A collection of name/value pairs that describe the status of the job execution.
*/
public JobExecutionStatusDetails getStatusDetails() {
return this.statusDetails;
}
/**
*
* A collection of name/value pairs that describe the status of the job execution.
*
*
* @param statusDetails
* A collection of name/value pairs that describe the status of the job execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobExecution withStatusDetails(JobExecutionStatusDetails statusDetails) {
setStatusDetails(statusDetails);
return this;
}
/**
*
* The ARN of the thing on which the job execution is running.
*
*
* @param thingArn
* The ARN of the thing on which the job execution is running.
*/
public void setThingArn(String thingArn) {
this.thingArn = thingArn;
}
/**
*
* The ARN of the thing on which the job execution is running.
*
*
* @return The ARN of the thing on which the job execution is running.
*/
public String getThingArn() {
return this.thingArn;
}
/**
*
* The ARN of the thing on which the job execution is running.
*
*
* @param thingArn
* The ARN of the thing on which the job execution is running.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobExecution withThingArn(String thingArn) {
setThingArn(thingArn);
return this;
}
/**
*
* The time, in seconds since the epoch, when the job execution was queued.
*
*
* @param queuedAt
* The time, in seconds since the epoch, when the job execution was queued.
*/
public void setQueuedAt(java.util.Date queuedAt) {
this.queuedAt = queuedAt;
}
/**
*
* The time, in seconds since the epoch, when the job execution was queued.
*
*
* @return The time, in seconds since the epoch, when the job execution was queued.
*/
public java.util.Date getQueuedAt() {
return this.queuedAt;
}
/**
*
* The time, in seconds since the epoch, when the job execution was queued.
*
*
* @param queuedAt
* The time, in seconds since the epoch, when the job execution was queued.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobExecution withQueuedAt(java.util.Date queuedAt) {
setQueuedAt(queuedAt);
return this;
}
/**
*
* The time, in seconds since the epoch, when the job execution started.
*
*
* @param startedAt
* The time, in seconds since the epoch, when the job execution started.
*/
public void setStartedAt(java.util.Date startedAt) {
this.startedAt = startedAt;
}
/**
*
* The time, in seconds since the epoch, when the job execution started.
*
*
* @return The time, in seconds since the epoch, when the job execution started.
*/
public java.util.Date getStartedAt() {
return this.startedAt;
}
/**
*
* The time, in seconds since the epoch, when the job execution started.
*
*
* @param startedAt
* The time, in seconds since the epoch, when the job execution started.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobExecution withStartedAt(java.util.Date startedAt) {
setStartedAt(startedAt);
return this;
}
/**
*
* The time, in seconds since the epoch, when the job execution was last updated.
*
*
* @param lastUpdatedAt
* The time, in seconds since the epoch, when the job execution was last updated.
*/
public void setLastUpdatedAt(java.util.Date lastUpdatedAt) {
this.lastUpdatedAt = lastUpdatedAt;
}
/**
*
* The time, in seconds since the epoch, when the job execution was last updated.
*
*
* @return The time, in seconds since the epoch, when the job execution was last updated.
*/
public java.util.Date getLastUpdatedAt() {
return this.lastUpdatedAt;
}
/**
*
* The time, in seconds since the epoch, when the job execution was last updated.
*
*
* @param lastUpdatedAt
* The time, in seconds since the epoch, when the job execution was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobExecution withLastUpdatedAt(java.util.Date lastUpdatedAt) {
setLastUpdatedAt(lastUpdatedAt);
return this;
}
/**
*
* A string (consisting of the digits "0" through "9") which identifies this particular job execution on this
* particular device. It can be used in commands which return or update job execution information.
*
*
* @param executionNumber
* A string (consisting of the digits "0" through "9") which identifies this particular job execution on this
* particular device. It can be used in commands which return or update job execution information.
*/
public void setExecutionNumber(Long executionNumber) {
this.executionNumber = executionNumber;
}
/**
*
* A string (consisting of the digits "0" through "9") which identifies this particular job execution on this
* particular device. It can be used in commands which return or update job execution information.
*
*
* @return A string (consisting of the digits "0" through "9") which identifies this particular job execution on
* this particular device. It can be used in commands which return or update job execution information.
*/
public Long getExecutionNumber() {
return this.executionNumber;
}
/**
*
* A string (consisting of the digits "0" through "9") which identifies this particular job execution on this
* particular device. It can be used in commands which return or update job execution information.
*
*
* @param executionNumber
* A string (consisting of the digits "0" through "9") which identifies this particular job execution on this
* particular device. It can be used in commands which return or update job execution information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobExecution withExecutionNumber(Long executionNumber) {
setExecutionNumber(executionNumber);
return this;
}
/**
*
* The version of the job execution. Job execution versions are incremented each time they are updated by a device.
*
*
* @param versionNumber
* The version of the job execution. Job execution versions are incremented each time they are updated by a
* device.
*/
public void setVersionNumber(Long versionNumber) {
this.versionNumber = versionNumber;
}
/**
*
* The version of the job execution. Job execution versions are incremented each time they are updated by a device.
*
*
* @return The version of the job execution. Job execution versions are incremented each time they are updated by a
* device.
*/
public Long getVersionNumber() {
return this.versionNumber;
}
/**
*
* The version of the job execution. Job execution versions are incremented each time they are updated by a device.
*
*
* @param versionNumber
* The version of the job execution. Job execution versions are incremented each time they are updated by a
* device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobExecution withVersionNumber(Long versionNumber) {
setVersionNumber(versionNumber);
return this;
}
/**
*
* The estimated number of seconds that remain before the job execution status will be changed to
* TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes).
* The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will
* not be included if the job execution has reached a terminal status.
*
*
* @param approximateSecondsBeforeTimedOut
* The estimated number of seconds that remain before the job execution status will be changed to
* TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080
* minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration.
* This value will not be included if the job execution has reached a terminal status.
*/
public void setApproximateSecondsBeforeTimedOut(Long approximateSecondsBeforeTimedOut) {
this.approximateSecondsBeforeTimedOut = approximateSecondsBeforeTimedOut;
}
/**
*
* The estimated number of seconds that remain before the job execution status will be changed to
* TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes).
* The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will
* not be included if the job execution has reached a terminal status.
*
*
* @return The estimated number of seconds that remain before the job execution status will be changed to
* TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080
* minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration.
* This value will not be included if the job execution has reached a terminal status.
*/
public Long getApproximateSecondsBeforeTimedOut() {
return this.approximateSecondsBeforeTimedOut;
}
/**
*
* The estimated number of seconds that remain before the job execution status will be changed to
* TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes).
* The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will
* not be included if the job execution has reached a terminal status.
*
*
* @param approximateSecondsBeforeTimedOut
* The estimated number of seconds that remain before the job execution status will be changed to
* TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080
* minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration.
* This value will not be included if the job execution has reached a terminal status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobExecution withApproximateSecondsBeforeTimedOut(Long approximateSecondsBeforeTimedOut) {
setApproximateSecondsBeforeTimedOut(approximateSecondsBeforeTimedOut);
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 (getJobId() != null)
sb.append("JobId: ").append(getJobId()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getForceCanceled() != null)
sb.append("ForceCanceled: ").append(getForceCanceled()).append(",");
if (getStatusDetails() != null)
sb.append("StatusDetails: ").append(getStatusDetails()).append(",");
if (getThingArn() != null)
sb.append("ThingArn: ").append(getThingArn()).append(",");
if (getQueuedAt() != null)
sb.append("QueuedAt: ").append(getQueuedAt()).append(",");
if (getStartedAt() != null)
sb.append("StartedAt: ").append(getStartedAt()).append(",");
if (getLastUpdatedAt() != null)
sb.append("LastUpdatedAt: ").append(getLastUpdatedAt()).append(",");
if (getExecutionNumber() != null)
sb.append("ExecutionNumber: ").append(getExecutionNumber()).append(",");
if (getVersionNumber() != null)
sb.append("VersionNumber: ").append(getVersionNumber()).append(",");
if (getApproximateSecondsBeforeTimedOut() != null)
sb.append("ApproximateSecondsBeforeTimedOut: ").append(getApproximateSecondsBeforeTimedOut());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof JobExecution == false)
return false;
JobExecution other = (JobExecution) obj;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == 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.getForceCanceled() == null ^ this.getForceCanceled() == null)
return false;
if (other.getForceCanceled() != null && other.getForceCanceled().equals(this.getForceCanceled()) == false)
return false;
if (other.getStatusDetails() == null ^ this.getStatusDetails() == null)
return false;
if (other.getStatusDetails() != null && other.getStatusDetails().equals(this.getStatusDetails()) == false)
return false;
if (other.getThingArn() == null ^ this.getThingArn() == null)
return false;
if (other.getThingArn() != null && other.getThingArn().equals(this.getThingArn()) == false)
return false;
if (other.getQueuedAt() == null ^ this.getQueuedAt() == null)
return false;
if (other.getQueuedAt() != null && other.getQueuedAt().equals(this.getQueuedAt()) == false)
return false;
if (other.getStartedAt() == null ^ this.getStartedAt() == null)
return false;
if (other.getStartedAt() != null && other.getStartedAt().equals(this.getStartedAt()) == false)
return false;
if (other.getLastUpdatedAt() == null ^ this.getLastUpdatedAt() == null)
return false;
if (other.getLastUpdatedAt() != null && other.getLastUpdatedAt().equals(this.getLastUpdatedAt()) == false)
return false;
if (other.getExecutionNumber() == null ^ this.getExecutionNumber() == null)
return false;
if (other.getExecutionNumber() != null && other.getExecutionNumber().equals(this.getExecutionNumber()) == false)
return false;
if (other.getVersionNumber() == null ^ this.getVersionNumber() == null)
return false;
if (other.getVersionNumber() != null && other.getVersionNumber().equals(this.getVersionNumber()) == false)
return false;
if (other.getApproximateSecondsBeforeTimedOut() == null ^ this.getApproximateSecondsBeforeTimedOut() == null)
return false;
if (other.getApproximateSecondsBeforeTimedOut() != null
&& other.getApproximateSecondsBeforeTimedOut().equals(this.getApproximateSecondsBeforeTimedOut()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getForceCanceled() == null) ? 0 : getForceCanceled().hashCode());
hashCode = prime * hashCode + ((getStatusDetails() == null) ? 0 : getStatusDetails().hashCode());
hashCode = prime * hashCode + ((getThingArn() == null) ? 0 : getThingArn().hashCode());
hashCode = prime * hashCode + ((getQueuedAt() == null) ? 0 : getQueuedAt().hashCode());
hashCode = prime * hashCode + ((getStartedAt() == null) ? 0 : getStartedAt().hashCode());
hashCode = prime * hashCode + ((getLastUpdatedAt() == null) ? 0 : getLastUpdatedAt().hashCode());
hashCode = prime * hashCode + ((getExecutionNumber() == null) ? 0 : getExecutionNumber().hashCode());
hashCode = prime * hashCode + ((getVersionNumber() == null) ? 0 : getVersionNumber().hashCode());
hashCode = prime * hashCode + ((getApproximateSecondsBeforeTimedOut() == null) ? 0 : getApproximateSecondsBeforeTimedOut().hashCode());
return hashCode;
}
@Override
public JobExecution clone() {
try {
return (JobExecution) 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.iot.model.transform.JobExecutionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}