com.amazonaws.services.apigateway.model.GetExportRequest 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.apigateway.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Request a new export of a RestApi for a particular Stage.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetExportRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The string identifier of the associated RestApi.
*
*/
private String restApiId;
/**
*
* The name of the Stage that will be exported.
*
*/
private String stageName;
/**
*
* The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
*
*/
private String exportType;
/**
*
* A key-value map of query string parameters that specify properties of the export, depending on the requested
* exportType. For exportType oas30 and swagger, any combination
* of the following parameters are supported: extensions='integrations' or
* extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions.
* extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions.
* postman will export the API with Postman extensions, allowing for import to the Postman tool
*
*/
private java.util.Map parameters;
/**
*
* The content-type of the export, for example application/json. Currently
* application/json and application/yaml are supported for exportType of
* oas30 and swagger. This should be specified in the Accept header for
* direct API requests.
*
*/
private String accepts;
/**
*
* The string identifier of the associated RestApi.
*
*
* @param restApiId
* The string identifier of the associated RestApi.
*/
public void setRestApiId(String restApiId) {
this.restApiId = restApiId;
}
/**
*
* The string identifier of the associated RestApi.
*
*
* @return The string identifier of the associated RestApi.
*/
public String getRestApiId() {
return this.restApiId;
}
/**
*
* The string identifier of the associated RestApi.
*
*
* @param restApiId
* The string identifier of the associated RestApi.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetExportRequest withRestApiId(String restApiId) {
setRestApiId(restApiId);
return this;
}
/**
*
* The name of the Stage that will be exported.
*
*
* @param stageName
* The name of the Stage that will be exported.
*/
public void setStageName(String stageName) {
this.stageName = stageName;
}
/**
*
* The name of the Stage that will be exported.
*
*
* @return The name of the Stage that will be exported.
*/
public String getStageName() {
return this.stageName;
}
/**
*
* The name of the Stage that will be exported.
*
*
* @param stageName
* The name of the Stage that will be exported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetExportRequest withStageName(String stageName) {
setStageName(stageName);
return this;
}
/**
*
* The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
*
*
* @param exportType
* The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
*/
public void setExportType(String exportType) {
this.exportType = exportType;
}
/**
*
* The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
*
*
* @return The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI
* 2.0.
*/
public String getExportType() {
return this.exportType;
}
/**
*
* The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
*
*
* @param exportType
* The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetExportRequest withExportType(String exportType) {
setExportType(exportType);
return this;
}
/**
*
* A key-value map of query string parameters that specify properties of the export, depending on the requested
* exportType. For exportType oas30 and swagger, any combination
* of the following parameters are supported: extensions='integrations' or
* extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions.
* extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions.
* postman will export the API with Postman extensions, allowing for import to the Postman tool
*
*
* @return A key-value map of query string parameters that specify properties of the export, depending on the
* requested exportType. For exportType oas30 and
* swagger, any combination of the following parameters are supported:
* extensions='integrations' or extensions='apigateway' will export the API with
* x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API
* with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman
* extensions, allowing for import to the Postman tool
*/
public java.util.Map getParameters() {
return parameters;
}
/**
*
* A key-value map of query string parameters that specify properties of the export, depending on the requested
* exportType. For exportType oas30 and swagger, any combination
* of the following parameters are supported: extensions='integrations' or
* extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions.
* extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions.
* postman will export the API with Postman extensions, allowing for import to the Postman tool
*
*
* @param parameters
* A key-value map of query string parameters that specify properties of the export, depending on the
* requested exportType. For exportType oas30 and swagger
* , any combination of the following parameters are supported: extensions='integrations' or
* extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions.
* extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions.
* postman will export the API with Postman extensions, allowing for import to the Postman tool
*/
public void setParameters(java.util.Map parameters) {
this.parameters = parameters;
}
/**
*
* A key-value map of query string parameters that specify properties of the export, depending on the requested
* exportType. For exportType oas30 and swagger, any combination
* of the following parameters are supported: extensions='integrations' or
* extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions.
* extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions.
* postman will export the API with Postman extensions, allowing for import to the Postman tool
*
*
* @param parameters
* A key-value map of query string parameters that specify properties of the export, depending on the
* requested exportType. For exportType oas30 and swagger
* , any combination of the following parameters are supported: extensions='integrations' or
* extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions.
* extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions.
* postman will export the API with Postman extensions, allowing for import to the Postman tool
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetExportRequest withParameters(java.util.Map parameters) {
setParameters(parameters);
return this;
}
/**
* Add a single Parameters entry
*
* @see GetExportRequest#withParameters
* @returns a reference to this object so that method calls can be chained together.
*/
public GetExportRequest 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetExportRequest clearParametersEntries() {
this.parameters = null;
return this;
}
/**
*
* The content-type of the export, for example application/json. Currently
* application/json and application/yaml are supported for exportType of
* oas30 and swagger. This should be specified in the Accept header for
* direct API requests.
*
*
* @param accepts
* The content-type of the export, for example application/json. Currently
* application/json and application/yaml are supported for exportType
* ofoas30 and swagger. This should be specified in the Accept header
* for direct API requests.
*/
public void setAccepts(String accepts) {
this.accepts = accepts;
}
/**
*
* The content-type of the export, for example application/json. Currently
* application/json and application/yaml are supported for exportType of
* oas30 and swagger. This should be specified in the Accept header for
* direct API requests.
*
*
* @return The content-type of the export, for example application/json. Currently
* application/json and application/yaml are supported for exportType
* ofoas30 and swagger. This should be specified in the Accept header
* for direct API requests.
*/
public String getAccepts() {
return this.accepts;
}
/**
*
* The content-type of the export, for example application/json. Currently
* application/json and application/yaml are supported for exportType of
* oas30 and swagger. This should be specified in the Accept header for
* direct API requests.
*
*
* @param accepts
* The content-type of the export, for example application/json. Currently
* application/json and application/yaml are supported for exportType
* ofoas30 and swagger. This should be specified in the Accept header
* for direct API requests.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetExportRequest withAccepts(String accepts) {
setAccepts(accepts);
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 (getRestApiId() != null)
sb.append("RestApiId: ").append(getRestApiId()).append(",");
if (getStageName() != null)
sb.append("StageName: ").append(getStageName()).append(",");
if (getExportType() != null)
sb.append("ExportType: ").append(getExportType()).append(",");
if (getParameters() != null)
sb.append("Parameters: ").append(getParameters()).append(",");
if (getAccepts() != null)
sb.append("Accepts: ").append(getAccepts());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetExportRequest == false)
return false;
GetExportRequest other = (GetExportRequest) obj;
if (other.getRestApiId() == null ^ this.getRestApiId() == null)
return false;
if (other.getRestApiId() != null && other.getRestApiId().equals(this.getRestApiId()) == false)
return false;
if (other.getStageName() == null ^ this.getStageName() == null)
return false;
if (other.getStageName() != null && other.getStageName().equals(this.getStageName()) == false)
return false;
if (other.getExportType() == null ^ this.getExportType() == null)
return false;
if (other.getExportType() != null && other.getExportType().equals(this.getExportType()) == 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.getAccepts() == null ^ this.getAccepts() == null)
return false;
if (other.getAccepts() != null && other.getAccepts().equals(this.getAccepts()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRestApiId() == null) ? 0 : getRestApiId().hashCode());
hashCode = prime * hashCode + ((getStageName() == null) ? 0 : getStageName().hashCode());
hashCode = prime * hashCode + ((getExportType() == null) ? 0 : getExportType().hashCode());
hashCode = prime * hashCode + ((getParameters() == null) ? 0 : getParameters().hashCode());
hashCode = prime * hashCode + ((getAccepts() == null) ? 0 : getAccepts().hashCode());
return hashCode;
}
@Override
public GetExportRequest clone() {
return (GetExportRequest) super.clone();
}
}