/* * 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; /** *

* A gateway response of a given response type and status code, with optional response parameters and mapping templates. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class PutGatewayResponseResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable { /** *

* The response type of the associated GatewayResponse. *

*/ private String responseType; /** *

* The HTTP status code for this GatewayResponse. *

*/ private String statusCode; /** *

* Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of * key-value pairs. *

*/ private java.util.Map responseParameters; /** *

* Response templates of the GatewayResponse as a string-to-string map of key-value pairs. *

*/ private java.util.Map responseTemplates; /** *

* A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or * not (false). A default gateway response is one generated by API Gateway without any customization by * an API developer. *

*/ private Boolean defaultResponse; /** *

* The response type of the associated GatewayResponse. *

* * @param responseType * The response type of the associated GatewayResponse. * @see GatewayResponseType */ public void setResponseType(String responseType) { this.responseType = responseType; } /** *

* The response type of the associated GatewayResponse. *

* * @return The response type of the associated GatewayResponse. * @see GatewayResponseType */ public String getResponseType() { return this.responseType; } /** *

* The response type of the associated GatewayResponse. *

* * @param responseType * The response type of the associated GatewayResponse. * @return Returns a reference to this object so that method calls can be chained together. * @see GatewayResponseType */ public PutGatewayResponseResult withResponseType(String responseType) { setResponseType(responseType); return this; } /** *

* The response type of the associated GatewayResponse. *

* * @param responseType * The response type of the associated GatewayResponse. * @see GatewayResponseType */ public void setResponseType(GatewayResponseType responseType) { withResponseType(responseType); } /** *

* The response type of the associated GatewayResponse. *

* * @param responseType * The response type of the associated GatewayResponse. * @return Returns a reference to this object so that method calls can be chained together. * @see GatewayResponseType */ public PutGatewayResponseResult withResponseType(GatewayResponseType responseType) { this.responseType = responseType.toString(); return this; } /** *

* The HTTP status code for this GatewayResponse. *

* * @param statusCode * The HTTP status code for this GatewayResponse. */ public void setStatusCode(String statusCode) { this.statusCode = statusCode; } /** *

* The HTTP status code for this GatewayResponse. *

* * @return The HTTP status code for this GatewayResponse. */ public String getStatusCode() { return this.statusCode; } /** *

* The HTTP status code for this GatewayResponse. *

* * @param statusCode * The HTTP status code for this GatewayResponse. * @return Returns a reference to this object so that method calls can be chained together. */ public PutGatewayResponseResult withStatusCode(String statusCode) { setStatusCode(statusCode); return this; } /** *

* Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of * key-value pairs. *

* * @return Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map * of key-value pairs. */ public java.util.Map getResponseParameters() { return responseParameters; } /** *

* Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of * key-value pairs. *

* * @param responseParameters * Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of * key-value pairs. */ public void setResponseParameters(java.util.Map responseParameters) { this.responseParameters = responseParameters; } /** *

* Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of * key-value pairs. *

* * @param responseParameters * Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of * key-value pairs. * @return Returns a reference to this object so that method calls can be chained together. */ public PutGatewayResponseResult withResponseParameters(java.util.Map responseParameters) { setResponseParameters(responseParameters); return this; } /** * Add a single ResponseParameters entry * * @see PutGatewayResponseResult#withResponseParameters * @returns a reference to this object so that method calls can be chained together. */ public PutGatewayResponseResult addResponseParametersEntry(String key, String value) { if (null == this.responseParameters) { this.responseParameters = new java.util.HashMap(); } if (this.responseParameters.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.responseParameters.put(key, value); return this; } /** * Removes all the entries added into ResponseParameters. * * @return Returns a reference to this object so that method calls can be chained together. */ public PutGatewayResponseResult clearResponseParametersEntries() { this.responseParameters = null; return this; } /** *

* Response templates of the GatewayResponse as a string-to-string map of key-value pairs. *

* * @return Response templates of the GatewayResponse as a string-to-string map of key-value pairs. */ public java.util.Map getResponseTemplates() { return responseTemplates; } /** *

* Response templates of the GatewayResponse as a string-to-string map of key-value pairs. *

* * @param responseTemplates * Response templates of the GatewayResponse as a string-to-string map of key-value pairs. */ public void setResponseTemplates(java.util.Map responseTemplates) { this.responseTemplates = responseTemplates; } /** *

* Response templates of the GatewayResponse as a string-to-string map of key-value pairs. *

* * @param responseTemplates * Response templates of the GatewayResponse as a string-to-string map of key-value pairs. * @return Returns a reference to this object so that method calls can be chained together. */ public PutGatewayResponseResult withResponseTemplates(java.util.Map responseTemplates) { setResponseTemplates(responseTemplates); return this; } /** * Add a single ResponseTemplates entry * * @see PutGatewayResponseResult#withResponseTemplates * @returns a reference to this object so that method calls can be chained together. */ public PutGatewayResponseResult addResponseTemplatesEntry(String key, String value) { if (null == this.responseTemplates) { this.responseTemplates = new java.util.HashMap(); } if (this.responseTemplates.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.responseTemplates.put(key, value); return this; } /** * Removes all the entries added into ResponseTemplates. * * @return Returns a reference to this object so that method calls can be chained together. */ public PutGatewayResponseResult clearResponseTemplatesEntries() { this.responseTemplates = null; return this; } /** *

* A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or * not (false). A default gateway response is one generated by API Gateway without any customization by * an API developer. *

* * @param defaultResponse * A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true * ) or not (false). A default gateway response is one generated by API Gateway without any * customization by an API developer. */ public void setDefaultResponse(Boolean defaultResponse) { this.defaultResponse = defaultResponse; } /** *

* A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or * not (false). A default gateway response is one generated by API Gateway without any customization by * an API developer. *

* * @return A Boolean flag to indicate whether this GatewayResponse is the default gateway response ( * true) or not (false). A default gateway response is one generated by API * Gateway without any customization by an API developer. */ public Boolean getDefaultResponse() { return this.defaultResponse; } /** *

* A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or * not (false). A default gateway response is one generated by API Gateway without any customization by * an API developer. *

* * @param defaultResponse * A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true * ) or not (false). A default gateway response is one generated by API Gateway without any * customization by an API developer. * @return Returns a reference to this object so that method calls can be chained together. */ public PutGatewayResponseResult withDefaultResponse(Boolean defaultResponse) { setDefaultResponse(defaultResponse); return this; } /** *

* A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or * not (false). A default gateway response is one generated by API Gateway without any customization by * an API developer. *

* * @return A Boolean flag to indicate whether this GatewayResponse is the default gateway response ( * true) or not (false). A default gateway response is one generated by API * Gateway without any customization by an API developer. */ public Boolean isDefaultResponse() { return this.defaultResponse; } /** * 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 (getResponseType() != null) sb.append("ResponseType: ").append(getResponseType()).append(","); if (getStatusCode() != null) sb.append("StatusCode: ").append(getStatusCode()).append(","); if (getResponseParameters() != null) sb.append("ResponseParameters: ").append(getResponseParameters()).append(","); if (getResponseTemplates() != null) sb.append("ResponseTemplates: ").append(getResponseTemplates()).append(","); if (getDefaultResponse() != null) sb.append("DefaultResponse: ").append(getDefaultResponse()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof PutGatewayResponseResult == false) return false; PutGatewayResponseResult other = (PutGatewayResponseResult) obj; if (other.getResponseType() == null ^ this.getResponseType() == null) return false; if (other.getResponseType() != null && other.getResponseType().equals(this.getResponseType()) == false) return false; if (other.getStatusCode() == null ^ this.getStatusCode() == null) return false; if (other.getStatusCode() != null && other.getStatusCode().equals(this.getStatusCode()) == false) return false; if (other.getResponseParameters() == null ^ this.getResponseParameters() == null) return false; if (other.getResponseParameters() != null && other.getResponseParameters().equals(this.getResponseParameters()) == false) return false; if (other.getResponseTemplates() == null ^ this.getResponseTemplates() == null) return false; if (other.getResponseTemplates() != null && other.getResponseTemplates().equals(this.getResponseTemplates()) == false) return false; if (other.getDefaultResponse() == null ^ this.getDefaultResponse() == null) return false; if (other.getDefaultResponse() != null && other.getDefaultResponse().equals(this.getDefaultResponse()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getResponseType() == null) ? 0 : getResponseType().hashCode()); hashCode = prime * hashCode + ((getStatusCode() == null) ? 0 : getStatusCode().hashCode()); hashCode = prime * hashCode + ((getResponseParameters() == null) ? 0 : getResponseParameters().hashCode()); hashCode = prime * hashCode + ((getResponseTemplates() == null) ? 0 : getResponseTemplates().hashCode()); hashCode = prime * hashCode + ((getDefaultResponse() == null) ? 0 : getDefaultResponse().hashCode()); return hashCode; } @Override public PutGatewayResponseResult clone() { try { return (PutGatewayResponseResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }