com.amazonaws.services.athena.model.ImportNotebookRequest 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.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ImportNotebookRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the Spark enabled workgroup to import the notebook to.
*
*/
private String workGroup;
/**
*
* The name of the notebook to import.
*
*/
private String name;
/**
*
* The notebook content to be imported. The payload must be in ipynb format.
*
*/
private String payload;
/**
*
* The notebook content type. Currently, the only valid type is IPYNB.
*
*/
private String type;
/**
*
* A URI that specifies the Amazon S3 location of a notebook file in ipynb format.
*
*/
private String notebookS3LocationUri;
/**
*
* A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only
* once).
*
*
*
* This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK
* for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web
* Services CLI, you must provide this token or the action will fail.
*
*
*/
private String clientRequestToken;
/**
*
* The name of the Spark enabled workgroup to import the notebook to.
*
*
* @param workGroup
* The name of the Spark enabled workgroup to import the notebook to.
*/
public void setWorkGroup(String workGroup) {
this.workGroup = workGroup;
}
/**
*
* The name of the Spark enabled workgroup to import the notebook to.
*
*
* @return The name of the Spark enabled workgroup to import the notebook to.
*/
public String getWorkGroup() {
return this.workGroup;
}
/**
*
* The name of the Spark enabled workgroup to import the notebook to.
*
*
* @param workGroup
* The name of the Spark enabled workgroup to import the notebook to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportNotebookRequest withWorkGroup(String workGroup) {
setWorkGroup(workGroup);
return this;
}
/**
*
* The name of the notebook to import.
*
*
* @param name
* The name of the notebook to import.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the notebook to import.
*
*
* @return The name of the notebook to import.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the notebook to import.
*
*
* @param name
* The name of the notebook to import.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportNotebookRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The notebook content to be imported. The payload must be in ipynb format.
*
*
* @param payload
* The notebook content to be imported. The payload must be in ipynb format.
*/
public void setPayload(String payload) {
this.payload = payload;
}
/**
*
* The notebook content to be imported. The payload must be in ipynb format.
*
*
* @return The notebook content to be imported. The payload must be in ipynb format.
*/
public String getPayload() {
return this.payload;
}
/**
*
* The notebook content to be imported. The payload must be in ipynb format.
*
*
* @param payload
* The notebook content to be imported. The payload must be in ipynb format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportNotebookRequest withPayload(String payload) {
setPayload(payload);
return this;
}
/**
*
* The notebook content type. Currently, the only valid type is IPYNB.
*
*
* @param type
* The notebook content type. Currently, the only valid type is IPYNB.
* @see NotebookType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The notebook content type. Currently, the only valid type is IPYNB.
*
*
* @return The notebook content type. Currently, the only valid type is IPYNB.
* @see NotebookType
*/
public String getType() {
return this.type;
}
/**
*
* The notebook content type. Currently, the only valid type is IPYNB.
*
*
* @param type
* The notebook content type. Currently, the only valid type is IPYNB.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NotebookType
*/
public ImportNotebookRequest withType(String type) {
setType(type);
return this;
}
/**
*
* The notebook content type. Currently, the only valid type is IPYNB.
*
*
* @param type
* The notebook content type. Currently, the only valid type is IPYNB.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NotebookType
*/
public ImportNotebookRequest withType(NotebookType type) {
this.type = type.toString();
return this;
}
/**
*
* A URI that specifies the Amazon S3 location of a notebook file in ipynb format.
*
*
* @param notebookS3LocationUri
* A URI that specifies the Amazon S3 location of a notebook file in ipynb format.
*/
public void setNotebookS3LocationUri(String notebookS3LocationUri) {
this.notebookS3LocationUri = notebookS3LocationUri;
}
/**
*
* A URI that specifies the Amazon S3 location of a notebook file in ipynb format.
*
*
* @return A URI that specifies the Amazon S3 location of a notebook file in ipynb format.
*/
public String getNotebookS3LocationUri() {
return this.notebookS3LocationUri;
}
/**
*
* A URI that specifies the Amazon S3 location of a notebook file in ipynb format.
*
*
* @param notebookS3LocationUri
* A URI that specifies the Amazon S3 location of a notebook file in ipynb format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportNotebookRequest withNotebookS3LocationUri(String notebookS3LocationUri) {
setNotebookS3LocationUri(notebookS3LocationUri);
return this;
}
/**
*
* A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only
* once).
*
*
*
* This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK
* for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web
* Services CLI, you must provide this token or the action will fail.
*
*
*
* @param clientRequestToken
* A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes
* only once).
*
* This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services
* SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the
* Amazon Web Services CLI, you must provide this token or the action will fail.
*
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
/**
*
* A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only
* once).
*
*
*
* This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK
* for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web
* Services CLI, you must provide this token or the action will fail.
*
*
*
* @return A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes
* only once).
*
* This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web
* Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK
* or the Amazon Web Services CLI, you must provide this token or the action will fail.
*
*/
public String getClientRequestToken() {
return this.clientRequestToken;
}
/**
*
* A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only
* once).
*
*
*
* This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK
* for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web
* Services CLI, you must provide this token or the action will fail.
*
*
*
* @param clientRequestToken
* A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes
* only once).
*
* This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services
* SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the
* Amazon Web Services CLI, you must provide this token or the action will fail.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportNotebookRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
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 (getWorkGroup() != null)
sb.append("WorkGroup: ").append(getWorkGroup()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getPayload() != null)
sb.append("Payload: ").append(getPayload()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getNotebookS3LocationUri() != null)
sb.append("NotebookS3LocationUri: ").append(getNotebookS3LocationUri()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ImportNotebookRequest == false)
return false;
ImportNotebookRequest other = (ImportNotebookRequest) obj;
if (other.getWorkGroup() == null ^ this.getWorkGroup() == null)
return false;
if (other.getWorkGroup() != null && other.getWorkGroup().equals(this.getWorkGroup()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getPayload() == null ^ this.getPayload() == null)
return false;
if (other.getPayload() != null && other.getPayload().equals(this.getPayload()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getNotebookS3LocationUri() == null ^ this.getNotebookS3LocationUri() == null)
return false;
if (other.getNotebookS3LocationUri() != null && other.getNotebookS3LocationUri().equals(this.getNotebookS3LocationUri()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getWorkGroup() == null) ? 0 : getWorkGroup().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getPayload() == null) ? 0 : getPayload().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getNotebookS3LocationUri() == null) ? 0 : getNotebookS3LocationUri().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
return hashCode;
}
@Override
public ImportNotebookRequest clone() {
return (ImportNotebookRequest) super.clone();
}
}