com.amazonaws.services.elasticmapreduce.model.StartNotebookExecutionRequest 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 StartNotebookExecutionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The unique identifier of the EMR Notebook to use for notebook execution.
*
*/
private String editorId;
/**
*
* The path and file name of the notebook file for this execution, relative to the path specified for the EMR
* Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an EMR
* Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this
* request), and you specify a RelativePath of
* my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution
* is
* s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
* .
*
*/
private String relativePath;
/**
*
* An optional name for the notebook execution.
*
*/
private String notebookExecutionName;
/**
*
* Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
*
*/
private String notebookParams;
/**
*
* Specifies the execution engine (cluster) that runs the notebook execution.
*
*/
private ExecutionEngineConfig executionEngine;
/**
*
* The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the notebook
* execution.
*
*/
private String serviceRole;
/**
*
* The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this notebook
* execution.
*
*/
private String notebookInstanceSecurityGroupId;
/**
*
* A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a
* required key string with a maximum of 128 characters and an optional value string with a maximum of 256
* characters.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* The unique identifier of the EMR Notebook to use for notebook execution.
*
*
* @param editorId
* The unique identifier of the EMR Notebook to use for notebook execution.
*/
public void setEditorId(String editorId) {
this.editorId = editorId;
}
/**
*
* The unique identifier of the EMR Notebook to use for notebook execution.
*
*
* @return The unique identifier of the EMR Notebook to use for notebook execution.
*/
public String getEditorId() {
return this.editorId;
}
/**
*
* The unique identifier of the EMR Notebook to use for notebook execution.
*
*
* @param editorId
* The unique identifier of the EMR Notebook to use for notebook execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartNotebookExecutionRequest withEditorId(String editorId) {
setEditorId(editorId);
return this;
}
/**
*
* The path and file name of the notebook file for this execution, relative to the path specified for the EMR
* Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an EMR
* Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this
* request), and you specify a RelativePath of
* my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution
* is
* s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
* .
*
*
* @param relativePath
* The path and file name of the notebook file for this execution, relative to the path specified for the EMR
* Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an
* EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the
* EditorID of this request), and you specify a RelativePath of
* my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook
* execution is
* s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
* .
*/
public void setRelativePath(String relativePath) {
this.relativePath = relativePath;
}
/**
*
* The path and file name of the notebook file for this execution, relative to the path specified for the EMR
* Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an EMR
* Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this
* request), and you specify a RelativePath of
* my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution
* is
* s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
* .
*
*
* @return The path and file name of the notebook file for this execution, relative to the path specified for the
* EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you
* create an EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the
* EditorID of this request), and you specify a RelativePath of
* my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook
* execution is
* s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
* .
*/
public String getRelativePath() {
return this.relativePath;
}
/**
*
* The path and file name of the notebook file for this execution, relative to the path specified for the EMR
* Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an EMR
* Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this
* request), and you specify a RelativePath of
* my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution
* is
* s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
* .
*
*
* @param relativePath
* The path and file name of the notebook file for this execution, relative to the path specified for the EMR
* Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an
* EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the
* EditorID of this request), and you specify a RelativePath of
* my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook
* execution is
* s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartNotebookExecutionRequest withRelativePath(String relativePath) {
setRelativePath(relativePath);
return this;
}
/**
*
* An optional name for the notebook execution.
*
*
* @param notebookExecutionName
* An optional name for the notebook execution.
*/
public void setNotebookExecutionName(String notebookExecutionName) {
this.notebookExecutionName = notebookExecutionName;
}
/**
*
* An optional name for the notebook execution.
*
*
* @return An optional name for the notebook execution.
*/
public String getNotebookExecutionName() {
return this.notebookExecutionName;
}
/**
*
* An optional name for the notebook execution.
*
*
* @param notebookExecutionName
* An optional name for the notebook execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartNotebookExecutionRequest withNotebookExecutionName(String notebookExecutionName) {
setNotebookExecutionName(notebookExecutionName);
return this;
}
/**
*
* Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
*
*
* @param notebookParams
* Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
*/
public void setNotebookParams(String notebookParams) {
this.notebookParams = notebookParams;
}
/**
*
* Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
*
*
* @return Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
*/
public String getNotebookParams() {
return this.notebookParams;
}
/**
*
* Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
*
*
* @param notebookParams
* Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartNotebookExecutionRequest withNotebookParams(String notebookParams) {
setNotebookParams(notebookParams);
return this;
}
/**
*
* Specifies the execution engine (cluster) that runs the notebook execution.
*
*
* @param executionEngine
* Specifies the execution engine (cluster) that runs the notebook execution.
*/
public void setExecutionEngine(ExecutionEngineConfig executionEngine) {
this.executionEngine = executionEngine;
}
/**
*
* Specifies the execution engine (cluster) that runs the notebook execution.
*
*
* @return Specifies the execution engine (cluster) that runs the notebook execution.
*/
public ExecutionEngineConfig getExecutionEngine() {
return this.executionEngine;
}
/**
*
* Specifies the execution engine (cluster) that runs the notebook execution.
*
*
* @param executionEngine
* Specifies the execution engine (cluster) that runs the notebook execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartNotebookExecutionRequest withExecutionEngine(ExecutionEngineConfig executionEngine) {
setExecutionEngine(executionEngine);
return this;
}
/**
*
* The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the notebook
* execution.
*
*
* @param serviceRole
* The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the
* notebook execution.
*/
public void setServiceRole(String serviceRole) {
this.serviceRole = serviceRole;
}
/**
*
* The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the notebook
* execution.
*
*
* @return The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the
* notebook execution.
*/
public String getServiceRole() {
return this.serviceRole;
}
/**
*
* The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the notebook
* execution.
*
*
* @param serviceRole
* The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the
* notebook execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartNotebookExecutionRequest withServiceRole(String serviceRole) {
setServiceRole(serviceRole);
return this;
}
/**
*
* The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this notebook
* execution.
*
*
* @param notebookInstanceSecurityGroupId
* The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this
* notebook execution.
*/
public void setNotebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId) {
this.notebookInstanceSecurityGroupId = notebookInstanceSecurityGroupId;
}
/**
*
* The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this notebook
* execution.
*
*
* @return The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this
* notebook execution.
*/
public String getNotebookInstanceSecurityGroupId() {
return this.notebookInstanceSecurityGroupId;
}
/**
*
* The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this notebook
* execution.
*
*
* @param notebookInstanceSecurityGroupId
* The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this
* notebook execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartNotebookExecutionRequest withNotebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId) {
setNotebookInstanceSecurityGroupId(notebookInstanceSecurityGroupId);
return this;
}
/**
*
* A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a
* required key string with a maximum of 128 characters and an optional value string with a maximum of 256
* characters.
*
*
* @return A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist
* of a required key string with a maximum of 128 characters and an optional value string with a maximum of
* 256 characters.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a
* required key string with a maximum of 128 characters and an optional value string with a maximum of 256
* characters.
*
*
* @param tags
* A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of
* a required key string with a maximum of 128 characters and an optional value string with a maximum of 256
* characters.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a
* required key string with a maximum of 128 characters and an optional value string with a maximum of 256
* characters.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of
* a required key string with a maximum of 128 characters and an optional value string with a maximum of 256
* characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartNotebookExecutionRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a
* required key string with a maximum of 128 characters and an optional value string with a maximum of 256
* characters.
*
*
* @param tags
* A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of
* a required key string with a maximum of 128 characters and an optional value string with a maximum of 256
* characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartNotebookExecutionRequest withTags(java.util.Collection tags) {
setTags(tags);
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 (getRelativePath() != null)
sb.append("RelativePath: ").append(getRelativePath()).append(",");
if (getNotebookExecutionName() != null)
sb.append("NotebookExecutionName: ").append(getNotebookExecutionName()).append(",");
if (getNotebookParams() != null)
sb.append("NotebookParams: ").append(getNotebookParams()).append(",");
if (getExecutionEngine() != null)
sb.append("ExecutionEngine: ").append(getExecutionEngine()).append(",");
if (getServiceRole() != null)
sb.append("ServiceRole: ").append(getServiceRole()).append(",");
if (getNotebookInstanceSecurityGroupId() != null)
sb.append("NotebookInstanceSecurityGroupId: ").append(getNotebookInstanceSecurityGroupId()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartNotebookExecutionRequest == false)
return false;
StartNotebookExecutionRequest other = (StartNotebookExecutionRequest) obj;
if (other.getEditorId() == null ^ this.getEditorId() == null)
return false;
if (other.getEditorId() != null && other.getEditorId().equals(this.getEditorId()) == false)
return false;
if (other.getRelativePath() == null ^ this.getRelativePath() == null)
return false;
if (other.getRelativePath() != null && other.getRelativePath().equals(this.getRelativePath()) == 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.getNotebookParams() == null ^ this.getNotebookParams() == null)
return false;
if (other.getNotebookParams() != null && other.getNotebookParams().equals(this.getNotebookParams()) == false)
return false;
if (other.getExecutionEngine() == null ^ this.getExecutionEngine() == null)
return false;
if (other.getExecutionEngine() != null && other.getExecutionEngine().equals(this.getExecutionEngine()) == false)
return false;
if (other.getServiceRole() == null ^ this.getServiceRole() == null)
return false;
if (other.getServiceRole() != null && other.getServiceRole().equals(this.getServiceRole()) == false)
return false;
if (other.getNotebookInstanceSecurityGroupId() == null ^ this.getNotebookInstanceSecurityGroupId() == null)
return false;
if (other.getNotebookInstanceSecurityGroupId() != null
&& other.getNotebookInstanceSecurityGroupId().equals(this.getNotebookInstanceSecurityGroupId()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == 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 + ((getRelativePath() == null) ? 0 : getRelativePath().hashCode());
hashCode = prime * hashCode + ((getNotebookExecutionName() == null) ? 0 : getNotebookExecutionName().hashCode());
hashCode = prime * hashCode + ((getNotebookParams() == null) ? 0 : getNotebookParams().hashCode());
hashCode = prime * hashCode + ((getExecutionEngine() == null) ? 0 : getExecutionEngine().hashCode());
hashCode = prime * hashCode + ((getServiceRole() == null) ? 0 : getServiceRole().hashCode());
hashCode = prime * hashCode + ((getNotebookInstanceSecurityGroupId() == null) ? 0 : getNotebookInstanceSecurityGroupId().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public StartNotebookExecutionRequest clone() {
return (StartNotebookExecutionRequest) super.clone();
}
}