com.amazonaws.services.apigateway.model.GetUsagePlanKeysRequest 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;
/**
*
* The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
*
*/
public class GetUsagePlanKeysRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved
* UsagePlanKey resource representing a plan customer.
*
*/
private String usagePlanId;
/**
*
* A query parameter specifying the zero-based index specifying the position of a usage plan key.
*
*/
private String position;
/**
*
* A query parameter specifying the maximum number usage plan keys returned by the GET request.
*
*/
private Integer limit;
/**
*
* A query parameter specifying the name of the to-be-returned usage plan keys.
*
*/
private String nameQuery;
/**
*
* The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved
* UsagePlanKey resource representing a plan customer.
*
*
* @param usagePlanId
* The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved
* UsagePlanKey resource representing a plan customer.
*/
public void setUsagePlanId(String usagePlanId) {
this.usagePlanId = usagePlanId;
}
/**
*
* The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved
* UsagePlanKey resource representing a plan customer.
*
*
* @return The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved
* UsagePlanKey resource representing a plan customer.
*/
public String getUsagePlanId() {
return this.usagePlanId;
}
/**
*
* The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved
* UsagePlanKey resource representing a plan customer.
*
*
* @param usagePlanId
* The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved
* UsagePlanKey resource representing a plan customer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetUsagePlanKeysRequest withUsagePlanId(String usagePlanId) {
setUsagePlanId(usagePlanId);
return this;
}
/**
*
* A query parameter specifying the zero-based index specifying the position of a usage plan key.
*
*
* @param position
* A query parameter specifying the zero-based index specifying the position of a usage plan key.
*/
public void setPosition(String position) {
this.position = position;
}
/**
*
* A query parameter specifying the zero-based index specifying the position of a usage plan key.
*
*
* @return A query parameter specifying the zero-based index specifying the position of a usage plan key.
*/
public String getPosition() {
return this.position;
}
/**
*
* A query parameter specifying the zero-based index specifying the position of a usage plan key.
*
*
* @param position
* A query parameter specifying the zero-based index specifying the position of a usage plan key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetUsagePlanKeysRequest withPosition(String position) {
setPosition(position);
return this;
}
/**
*
* A query parameter specifying the maximum number usage plan keys returned by the GET request.
*
*
* @param limit
* A query parameter specifying the maximum number usage plan keys returned by the GET request.
*/
public void setLimit(Integer limit) {
this.limit = limit;
}
/**
*
* A query parameter specifying the maximum number usage plan keys returned by the GET request.
*
*
* @return A query parameter specifying the maximum number usage plan keys returned by the GET request.
*/
public Integer getLimit() {
return this.limit;
}
/**
*
* A query parameter specifying the maximum number usage plan keys returned by the GET request.
*
*
* @param limit
* A query parameter specifying the maximum number usage plan keys returned by the GET request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetUsagePlanKeysRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
*
* A query parameter specifying the name of the to-be-returned usage plan keys.
*
*
* @param nameQuery
* A query parameter specifying the name of the to-be-returned usage plan keys.
*/
public void setNameQuery(String nameQuery) {
this.nameQuery = nameQuery;
}
/**
*
* A query parameter specifying the name of the to-be-returned usage plan keys.
*
*
* @return A query parameter specifying the name of the to-be-returned usage plan keys.
*/
public String getNameQuery() {
return this.nameQuery;
}
/**
*
* A query parameter specifying the name of the to-be-returned usage plan keys.
*
*
* @param nameQuery
* A query parameter specifying the name of the to-be-returned usage plan keys.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetUsagePlanKeysRequest withNameQuery(String nameQuery) {
setNameQuery(nameQuery);
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 (getUsagePlanId() != null)
sb.append("UsagePlanId: " + getUsagePlanId() + ",");
if (getPosition() != null)
sb.append("Position: " + getPosition() + ",");
if (getLimit() != null)
sb.append("Limit: " + getLimit() + ",");
if (getNameQuery() != null)
sb.append("NameQuery: " + getNameQuery());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetUsagePlanKeysRequest == false)
return false;
GetUsagePlanKeysRequest other = (GetUsagePlanKeysRequest) obj;
if (other.getUsagePlanId() == null ^ this.getUsagePlanId() == null)
return false;
if (other.getUsagePlanId() != null && other.getUsagePlanId().equals(this.getUsagePlanId()) == false)
return false;
if (other.getPosition() == null ^ this.getPosition() == null)
return false;
if (other.getPosition() != null && other.getPosition().equals(this.getPosition()) == false)
return false;
if (other.getLimit() == null ^ this.getLimit() == null)
return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false)
return false;
if (other.getNameQuery() == null ^ this.getNameQuery() == null)
return false;
if (other.getNameQuery() != null && other.getNameQuery().equals(this.getNameQuery()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUsagePlanId() == null) ? 0 : getUsagePlanId().hashCode());
hashCode = prime * hashCode + ((getPosition() == null) ? 0 : getPosition().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getNameQuery() == null) ? 0 : getNameQuery().hashCode());
return hashCode;
}
@Override
public GetUsagePlanKeysRequest clone() {
return (GetUsagePlanKeysRequest) super.clone();
}
}