com.amazonaws.services.elasticmapreduce.model.NotebookExecutionSummary Maven / Gradle / Ivy
/*
* 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.elasticmapreduce.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Details for a notebook execution. The details include information such as the unique ID and status of the notebook
* execution.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class NotebookExecutionSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The unique identifier of the notebook execution.
*
*/
private String notebookExecutionId;
/**
*
* The unique identifier of the editor associated with the notebook execution.
*
*/
private String editorId;
/**
*
* The name of the notebook execution.
*
*/
private String notebookExecutionName;
/**
*
* The status of the notebook execution.
*
*
* -
*
* START_PENDING indicates that the cluster has received the execution request but execution has not
* begun.
*
*
* -
*
* STARTING indicates that the execution is starting on the cluster.
*
*
* -
*
* RUNNING indicates that the execution is being processed by the cluster.
*
*
* -
*
* FINISHING indicates that execution processing is in the final stages.
*
*
* -
*
* FINISHED indicates that the execution has completed without error.
*
*
* -
*
* FAILING indicates that the execution is failing and will not finish successfully.
*
*
* -
*
* FAILED indicates that the execution failed.
*
*
* -
*
* STOP_PENDING indicates that the cluster has received a StopNotebookExecution request
* and the stop is pending.
*
*
* -
*
* STOPPING indicates that the cluster is in the process of stopping the execution as a result of a
* StopNotebookExecution request.
*
*
* -
*
* STOPPED indicates that the execution stopped because of a StopNotebookExecution
* request.
*
*
*
*/
private String status;
/**
*
* The timestamp when notebook execution started.
*
*/
private java.util.Date startTime;
/**
*
* The timestamp when notebook execution started.
*
*/
private java.util.Date endTime;
/**
*
* The unique identifier of the notebook execution.
*
*
* @param notebookExecutionId
* The unique identifier of the notebook execution.
*/
public void setNotebookExecutionId(String notebookExecutionId) {
this.notebookExecutionId = notebookExecutionId;
}
/**
*
* The unique identifier of the notebook execution.
*
*
* @return The unique identifier of the notebook execution.
*/
public String getNotebookExecutionId() {
return this.notebookExecutionId;
}
/**
*
* The unique identifier of the notebook execution.
*
*
* @param notebookExecutionId
* The unique identifier of the notebook execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NotebookExecutionSummary withNotebookExecutionId(String notebookExecutionId) {
setNotebookExecutionId(notebookExecutionId);
return this;
}
/**
*
* The unique identifier of the editor associated with the notebook execution.
*
*
* @param editorId
* The unique identifier of the editor associated with the notebook execution.
*/
public void setEditorId(String editorId) {
this.editorId = editorId;
}
/**
*
* The unique identifier of the editor associated with the notebook execution.
*
*
* @return The unique identifier of the editor associated with the notebook execution.
*/
public String getEditorId() {
return this.editorId;
}
/**
*
* The unique identifier of the editor associated with the notebook execution.
*
*
* @param editorId
* The unique identifier of the editor associated with the notebook execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NotebookExecutionSummary withEditorId(String editorId) {
setEditorId(editorId);
return this;
}
/**
*
* The name of the notebook execution.
*
*
* @param notebookExecutionName
* The name of the notebook execution.
*/
public void setNotebookExecutionName(String notebookExecutionName) {
this.notebookExecutionName = notebookExecutionName;
}
/**
*
* The name of the notebook execution.
*
*
* @return The name of the notebook execution.
*/
public String getNotebookExecutionName() {
return this.notebookExecutionName;
}
/**
*
* The name of the notebook execution.
*
*
* @param notebookExecutionName
* The name of the notebook execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NotebookExecutionSummary withNotebookExecutionName(String notebookExecutionName) {
setNotebookExecutionName(notebookExecutionName);
return this;
}
/**
*
* The status of the notebook execution.
*
*
* -
*
* START_PENDING indicates that the cluster has received the execution request but execution has not
* begun.
*
*
* -
*
* STARTING indicates that the execution is starting on the cluster.
*
*
* -
*
* RUNNING indicates that the execution is being processed by the cluster.
*
*
* -
*
* FINISHING indicates that execution processing is in the final stages.
*
*
* -
*
* FINISHED indicates that the execution has completed without error.
*
*
* -
*
* FAILING indicates that the execution is failing and will not finish successfully.
*
*
* -
*
* FAILED indicates that the execution failed.
*
*
* -
*
* STOP_PENDING indicates that the cluster has received a StopNotebookExecution request
* and the stop is pending.
*
*
* -
*
* STOPPING indicates that the cluster is in the process of stopping the execution as a result of a
* StopNotebookExecution request.
*
*
* -
*
* STOPPED indicates that the execution stopped because of a StopNotebookExecution
* request.
*
*
*
*
* @param status
* The status of the notebook execution.
*
* -
*
* START_PENDING indicates that the cluster has received the execution request but execution has
* not begun.
*
*
* -
*
* STARTING indicates that the execution is starting on the cluster.
*
*
* -
*
* RUNNING indicates that the execution is being processed by the cluster.
*
*
* -
*
* FINISHING indicates that execution processing is in the final stages.
*
*
* -
*
* FINISHED indicates that the execution has completed without error.
*
*
* -
*
* FAILING indicates that the execution is failing and will not finish successfully.
*
*
* -
*
* FAILED indicates that the execution failed.
*
*
* -
*
* STOP_PENDING indicates that the cluster has received a StopNotebookExecution
* request and the stop is pending.
*
*
* -
*
* STOPPING indicates that the cluster is in the process of stopping the execution as a result
* of a StopNotebookExecution request.
*
*
* -
*
* STOPPED indicates that the execution stopped because of a StopNotebookExecution
* request.
*
*
* @see NotebookExecutionStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the notebook execution.
*
*
* -
*
* START_PENDING indicates that the cluster has received the execution request but execution has not
* begun.
*
*
* -
*
* STARTING indicates that the execution is starting on the cluster.
*
*
* -
*
* RUNNING indicates that the execution is being processed by the cluster.
*
*
* -
*
* FINISHING indicates that execution processing is in the final stages.
*
*
* -
*
* FINISHED indicates that the execution has completed without error.
*
*
* -
*
* FAILING indicates that the execution is failing and will not finish successfully.
*
*
* -
*
* FAILED indicates that the execution failed.
*
*
* -
*
* STOP_PENDING indicates that the cluster has received a StopNotebookExecution request
* and the stop is pending.
*
*
* -
*
* STOPPING indicates that the cluster is in the process of stopping the execution as a result of a
* StopNotebookExecution request.
*
*
* -
*
* STOPPED indicates that the execution stopped because of a StopNotebookExecution
* request.
*
*
*
*
* @return The status of the notebook execution.
*
* -
*
* START_PENDING indicates that the cluster has received the execution request but execution
* has not begun.
*
*
* -
*
* STARTING indicates that the execution is starting on the cluster.
*
*
* -
*
* RUNNING indicates that the execution is being processed by the cluster.
*
*
* -
*
* FINISHING indicates that execution processing is in the final stages.
*
*
* -
*
* FINISHED indicates that the execution has completed without error.
*
*
* -
*
* FAILING indicates that the execution is failing and will not finish successfully.
*
*
* -
*
* FAILED indicates that the execution failed.
*
*
* -
*
* STOP_PENDING indicates that the cluster has received a StopNotebookExecution
* request and the stop is pending.
*
*
* -
*
* STOPPING indicates that the cluster is in the process of stopping the execution as a result
* of a StopNotebookExecution request.
*
*
* -
*
* STOPPED indicates that the execution stopped because of a StopNotebookExecution
* request.
*
*
* @see NotebookExecutionStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the notebook execution.
*
*
* -
*
* START_PENDING indicates that the cluster has received the execution request but execution has not
* begun.
*
*
* -
*
* STARTING indicates that the execution is starting on the cluster.
*
*
* -
*
* RUNNING indicates that the execution is being processed by the cluster.
*
*
* -
*
* FINISHING indicates that execution processing is in the final stages.
*
*
* -
*
* FINISHED indicates that the execution has completed without error.
*
*
* -
*
* FAILING indicates that the execution is failing and will not finish successfully.
*
*
* -
*
* FAILED indicates that the execution failed.
*
*
* -
*
* STOP_PENDING indicates that the cluster has received a StopNotebookExecution request
* and the stop is pending.
*
*
* -
*
* STOPPING indicates that the cluster is in the process of stopping the execution as a result of a
* StopNotebookExecution request.
*
*
* -
*
* STOPPED indicates that the execution stopped because of a StopNotebookExecution
* request.
*
*
*
*
* @param status
* The status of the notebook execution.
*
* -
*
* START_PENDING indicates that the cluster has received the execution request but execution has
* not begun.
*
*
* -
*
* STARTING indicates that the execution is starting on the cluster.
*
*
* -
*
* RUNNING indicates that the execution is being processed by the cluster.
*
*
* -
*
* FINISHING indicates that execution processing is in the final stages.
*
*
* -
*
* FINISHED indicates that the execution has completed without error.
*
*
* -
*
* FAILING indicates that the execution is failing and will not finish successfully.
*
*
* -
*
* FAILED indicates that the execution failed.
*
*
* -
*
* STOP_PENDING indicates that the cluster has received a StopNotebookExecution
* request and the stop is pending.
*
*
* -
*
* STOPPING indicates that the cluster is in the process of stopping the execution as a result
* of a StopNotebookExecution request.
*
*
* -
*
* STOPPED indicates that the execution stopped because of a StopNotebookExecution
* request.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see NotebookExecutionStatus
*/
public NotebookExecutionSummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the notebook execution.
*
*
* -
*
* START_PENDING indicates that the cluster has received the execution request but execution has not
* begun.
*
*
* -
*
* STARTING indicates that the execution is starting on the cluster.
*
*
* -
*
* RUNNING indicates that the execution is being processed by the cluster.
*
*
* -
*
* FINISHING indicates that execution processing is in the final stages.
*
*
* -
*
* FINISHED indicates that the execution has completed without error.
*
*
* -
*
* FAILING indicates that the execution is failing and will not finish successfully.
*
*
* -
*
* FAILED indicates that the execution failed.
*
*
* -
*
* STOP_PENDING indicates that the cluster has received a StopNotebookExecution request
* and the stop is pending.
*
*
* -
*
* STOPPING indicates that the cluster is in the process of stopping the execution as a result of a
* StopNotebookExecution request.
*
*
* -
*
* STOPPED indicates that the execution stopped because of a StopNotebookExecution
* request.
*
*
*
*
* @param status
* The status of the notebook execution.
*
* -
*
* START_PENDING indicates that the cluster has received the execution request but execution has
* not begun.
*
*
* -
*
* STARTING indicates that the execution is starting on the cluster.
*
*
* -
*
* RUNNING indicates that the execution is being processed by the cluster.
*
*
* -
*
* FINISHING indicates that execution processing is in the final stages.
*
*
* -
*
* FINISHED indicates that the execution has completed without error.
*
*
* -
*
* FAILING indicates that the execution is failing and will not finish successfully.
*
*
* -
*
* FAILED indicates that the execution failed.
*
*
* -
*
* STOP_PENDING indicates that the cluster has received a StopNotebookExecution
* request and the stop is pending.
*
*
* -
*
* STOPPING indicates that the cluster is in the process of stopping the execution as a result
* of a StopNotebookExecution request.
*
*
* -
*
* STOPPED indicates that the execution stopped because of a StopNotebookExecution
* request.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see NotebookExecutionStatus
*/
public NotebookExecutionSummary withStatus(NotebookExecutionStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The timestamp when notebook execution started.
*
*
* @param startTime
* The timestamp when notebook execution started.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The timestamp when notebook execution started.
*
*
* @return The timestamp when notebook execution started.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The timestamp when notebook execution started.
*
*
* @param startTime
* The timestamp when notebook execution started.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NotebookExecutionSummary withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The timestamp when notebook execution started.
*
*
* @param endTime
* The timestamp when notebook execution started.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The timestamp when notebook execution started.
*
*
* @return The timestamp when notebook execution started.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The timestamp when notebook execution started.
*
*
* @param endTime
* The timestamp when notebook execution started.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NotebookExecutionSummary withEndTime(java.util.Date endTime) {
setEndTime(endTime);
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 (getNotebookExecutionId() != null)
sb.append("NotebookExecutionId: ").append(getNotebookExecutionId()).append(",");
if (getEditorId() != null)
sb.append("EditorId: ").append(getEditorId()).append(",");
if (getNotebookExecutionName() != null)
sb.append("NotebookExecutionName: ").append(getNotebookExecutionName()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof NotebookExecutionSummary == false)
return false;
NotebookExecutionSummary other = (NotebookExecutionSummary) obj;
if (other.getNotebookExecutionId() == null ^ this.getNotebookExecutionId() == null)
return false;
if (other.getNotebookExecutionId() != null && other.getNotebookExecutionId().equals(this.getNotebookExecutionId()) == false)
return false;
if (other.getEditorId() == null ^ this.getEditorId() == null)
return false;
if (other.getEditorId() != null && other.getEditorId().equals(this.getEditorId()) == false)
return false;
if (other.getNotebookExecutionName() == null ^ this.getNotebookExecutionName() == null)
return false;
if (other.getNotebookExecutionName() != null && other.getNotebookExecutionName().equals(this.getNotebookExecutionName()) == 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.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNotebookExecutionId() == null) ? 0 : getNotebookExecutionId().hashCode());
hashCode = prime * hashCode + ((getEditorId() == null) ? 0 : getEditorId().hashCode());
hashCode = prime * hashCode + ((getNotebookExecutionName() == null) ? 0 : getNotebookExecutionName().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
return hashCode;
}
@Override
public NotebookExecutionSummary clone() {
try {
return (NotebookExecutionSummary) 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.elasticmapreduce.model.transform.NotebookExecutionSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}