com.amazonaws.services.elasticmapreduce.model.ListNotebookExecutionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-emr Show documentation
/*
* Copyright 2017-2022 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.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListNotebookExecutionsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The unique ID of the editor associated with the notebook execution.
*
*/
private String editorId;
/**
*
* The status filter for listing notebook executions.
*
*
* -
*
* 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 beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
*
*/
private java.util.Date from;
/**
*
* The end of time range filter for listing notebook executions. The default is the current timestamp.
*
*/
private java.util.Date to;
/**
*
* The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start
* of the list for this ListNotebookExecutions call.
*
*/
private String marker;
/**
*
* The unique ID of the editor associated with the notebook execution.
*
*
* @param editorId
* The unique ID of the editor associated with the notebook execution.
*/
public void setEditorId(String editorId) {
this.editorId = editorId;
}
/**
*
* The unique ID of the editor associated with the notebook execution.
*
*
* @return The unique ID of the editor associated with the notebook execution.
*/
public String getEditorId() {
return this.editorId;
}
/**
*
* The unique ID of the editor associated with the notebook execution.
*
*
* @param editorId
* The unique ID of the editor associated with the notebook execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListNotebookExecutionsRequest withEditorId(String editorId) {
setEditorId(editorId);
return this;
}
/**
*
* The status filter for listing notebook executions.
*
*
* -
*
* 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 filter for listing notebook executions.
*
* -
*
* 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 filter for listing notebook executions.
*
*
* -
*
* 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 filter for listing notebook executions.
*
* -
*
* 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 filter for listing notebook executions.
*
*
* -
*
* 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 filter for listing notebook executions.
*
* -
*
* 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 ListNotebookExecutionsRequest withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status filter for listing notebook executions.
*
*
* -
*
* 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 filter for listing notebook executions.
*
* -
*
* 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 ListNotebookExecutionsRequest withStatus(NotebookExecutionStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
*
*
* @param from
* The beginning of time range filter for listing notebook executions. The default is the timestamp of 30
* days ago.
*/
public void setFrom(java.util.Date from) {
this.from = from;
}
/**
*
* The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
*
*
* @return The beginning of time range filter for listing notebook executions. The default is the timestamp of 30
* days ago.
*/
public java.util.Date getFrom() {
return this.from;
}
/**
*
* The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
*
*
* @param from
* The beginning of time range filter for listing notebook executions. The default is the timestamp of 30
* days ago.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListNotebookExecutionsRequest withFrom(java.util.Date from) {
setFrom(from);
return this;
}
/**
*
* The end of time range filter for listing notebook executions. The default is the current timestamp.
*
*
* @param to
* The end of time range filter for listing notebook executions. The default is the current timestamp.
*/
public void setTo(java.util.Date to) {
this.to = to;
}
/**
*
* The end of time range filter for listing notebook executions. The default is the current timestamp.
*
*
* @return The end of time range filter for listing notebook executions. The default is the current timestamp.
*/
public java.util.Date getTo() {
return this.to;
}
/**
*
* The end of time range filter for listing notebook executions. The default is the current timestamp.
*
*
* @param to
* The end of time range filter for listing notebook executions. The default is the current timestamp.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListNotebookExecutionsRequest withTo(java.util.Date to) {
setTo(to);
return this;
}
/**
*
* The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start
* of the list for this ListNotebookExecutions call.
*
*
* @param marker
* The pagination token, returned by a previous ListNotebookExecutions call, that indicates the
* start of the list for this ListNotebookExecutions call.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start
* of the list for this ListNotebookExecutions call.
*
*
* @return The pagination token, returned by a previous ListNotebookExecutions call, that indicates the
* start of the list for this ListNotebookExecutions call.
*/
public String getMarker() {
return this.marker;
}
/**
*
* The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start
* of the list for this ListNotebookExecutions call.
*
*
* @param marker
* The pagination token, returned by a previous ListNotebookExecutions call, that indicates the
* start of the list for this ListNotebookExecutions call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListNotebookExecutionsRequest withMarker(String marker) {
setMarker(marker);
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 (getEditorId() != null)
sb.append("EditorId: ").append(getEditorId()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getFrom() != null)
sb.append("From: ").append(getFrom()).append(",");
if (getTo() != null)
sb.append("To: ").append(getTo()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListNotebookExecutionsRequest == false)
return false;
ListNotebookExecutionsRequest other = (ListNotebookExecutionsRequest) obj;
if (other.getEditorId() == null ^ this.getEditorId() == null)
return false;
if (other.getEditorId() != null && other.getEditorId().equals(this.getEditorId()) == 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.getFrom() == null ^ this.getFrom() == null)
return false;
if (other.getFrom() != null && other.getFrom().equals(this.getFrom()) == false)
return false;
if (other.getTo() == null ^ this.getTo() == null)
return false;
if (other.getTo() != null && other.getTo().equals(this.getTo()) == false)
return false;
if (other.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEditorId() == null) ? 0 : getEditorId().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getFrom() == null) ? 0 : getFrom().hashCode());
hashCode = prime * hashCode + ((getTo() == null) ? 0 : getTo().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@Override
public ListNotebookExecutionsRequest clone() {
return (ListNotebookExecutionsRequest) super.clone();
}
}