com.amazonaws.services.apigateway.model.ImportRestApiRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-api-gateway Show documentation
/*
* Copyright 2011-2016 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.apigateway.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* A POST request to import an API to Amazon API Gateway using an input of an API definition file.
*
*/
public class ImportRestApiRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A query parameter to indicate whether to rollback the API creation (true) or not (false
* ) when a warning is encountered. The default value is false.
*
*/
private Boolean failOnWarnings;
/**
*
* Custom header parameters as part of the request.
*
*/
private java.util.Map parameters;
/**
*
* The POST request body containing external API definitions. Currently, only Swagger definition JSON files are
* supported.
*
*/
private java.nio.ByteBuffer body;
/**
*
* A query parameter to indicate whether to rollback the API creation (true) or not (false
* ) when a warning is encountered. The default value is false.
*
*
* @param failOnWarnings
* A query parameter to indicate whether to rollback the API creation (true) or not (
* false) when a warning is encountered. The default value is false.
*/
public void setFailOnWarnings(Boolean failOnWarnings) {
this.failOnWarnings = failOnWarnings;
}
/**
*
* A query parameter to indicate whether to rollback the API creation (true) or not (false
* ) when a warning is encountered. The default value is false.
*
*
* @return A query parameter to indicate whether to rollback the API creation (true) or not (
* false) when a warning is encountered. The default value is false.
*/
public Boolean getFailOnWarnings() {
return this.failOnWarnings;
}
/**
*
* A query parameter to indicate whether to rollback the API creation (true) or not (false
* ) when a warning is encountered. The default value is false.
*
*
* @param failOnWarnings
* A query parameter to indicate whether to rollback the API creation (true) or not (
* false) when a warning is encountered. The default value is false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportRestApiRequest withFailOnWarnings(Boolean failOnWarnings) {
setFailOnWarnings(failOnWarnings);
return this;
}
/**
*
* A query parameter to indicate whether to rollback the API creation (true) or not (false
* ) when a warning is encountered. The default value is false.
*
*
* @return A query parameter to indicate whether to rollback the API creation (true) or not (
* false) when a warning is encountered. The default value is false.
*/
public Boolean isFailOnWarnings() {
return this.failOnWarnings;
}
/**
*
* Custom header parameters as part of the request.
*
*
* @return Custom header parameters as part of the request.
*/
public java.util.Map getParameters() {
return parameters;
}
/**
*
* Custom header parameters as part of the request.
*
*
* @param parameters
* Custom header parameters as part of the request.
*/
public void setParameters(java.util.Map parameters) {
this.parameters = parameters;
}
/**
*
* Custom header parameters as part of the request.
*
*
* @param parameters
* Custom header parameters as part of the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportRestApiRequest withParameters(java.util.Map parameters) {
setParameters(parameters);
return this;
}
public ImportRestApiRequest addParametersEntry(String key, String value) {
if (null == this.parameters) {
this.parameters = new java.util.HashMap();
}
if (this.parameters.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.parameters.put(key, value);
return this;
}
/**
* Removes all the entries added into Parameters. <p> Returns a reference to this object so that method calls can
* be chained together.
*/
public ImportRestApiRequest clearParametersEntries() {
this.parameters = null;
return this;
}
/**
*
* The POST request body containing external API definitions. Currently, only Swagger definition JSON files are
* supported.
*
*
* AWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param body
* The POST request body containing external API definitions. Currently, only Swagger definition JSON files
* are supported.
*/
public void setBody(java.nio.ByteBuffer body) {
this.body = body;
}
/**
*
* The POST request body containing external API definitions. Currently, only Swagger definition JSON files are
* supported.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return The POST request body containing external API definitions. Currently, only Swagger definition JSON files
* are supported.
*/
public java.nio.ByteBuffer getBody() {
return this.body;
}
/**
*
* The POST request body containing external API definitions. Currently, only Swagger definition JSON files are
* supported.
*
*
* @param body
* The POST request body containing external API definitions. Currently, only Swagger definition JSON files
* are supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportRestApiRequest withBody(java.nio.ByteBuffer body) {
setBody(body);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFailOnWarnings() != null)
sb.append("FailOnWarnings: " + getFailOnWarnings() + ",");
if (getParameters() != null)
sb.append("Parameters: " + getParameters() + ",");
if (getBody() != null)
sb.append("Body: " + getBody());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ImportRestApiRequest == false)
return false;
ImportRestApiRequest other = (ImportRestApiRequest) obj;
if (other.getFailOnWarnings() == null ^ this.getFailOnWarnings() == null)
return false;
if (other.getFailOnWarnings() != null && other.getFailOnWarnings().equals(this.getFailOnWarnings()) == false)
return false;
if (other.getParameters() == null ^ this.getParameters() == null)
return false;
if (other.getParameters() != null && other.getParameters().equals(this.getParameters()) == false)
return false;
if (other.getBody() == null ^ this.getBody() == null)
return false;
if (other.getBody() != null && other.getBody().equals(this.getBody()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFailOnWarnings() == null) ? 0 : getFailOnWarnings().hashCode());
hashCode = prime * hashCode + ((getParameters() == null) ? 0 : getParameters().hashCode());
hashCode = prime * hashCode + ((getBody() == null) ? 0 : getBody().hashCode());
return hashCode;
}
@Override
public ImportRestApiRequest clone() {
return (ImportRestApiRequest) super.clone();
}
}