com.amazonaws.services.athena.model.CalculationStatus Maven / Gradle / Ivy
Show all versions of aws-java-sdk-athena Show documentation
/*
* 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.athena.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains information about the status of a notebook calculation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CalculationStatus implements Serializable, Cloneable, StructuredPojo {
/**
*
* The date and time the calculation was submitted for processing.
*
*/
private java.util.Date submissionDateTime;
/**
*
* The date and time the calculation completed processing.
*
*/
private java.util.Date completionDateTime;
/**
*
* The state of the calculation execution. A description of each state follows.
*
*
* CREATING - The calculation is in the process of being created.
*
*
* CREATED - The calculation has been created and is ready to run.
*
*
* QUEUED - The calculation has been queued for processing.
*
*
* RUNNING - The calculation is running.
*
*
* CANCELING - A request to cancel the calculation has been received and the system is working to stop
* it.
*
*
* CANCELED - The calculation is no longer running as the result of a cancel request.
*
*
* COMPLETED - The calculation has completed without error.
*
*
* FAILED - The calculation failed and is no longer running.
*
*/
private String state;
/**
*
* The reason for the calculation state change (for example, the calculation was canceled because the session was
* terminated).
*
*/
private String stateChangeReason;
/**
*
* The date and time the calculation was submitted for processing.
*
*
* @param submissionDateTime
* The date and time the calculation was submitted for processing.
*/
public void setSubmissionDateTime(java.util.Date submissionDateTime) {
this.submissionDateTime = submissionDateTime;
}
/**
*
* The date and time the calculation was submitted for processing.
*
*
* @return The date and time the calculation was submitted for processing.
*/
public java.util.Date getSubmissionDateTime() {
return this.submissionDateTime;
}
/**
*
* The date and time the calculation was submitted for processing.
*
*
* @param submissionDateTime
* The date and time the calculation was submitted for processing.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CalculationStatus withSubmissionDateTime(java.util.Date submissionDateTime) {
setSubmissionDateTime(submissionDateTime);
return this;
}
/**
*
* The date and time the calculation completed processing.
*
*
* @param completionDateTime
* The date and time the calculation completed processing.
*/
public void setCompletionDateTime(java.util.Date completionDateTime) {
this.completionDateTime = completionDateTime;
}
/**
*
* The date and time the calculation completed processing.
*
*
* @return The date and time the calculation completed processing.
*/
public java.util.Date getCompletionDateTime() {
return this.completionDateTime;
}
/**
*
* The date and time the calculation completed processing.
*
*
* @param completionDateTime
* The date and time the calculation completed processing.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CalculationStatus withCompletionDateTime(java.util.Date completionDateTime) {
setCompletionDateTime(completionDateTime);
return this;
}
/**
*
* The state of the calculation execution. A description of each state follows.
*
*
* CREATING - The calculation is in the process of being created.
*
*
* CREATED - The calculation has been created and is ready to run.
*
*
* QUEUED - The calculation has been queued for processing.
*
*
* RUNNING - The calculation is running.
*
*
* CANCELING - A request to cancel the calculation has been received and the system is working to stop
* it.
*
*
* CANCELED - The calculation is no longer running as the result of a cancel request.
*
*
* COMPLETED - The calculation has completed without error.
*
*
* FAILED - The calculation failed and is no longer running.
*
*
* @param state
* The state of the calculation execution. A description of each state follows.
*
* CREATING - The calculation is in the process of being created.
*
*
* CREATED - The calculation has been created and is ready to run.
*
*
* QUEUED - The calculation has been queued for processing.
*
*
* RUNNING - The calculation is running.
*
*
* CANCELING - A request to cancel the calculation has been received and the system is working
* to stop it.
*
*
* CANCELED - The calculation is no longer running as the result of a cancel request.
*
*
* COMPLETED - The calculation has completed without error.
*
*
* FAILED - The calculation failed and is no longer running.
* @see CalculationExecutionState
*/
public void setState(String state) {
this.state = state;
}
/**
*
* The state of the calculation execution. A description of each state follows.
*
*
* CREATING - The calculation is in the process of being created.
*
*
* CREATED - The calculation has been created and is ready to run.
*
*
* QUEUED - The calculation has been queued for processing.
*
*
* RUNNING - The calculation is running.
*
*
* CANCELING - A request to cancel the calculation has been received and the system is working to stop
* it.
*
*
* CANCELED - The calculation is no longer running as the result of a cancel request.
*
*
* COMPLETED - The calculation has completed without error.
*
*
* FAILED - The calculation failed and is no longer running.
*
*
* @return The state of the calculation execution. A description of each state follows.
*
* CREATING - The calculation is in the process of being created.
*
*
* CREATED - The calculation has been created and is ready to run.
*
*
* QUEUED - The calculation has been queued for processing.
*
*
* RUNNING - The calculation is running.
*
*
* CANCELING - A request to cancel the calculation has been received and the system is working
* to stop it.
*
*
* CANCELED - The calculation is no longer running as the result of a cancel request.
*
*
* COMPLETED - The calculation has completed without error.
*
*
* FAILED - The calculation failed and is no longer running.
* @see CalculationExecutionState
*/
public String getState() {
return this.state;
}
/**
*
* The state of the calculation execution. A description of each state follows.
*
*
* CREATING - The calculation is in the process of being created.
*
*
* CREATED - The calculation has been created and is ready to run.
*
*
* QUEUED - The calculation has been queued for processing.
*
*
* RUNNING - The calculation is running.
*
*
* CANCELING - A request to cancel the calculation has been received and the system is working to stop
* it.
*
*
* CANCELED - The calculation is no longer running as the result of a cancel request.
*
*
* COMPLETED - The calculation has completed without error.
*
*
* FAILED - The calculation failed and is no longer running.
*
*
* @param state
* The state of the calculation execution. A description of each state follows.
*
* CREATING - The calculation is in the process of being created.
*
*
* CREATED - The calculation has been created and is ready to run.
*
*
* QUEUED - The calculation has been queued for processing.
*
*
* RUNNING - The calculation is running.
*
*
* CANCELING - A request to cancel the calculation has been received and the system is working
* to stop it.
*
*
* CANCELED - The calculation is no longer running as the result of a cancel request.
*
*
* COMPLETED - The calculation has completed without error.
*
*
* FAILED - The calculation failed and is no longer running.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CalculationExecutionState
*/
public CalculationStatus withState(String state) {
setState(state);
return this;
}
/**
*
* The state of the calculation execution. A description of each state follows.
*
*
* CREATING - The calculation is in the process of being created.
*
*
* CREATED - The calculation has been created and is ready to run.
*
*
* QUEUED - The calculation has been queued for processing.
*
*
* RUNNING - The calculation is running.
*
*
* CANCELING - A request to cancel the calculation has been received and the system is working to stop
* it.
*
*
* CANCELED - The calculation is no longer running as the result of a cancel request.
*
*
* COMPLETED - The calculation has completed without error.
*
*
* FAILED - The calculation failed and is no longer running.
*
*
* @param state
* The state of the calculation execution. A description of each state follows.
*
* CREATING - The calculation is in the process of being created.
*
*
* CREATED - The calculation has been created and is ready to run.
*
*
* QUEUED - The calculation has been queued for processing.
*
*
* RUNNING - The calculation is running.
*
*
* CANCELING - A request to cancel the calculation has been received and the system is working
* to stop it.
*
*
* CANCELED - The calculation is no longer running as the result of a cancel request.
*
*
* COMPLETED - The calculation has completed without error.
*
*
* FAILED - The calculation failed and is no longer running.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CalculationExecutionState
*/
public CalculationStatus withState(CalculationExecutionState state) {
this.state = state.toString();
return this;
}
/**
*
* The reason for the calculation state change (for example, the calculation was canceled because the session was
* terminated).
*
*
* @param stateChangeReason
* The reason for the calculation state change (for example, the calculation was canceled because the session
* was terminated).
*/
public void setStateChangeReason(String stateChangeReason) {
this.stateChangeReason = stateChangeReason;
}
/**
*
* The reason for the calculation state change (for example, the calculation was canceled because the session was
* terminated).
*
*
* @return The reason for the calculation state change (for example, the calculation was canceled because the
* session was terminated).
*/
public String getStateChangeReason() {
return this.stateChangeReason;
}
/**
*
* The reason for the calculation state change (for example, the calculation was canceled because the session was
* terminated).
*
*
* @param stateChangeReason
* The reason for the calculation state change (for example, the calculation was canceled because the session
* was terminated).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CalculationStatus withStateChangeReason(String stateChangeReason) {
setStateChangeReason(stateChangeReason);
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 (getSubmissionDateTime() != null)
sb.append("SubmissionDateTime: ").append(getSubmissionDateTime()).append(",");
if (getCompletionDateTime() != null)
sb.append("CompletionDateTime: ").append(getCompletionDateTime()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getStateChangeReason() != null)
sb.append("StateChangeReason: ").append(getStateChangeReason());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CalculationStatus == false)
return false;
CalculationStatus other = (CalculationStatus) obj;
if (other.getSubmissionDateTime() == null ^ this.getSubmissionDateTime() == null)
return false;
if (other.getSubmissionDateTime() != null && other.getSubmissionDateTime().equals(this.getSubmissionDateTime()) == false)
return false;
if (other.getCompletionDateTime() == null ^ this.getCompletionDateTime() == null)
return false;
if (other.getCompletionDateTime() != null && other.getCompletionDateTime().equals(this.getCompletionDateTime()) == false)
return false;
if (other.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == false)
return false;
if (other.getStateChangeReason() == null ^ this.getStateChangeReason() == null)
return false;
if (other.getStateChangeReason() != null && other.getStateChangeReason().equals(this.getStateChangeReason()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSubmissionDateTime() == null) ? 0 : getSubmissionDateTime().hashCode());
hashCode = prime * hashCode + ((getCompletionDateTime() == null) ? 0 : getCompletionDateTime().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getStateChangeReason() == null) ? 0 : getStateChangeReason().hashCode());
return hashCode;
}
@Override
public CalculationStatus clone() {
try {
return (CalculationStatus) 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.athena.model.transform.CalculationStatusMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}