com.amazonaws.services.apigateway.model.PutMethodRequest 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;
/**
*
* Request to add a method to an existing Resource resource.
*
*/
public class PutMethodRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The RestApi identifier for the new Method resource.
*
*/
private String restApiId;
/**
*
* The Resource identifier for the new Method resource.
*
*/
private String resourceId;
/**
*
* Specifies the method request's HTTP method type.
*
*/
private String httpMethod;
/**
*
* Specifies the type of authorization used for the method.
*
*/
private String authorizationType;
/**
*
* Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
*
*/
private String authorizerId;
/**
*
* Specifies whether the method required a valid ApiKey.
*
*/
private Boolean apiKeyRequired;
/**
*
* A key-value map defining required or optional method request parameters that can be accepted by Amazon API
* Gateway. A key defines a method request parameter name matching the pattern of
* method.request.{location}.{name}, where location is querystring,
* path, or header and name is a valid and unique parameter name. The value
* associated with the key is a Boolean flag indicating whether the parameter is required (true) or
* optional (false). The method request parameter names defined here are available in
* Integration to be mapped to integration request parameters or body-mapping templates.
*
*/
private java.util.Map requestParameters;
/**
*
* Specifies the Model resources used for the request's content type. Request models are represented as a
* key/value map, with a content type as the key and a Model name as the value.
*
*/
private java.util.Map requestModels;
/**
*
* The RestApi identifier for the new Method resource.
*
*
* @param restApiId
* The RestApi identifier for the new Method resource.
*/
public void setRestApiId(String restApiId) {
this.restApiId = restApiId;
}
/**
*
* The RestApi identifier for the new Method resource.
*
*
* @return The RestApi identifier for the new Method resource.
*/
public String getRestApiId() {
return this.restApiId;
}
/**
*
* The RestApi identifier for the new Method resource.
*
*
* @param restApiId
* The RestApi identifier for the new Method resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutMethodRequest withRestApiId(String restApiId) {
setRestApiId(restApiId);
return this;
}
/**
*
* The Resource identifier for the new Method resource.
*
*
* @param resourceId
* The Resource identifier for the new Method resource.
*/
public void setResourceId(String resourceId) {
this.resourceId = resourceId;
}
/**
*
* The Resource identifier for the new Method resource.
*
*
* @return The Resource identifier for the new Method resource.
*/
public String getResourceId() {
return this.resourceId;
}
/**
*
* The Resource identifier for the new Method resource.
*
*
* @param resourceId
* The Resource identifier for the new Method resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutMethodRequest withResourceId(String resourceId) {
setResourceId(resourceId);
return this;
}
/**
*
* Specifies the method request's HTTP method type.
*
*
* @param httpMethod
* Specifies the method request's HTTP method type.
*/
public void setHttpMethod(String httpMethod) {
this.httpMethod = httpMethod;
}
/**
*
* Specifies the method request's HTTP method type.
*
*
* @return Specifies the method request's HTTP method type.
*/
public String getHttpMethod() {
return this.httpMethod;
}
/**
*
* Specifies the method request's HTTP method type.
*
*
* @param httpMethod
* Specifies the method request's HTTP method type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutMethodRequest withHttpMethod(String httpMethod) {
setHttpMethod(httpMethod);
return this;
}
/**
*
* Specifies the type of authorization used for the method.
*
*
* @param authorizationType
* Specifies the type of authorization used for the method.
*/
public void setAuthorizationType(String authorizationType) {
this.authorizationType = authorizationType;
}
/**
*
* Specifies the type of authorization used for the method.
*
*
* @return Specifies the type of authorization used for the method.
*/
public String getAuthorizationType() {
return this.authorizationType;
}
/**
*
* Specifies the type of authorization used for the method.
*
*
* @param authorizationType
* Specifies the type of authorization used for the method.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutMethodRequest withAuthorizationType(String authorizationType) {
setAuthorizationType(authorizationType);
return this;
}
/**
*
* Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
*
*
* @param authorizerId
* Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
*/
public void setAuthorizerId(String authorizerId) {
this.authorizerId = authorizerId;
}
/**
*
* Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
*
*
* @return Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
*/
public String getAuthorizerId() {
return this.authorizerId;
}
/**
*
* Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
*
*
* @param authorizerId
* Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutMethodRequest withAuthorizerId(String authorizerId) {
setAuthorizerId(authorizerId);
return this;
}
/**
*
* Specifies whether the method required a valid ApiKey.
*
*
* @param apiKeyRequired
* Specifies whether the method required a valid ApiKey.
*/
public void setApiKeyRequired(Boolean apiKeyRequired) {
this.apiKeyRequired = apiKeyRequired;
}
/**
*
* Specifies whether the method required a valid ApiKey.
*
*
* @return Specifies whether the method required a valid ApiKey.
*/
public Boolean getApiKeyRequired() {
return this.apiKeyRequired;
}
/**
*
* Specifies whether the method required a valid ApiKey.
*
*
* @param apiKeyRequired
* Specifies whether the method required a valid ApiKey.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutMethodRequest withApiKeyRequired(Boolean apiKeyRequired) {
setApiKeyRequired(apiKeyRequired);
return this;
}
/**
*
* Specifies whether the method required a valid ApiKey.
*
*
* @return Specifies whether the method required a valid ApiKey.
*/
public Boolean isApiKeyRequired() {
return this.apiKeyRequired;
}
/**
*
* A key-value map defining required or optional method request parameters that can be accepted by Amazon API
* Gateway. A key defines a method request parameter name matching the pattern of
* method.request.{location}.{name}, where location is querystring,
* path, or header and name is a valid and unique parameter name. The value
* associated with the key is a Boolean flag indicating whether the parameter is required (true) or
* optional (false). The method request parameter names defined here are available in
* Integration to be mapped to integration request parameters or body-mapping templates.
*
*
* @return A key-value map defining required or optional method request parameters that can be accepted by Amazon
* API Gateway. A key defines a method request parameter name matching the pattern of
* method.request.{location}.{name}, where location is querystring,
* path, or header and name is a valid and unique parameter name. The
* value associated with the key is a Boolean flag indicating whether the parameter is required (
* true) or optional (false). The method request parameter names defined here are
* available in Integration to be mapped to integration request parameters or body-mapping templates.
*/
public java.util.Map getRequestParameters() {
return requestParameters;
}
/**
*
* A key-value map defining required or optional method request parameters that can be accepted by Amazon API
* Gateway. A key defines a method request parameter name matching the pattern of
* method.request.{location}.{name}, where location is querystring,
* path, or header and name is a valid and unique parameter name. The value
* associated with the key is a Boolean flag indicating whether the parameter is required (true) or
* optional (false). The method request parameter names defined here are available in
* Integration to be mapped to integration request parameters or body-mapping templates.
*
*
* @param requestParameters
* A key-value map defining required or optional method request parameters that can be accepted by Amazon API
* Gateway. A key defines a method request parameter name matching the pattern of
* method.request.{location}.{name}, where location is querystring,
* path, or header and name is a valid and unique parameter name. The
* value associated with the key is a Boolean flag indicating whether the parameter is required (
* true) or optional (false). The method request parameter names defined here are
* available in Integration to be mapped to integration request parameters or body-mapping templates.
*/
public void setRequestParameters(java.util.Map requestParameters) {
this.requestParameters = requestParameters;
}
/**
*
* A key-value map defining required or optional method request parameters that can be accepted by Amazon API
* Gateway. A key defines a method request parameter name matching the pattern of
* method.request.{location}.{name}, where location is querystring,
* path, or header and name is a valid and unique parameter name. The value
* associated with the key is a Boolean flag indicating whether the parameter is required (true) or
* optional (false). The method request parameter names defined here are available in
* Integration to be mapped to integration request parameters or body-mapping templates.
*
*
* @param requestParameters
* A key-value map defining required or optional method request parameters that can be accepted by Amazon API
* Gateway. A key defines a method request parameter name matching the pattern of
* method.request.{location}.{name}, where location is querystring,
* path, or header and name is a valid and unique parameter name. The
* value associated with the key is a Boolean flag indicating whether the parameter is required (
* true) or optional (false). The method request parameter names defined here are
* available in Integration to be mapped to integration request parameters or body-mapping templates.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutMethodRequest withRequestParameters(java.util.Map requestParameters) {
setRequestParameters(requestParameters);
return this;
}
public PutMethodRequest addRequestParametersEntry(String key, Boolean value) {
if (null == this.requestParameters) {
this.requestParameters = new java.util.HashMap();
}
if (this.requestParameters.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.requestParameters.put(key, value);
return this;
}
/**
* Removes all the entries added into RequestParameters. <p> Returns a reference to this object so that method
* calls can be chained together.
*/
public PutMethodRequest clearRequestParametersEntries() {
this.requestParameters = null;
return this;
}
/**
*
* Specifies the Model resources used for the request's content type. Request models are represented as a
* key/value map, with a content type as the key and a Model name as the value.
*
*
* @return Specifies the Model resources used for the request's content type. Request models are represented
* as a key/value map, with a content type as the key and a Model name as the value.
*/
public java.util.Map getRequestModels() {
return requestModels;
}
/**
*
* Specifies the Model resources used for the request's content type. Request models are represented as a
* key/value map, with a content type as the key and a Model name as the value.
*
*
* @param requestModels
* Specifies the Model resources used for the request's content type. Request models are represented
* as a key/value map, with a content type as the key and a Model name as the value.
*/
public void setRequestModels(java.util.Map requestModels) {
this.requestModels = requestModels;
}
/**
*
* Specifies the Model resources used for the request's content type. Request models are represented as a
* key/value map, with a content type as the key and a Model name as the value.
*
*
* @param requestModels
* Specifies the Model resources used for the request's content type. Request models are represented
* as a key/value map, with a content type as the key and a Model name as the value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutMethodRequest withRequestModels(java.util.Map requestModels) {
setRequestModels(requestModels);
return this;
}
public PutMethodRequest addRequestModelsEntry(String key, String value) {
if (null == this.requestModels) {
this.requestModels = new java.util.HashMap();
}
if (this.requestModels.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.requestModels.put(key, value);
return this;
}
/**
* Removes all the entries added into RequestModels. <p> Returns a reference to this object so that method calls
* can be chained together.
*/
public PutMethodRequest clearRequestModelsEntries() {
this.requestModels = null;
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 (getRestApiId() != null)
sb.append("RestApiId: " + getRestApiId() + ",");
if (getResourceId() != null)
sb.append("ResourceId: " + getResourceId() + ",");
if (getHttpMethod() != null)
sb.append("HttpMethod: " + getHttpMethod() + ",");
if (getAuthorizationType() != null)
sb.append("AuthorizationType: " + getAuthorizationType() + ",");
if (getAuthorizerId() != null)
sb.append("AuthorizerId: " + getAuthorizerId() + ",");
if (getApiKeyRequired() != null)
sb.append("ApiKeyRequired: " + getApiKeyRequired() + ",");
if (getRequestParameters() != null)
sb.append("RequestParameters: " + getRequestParameters() + ",");
if (getRequestModels() != null)
sb.append("RequestModels: " + getRequestModels());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutMethodRequest == false)
return false;
PutMethodRequest other = (PutMethodRequest) obj;
if (other.getRestApiId() == null ^ this.getRestApiId() == null)
return false;
if (other.getRestApiId() != null && other.getRestApiId().equals(this.getRestApiId()) == false)
return false;
if (other.getResourceId() == null ^ this.getResourceId() == null)
return false;
if (other.getResourceId() != null && other.getResourceId().equals(this.getResourceId()) == false)
return false;
if (other.getHttpMethod() == null ^ this.getHttpMethod() == null)
return false;
if (other.getHttpMethod() != null && other.getHttpMethod().equals(this.getHttpMethod()) == false)
return false;
if (other.getAuthorizationType() == null ^ this.getAuthorizationType() == null)
return false;
if (other.getAuthorizationType() != null && other.getAuthorizationType().equals(this.getAuthorizationType()) == false)
return false;
if (other.getAuthorizerId() == null ^ this.getAuthorizerId() == null)
return false;
if (other.getAuthorizerId() != null && other.getAuthorizerId().equals(this.getAuthorizerId()) == false)
return false;
if (other.getApiKeyRequired() == null ^ this.getApiKeyRequired() == null)
return false;
if (other.getApiKeyRequired() != null && other.getApiKeyRequired().equals(this.getApiKeyRequired()) == false)
return false;
if (other.getRequestParameters() == null ^ this.getRequestParameters() == null)
return false;
if (other.getRequestParameters() != null && other.getRequestParameters().equals(this.getRequestParameters()) == false)
return false;
if (other.getRequestModels() == null ^ this.getRequestModels() == null)
return false;
if (other.getRequestModels() != null && other.getRequestModels().equals(this.getRequestModels()) == 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 + ((getResourceId() == null) ? 0 : getResourceId().hashCode());
hashCode = prime * hashCode + ((getHttpMethod() == null) ? 0 : getHttpMethod().hashCode());
hashCode = prime * hashCode + ((getAuthorizationType() == null) ? 0 : getAuthorizationType().hashCode());
hashCode = prime * hashCode + ((getAuthorizerId() == null) ? 0 : getAuthorizerId().hashCode());
hashCode = prime * hashCode + ((getApiKeyRequired() == null) ? 0 : getApiKeyRequired().hashCode());
hashCode = prime * hashCode + ((getRequestParameters() == null) ? 0 : getRequestParameters().hashCode());
hashCode = prime * hashCode + ((getRequestModels() == null) ? 0 : getRequestModels().hashCode());
return hashCode;
}
@Override
public PutMethodRequest clone() {
return (PutMethodRequest) super.clone();
}
}