com.amazonaws.services.route53.model.ListGeoLocationsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-route53 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.route53.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* To get a list of geographic locations that Amazon Route 53 supports for geolocation, send a GET request
* to the /Amazon Route 53 API version/geolocations resource. The response to this request includes
* a GeoLocationDetails element for each location that Amazon Route 53 supports.
*
*
* Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country
* (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately
* after the corresponding country.
*
*/
public class ListGeoLocationsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The code for the continent with which you want to start listing locations that Amazon Route 53 supports for
* geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is
* true, and if NextContinentCode from the previous response has a value, enter that value in
* StartContinentCode to return the next page of results.
*
*
* Include StartContinentCode only if you want to list continents. Don't include
* StartContinentCode when you're listing countries or countries with their subdivisions.
*
*/
private String startContinentCode;
/**
*
* The code for the country with which you want to start listing locations that Amazon Route 53 supports for
* geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is
* true, and if NextCountryCode from the previous response has a value, enter that value
* in StartCountryCode to return the next page of results.
*
*
* Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
*
*/
private String startCountryCode;
/**
*
* The code for the subdivision (for example, state or province) with which you want to start listing locations that
* Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if
* IsTruncated is true, and if NextSubdivisionCode from the previous response
* has a value, enter that value in StartSubdivisionCode to return the next page of results.
*
*
* To list subdivisions of a country, you must include both StartCountryCode and
* StartSubdivisionCode.
*
*/
private String startSubdivisionCode;
/**
*
* (Optional) The maximum number of geolocations to be included in the response body for this request. If more than
* MaxItems geolocations remain to be listed, then the value of the IsTruncated element in
* the response is true.
*
*/
private String maxItems;
/**
*
* The code for the continent with which you want to start listing locations that Amazon Route 53 supports for
* geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is
* true, and if NextContinentCode from the previous response has a value, enter that value in
* StartContinentCode to return the next page of results.
*
*
* Include StartContinentCode only if you want to list continents. Don't include
* StartContinentCode when you're listing countries or countries with their subdivisions.
*
*
* @param startContinentCode
* The code for the continent with which you want to start listing locations that Amazon Route 53 supports
* for geolocation. If Amazon Route 53 has already returned a page or more of results, if
* IsTruncated is true, and if NextContinentCode from the previous response has a
* value, enter that value in StartContinentCode to return the next page of results.
*
* Include StartContinentCode only if you want to list continents. Don't include
* StartContinentCode when you're listing countries or countries with their subdivisions.
*/
public void setStartContinentCode(String startContinentCode) {
this.startContinentCode = startContinentCode;
}
/**
*
* The code for the continent with which you want to start listing locations that Amazon Route 53 supports for
* geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is
* true, and if NextContinentCode from the previous response has a value, enter that value in
* StartContinentCode to return the next page of results.
*
*
* Include StartContinentCode only if you want to list continents. Don't include
* StartContinentCode when you're listing countries or countries with their subdivisions.
*
*
* @return The code for the continent with which you want to start listing locations that Amazon Route 53 supports
* for geolocation. If Amazon Route 53 has already returned a page or more of results, if
* IsTruncated is true, and if NextContinentCode from the previous response has a
* value, enter that value in StartContinentCode to return the next page of results.
*
* Include StartContinentCode only if you want to list continents. Don't include
* StartContinentCode when you're listing countries or countries with their subdivisions.
*/
public String getStartContinentCode() {
return this.startContinentCode;
}
/**
*
* The code for the continent with which you want to start listing locations that Amazon Route 53 supports for
* geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is
* true, and if NextContinentCode from the previous response has a value, enter that value in
* StartContinentCode to return the next page of results.
*
*
* Include StartContinentCode only if you want to list continents. Don't include
* StartContinentCode when you're listing countries or countries with their subdivisions.
*
*
* @param startContinentCode
* The code for the continent with which you want to start listing locations that Amazon Route 53 supports
* for geolocation. If Amazon Route 53 has already returned a page or more of results, if
* IsTruncated is true, and if NextContinentCode from the previous response has a
* value, enter that value in StartContinentCode to return the next page of results.
*
* Include StartContinentCode only if you want to list continents. Don't include
* StartContinentCode when you're listing countries or countries with their subdivisions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListGeoLocationsRequest withStartContinentCode(String startContinentCode) {
setStartContinentCode(startContinentCode);
return this;
}
/**
*
* The code for the country with which you want to start listing locations that Amazon Route 53 supports for
* geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is
* true, and if NextCountryCode from the previous response has a value, enter that value
* in StartCountryCode to return the next page of results.
*
*
* Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
*
*
* @param startCountryCode
* The code for the country with which you want to start listing locations that Amazon Route 53 supports for
* geolocation. If Amazon Route 53 has already returned a page or more of results, if
* IsTruncated is true, and if NextCountryCode from the previous
* response has a value, enter that value in StartCountryCode to return the next page of
* results.
*
* Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
*/
public void setStartCountryCode(String startCountryCode) {
this.startCountryCode = startCountryCode;
}
/**
*
* The code for the country with which you want to start listing locations that Amazon Route 53 supports for
* geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is
* true, and if NextCountryCode from the previous response has a value, enter that value
* in StartCountryCode to return the next page of results.
*
*
* Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
*
*
* @return The code for the country with which you want to start listing locations that Amazon Route 53 supports for
* geolocation. If Amazon Route 53 has already returned a page or more of results, if
* IsTruncated is true, and if NextCountryCode from the previous
* response has a value, enter that value in StartCountryCode to return the next page of
* results.
*
* Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
*/
public String getStartCountryCode() {
return this.startCountryCode;
}
/**
*
* The code for the country with which you want to start listing locations that Amazon Route 53 supports for
* geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is
* true, and if NextCountryCode from the previous response has a value, enter that value
* in StartCountryCode to return the next page of results.
*
*
* Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
*
*
* @param startCountryCode
* The code for the country with which you want to start listing locations that Amazon Route 53 supports for
* geolocation. If Amazon Route 53 has already returned a page or more of results, if
* IsTruncated is true, and if NextCountryCode from the previous
* response has a value, enter that value in StartCountryCode to return the next page of
* results.
*
* Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListGeoLocationsRequest withStartCountryCode(String startCountryCode) {
setStartCountryCode(startCountryCode);
return this;
}
/**
*
* The code for the subdivision (for example, state or province) with which you want to start listing locations that
* Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if
* IsTruncated is true, and if NextSubdivisionCode from the previous response
* has a value, enter that value in StartSubdivisionCode to return the next page of results.
*
*
* To list subdivisions of a country, you must include both StartCountryCode and
* StartSubdivisionCode.
*
*
* @param startSubdivisionCode
* The code for the subdivision (for example, state or province) with which you want to start listing
* locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or
* more of results, if IsTruncated is true, and if NextSubdivisionCode
* from the previous response has a value, enter that value in StartSubdivisionCode to return
* the next page of results.
*
* To list subdivisions of a country, you must include both StartCountryCode and
* StartSubdivisionCode.
*/
public void setStartSubdivisionCode(String startSubdivisionCode) {
this.startSubdivisionCode = startSubdivisionCode;
}
/**
*
* The code for the subdivision (for example, state or province) with which you want to start listing locations that
* Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if
* IsTruncated is true, and if NextSubdivisionCode from the previous response
* has a value, enter that value in StartSubdivisionCode to return the next page of results.
*
*
* To list subdivisions of a country, you must include both StartCountryCode and
* StartSubdivisionCode.
*
*
* @return The code for the subdivision (for example, state or province) with which you want to start listing
* locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page
* or more of results, if IsTruncated is true, and if
* NextSubdivisionCode from the previous response has a value, enter that value in
* StartSubdivisionCode to return the next page of results.
*
* To list subdivisions of a country, you must include both StartCountryCode and
* StartSubdivisionCode.
*/
public String getStartSubdivisionCode() {
return this.startSubdivisionCode;
}
/**
*
* The code for the subdivision (for example, state or province) with which you want to start listing locations that
* Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if
* IsTruncated is true, and if NextSubdivisionCode from the previous response
* has a value, enter that value in StartSubdivisionCode to return the next page of results.
*
*
* To list subdivisions of a country, you must include both StartCountryCode and
* StartSubdivisionCode.
*
*
* @param startSubdivisionCode
* The code for the subdivision (for example, state or province) with which you want to start listing
* locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or
* more of results, if IsTruncated is true, and if NextSubdivisionCode
* from the previous response has a value, enter that value in StartSubdivisionCode to return
* the next page of results.
*
* To list subdivisions of a country, you must include both StartCountryCode and
* StartSubdivisionCode.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListGeoLocationsRequest withStartSubdivisionCode(String startSubdivisionCode) {
setStartSubdivisionCode(startSubdivisionCode);
return this;
}
/**
*
* (Optional) The maximum number of geolocations to be included in the response body for this request. If more than
* MaxItems geolocations remain to be listed, then the value of the IsTruncated element in
* the response is true.
*
*
* @param maxItems
* (Optional) The maximum number of geolocations to be included in the response body for this request. If
* more than MaxItems geolocations remain to be listed, then the value of the
* IsTruncated element in the response is true.
*/
public void setMaxItems(String maxItems) {
this.maxItems = maxItems;
}
/**
*
* (Optional) The maximum number of geolocations to be included in the response body for this request. If more than
* MaxItems geolocations remain to be listed, then the value of the IsTruncated element in
* the response is true.
*
*
* @return (Optional) The maximum number of geolocations to be included in the response body for this request. If
* more than MaxItems geolocations remain to be listed, then the value of the
* IsTruncated element in the response is true.
*/
public String getMaxItems() {
return this.maxItems;
}
/**
*
* (Optional) The maximum number of geolocations to be included in the response body for this request. If more than
* MaxItems geolocations remain to be listed, then the value of the IsTruncated element in
* the response is true.
*
*
* @param maxItems
* (Optional) The maximum number of geolocations to be included in the response body for this request. If
* more than MaxItems geolocations remain to be listed, then the value of the
* IsTruncated element in the response is true.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListGeoLocationsRequest withMaxItems(String maxItems) {
setMaxItems(maxItems);
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 (getStartContinentCode() != null)
sb.append("StartContinentCode: " + getStartContinentCode() + ",");
if (getStartCountryCode() != null)
sb.append("StartCountryCode: " + getStartCountryCode() + ",");
if (getStartSubdivisionCode() != null)
sb.append("StartSubdivisionCode: " + getStartSubdivisionCode() + ",");
if (getMaxItems() != null)
sb.append("MaxItems: " + getMaxItems());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListGeoLocationsRequest == false)
return false;
ListGeoLocationsRequest other = (ListGeoLocationsRequest) obj;
if (other.getStartContinentCode() == null ^ this.getStartContinentCode() == null)
return false;
if (other.getStartContinentCode() != null && other.getStartContinentCode().equals(this.getStartContinentCode()) == false)
return false;
if (other.getStartCountryCode() == null ^ this.getStartCountryCode() == null)
return false;
if (other.getStartCountryCode() != null && other.getStartCountryCode().equals(this.getStartCountryCode()) == false)
return false;
if (other.getStartSubdivisionCode() == null ^ this.getStartSubdivisionCode() == null)
return false;
if (other.getStartSubdivisionCode() != null && other.getStartSubdivisionCode().equals(this.getStartSubdivisionCode()) == false)
return false;
if (other.getMaxItems() == null ^ this.getMaxItems() == null)
return false;
if (other.getMaxItems() != null && other.getMaxItems().equals(this.getMaxItems()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStartContinentCode() == null) ? 0 : getStartContinentCode().hashCode());
hashCode = prime * hashCode + ((getStartCountryCode() == null) ? 0 : getStartCountryCode().hashCode());
hashCode = prime * hashCode + ((getStartSubdivisionCode() == null) ? 0 : getStartSubdivisionCode().hashCode());
hashCode = prime * hashCode + ((getMaxItems() == null) ? 0 : getMaxItems().hashCode());
return hashCode;
}
@Override
public ListGeoLocationsRequest clone() {
return (ListGeoLocationsRequest) super.clone();
}
}