/* * Copyright 2012-2017 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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * <p> * Retrieves a list of the public and private hosted zones that are associated with the current AWS account in ASCII * order by domain name. * </p> * * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListHostedZonesByName" target="_top">AWS API * Documentation</a> */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ListHostedZonesByNameRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** * <p> * (Optional) For your first request to <code>ListHostedZonesByName</code>, include the <code>dnsname</code> * parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the * <code>dnsname</code> parameter, Amazon Route 53 returns all of the hosted zones that were created by the current * AWS account, in ASCII order. For subsequent requests, include both <code>dnsname</code> and * <code>hostedzoneid</code> parameters. For <code>dnsname</code>, specify the value of <code>NextDNSName</code> * from the previous response. * </p> */ private String dNSName; /** * <p> * (Optional) For your first request to <code>ListHostedZonesByName</code>, do not include the * <code>hostedzoneid</code> parameter. * </p> * <p> * If you have more hosted zones than the value of <code>maxitems</code>, <code>ListHostedZonesByName</code> returns * only the first <code>maxitems</code> hosted zones. To get the next group of <code>maxitems</code> hosted zones, * submit another request to <code>ListHostedZonesByName</code> and include both <code>dnsname</code> and * <code>hostedzoneid</code> parameters. For the value of <code>hostedzoneid</code>, specify the value of the * <code>NextHostedZoneId</code> element from the previous response. * </p> */ private String hostedZoneId; /** * <p> * The maximum number of hosted zones to be included in the response body for this request. If you have more than * <code>maxitems</code> hosted zones, then the value of the <code>IsTruncated</code> element in the response is * true, and the values of <code>NextDNSName</code> and <code>NextHostedZoneId</code> specify the first hosted zone * in the next group of <code>maxitems</code> hosted zones. * </p> */ private String maxItems; /** * <p> * (Optional) For your first request to <code>ListHostedZonesByName</code>, include the <code>dnsname</code> * parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the * <code>dnsname</code> parameter, Amazon Route 53 returns all of the hosted zones that were created by the current * AWS account, in ASCII order. For subsequent requests, include both <code>dnsname</code> and * <code>hostedzoneid</code> parameters. For <code>dnsname</code>, specify the value of <code>NextDNSName</code> * from the previous response. * </p> * * @param dNSName * (Optional) For your first request to <code>ListHostedZonesByName</code>, include the <code>dnsname</code> * parameter only if you want to specify the name of the first hosted zone in the response. If you don't * include the <code>dnsname</code> parameter, Amazon Route 53 returns all of the hosted zones that were * created by the current AWS account, in ASCII order. For subsequent requests, include both * <code>dnsname</code> and <code>hostedzoneid</code> parameters. For <code>dnsname</code>, specify the value * of <code>NextDNSName</code> from the previous response. */ public void setDNSName(String dNSName) { this.dNSName = dNSName; } /** * <p> * (Optional) For your first request to <code>ListHostedZonesByName</code>, include the <code>dnsname</code> * parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the * <code>dnsname</code> parameter, Amazon Route 53 returns all of the hosted zones that were created by the current * AWS account, in ASCII order. For subsequent requests, include both <code>dnsname</code> and * <code>hostedzoneid</code> parameters. For <code>dnsname</code>, specify the value of <code>NextDNSName</code> * from the previous response. * </p> * * @return (Optional) For your first request to <code>ListHostedZonesByName</code>, include the <code>dnsname</code> * parameter only if you want to specify the name of the first hosted zone in the response. If you don't * include the <code>dnsname</code> parameter, Amazon Route 53 returns all of the hosted zones that were * created by the current AWS account, in ASCII order. For subsequent requests, include both * <code>dnsname</code> and <code>hostedzoneid</code> parameters. For <code>dnsname</code>, specify the * value of <code>NextDNSName</code> from the previous response. */ public String getDNSName() { return this.dNSName; } /** * <p> * (Optional) For your first request to <code>ListHostedZonesByName</code>, include the <code>dnsname</code> * parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the * <code>dnsname</code> parameter, Amazon Route 53 returns all of the hosted zones that were created by the current * AWS account, in ASCII order. For subsequent requests, include both <code>dnsname</code> and * <code>hostedzoneid</code> parameters. For <code>dnsname</code>, specify the value of <code>NextDNSName</code> * from the previous response. * </p> * * @param dNSName * (Optional) For your first request to <code>ListHostedZonesByName</code>, include the <code>dnsname</code> * parameter only if you want to specify the name of the first hosted zone in the response. If you don't * include the <code>dnsname</code> parameter, Amazon Route 53 returns all of the hosted zones that were * created by the current AWS account, in ASCII order. For subsequent requests, include both * <code>dnsname</code> and <code>hostedzoneid</code> parameters. For <code>dnsname</code>, specify the value * of <code>NextDNSName</code> from the previous response. * @return Returns a reference to this object so that method calls can be chained together. */ public ListHostedZonesByNameRequest withDNSName(String dNSName) { setDNSName(dNSName); return this; } /** * <p> * (Optional) For your first request to <code>ListHostedZonesByName</code>, do not include the * <code>hostedzoneid</code> parameter. * </p> * <p> * If you have more hosted zones than the value of <code>maxitems</code>, <code>ListHostedZonesByName</code> returns * only the first <code>maxitems</code> hosted zones. To get the next group of <code>maxitems</code> hosted zones, * submit another request to <code>ListHostedZonesByName</code> and include both <code>dnsname</code> and * <code>hostedzoneid</code> parameters. For the value of <code>hostedzoneid</code>, specify the value of the * <code>NextHostedZoneId</code> element from the previous response. * </p> * * @param hostedZoneId * (Optional) For your first request to <code>ListHostedZonesByName</code>, do not include the * <code>hostedzoneid</code> parameter.</p> * <p> * If you have more hosted zones than the value of <code>maxitems</code>, <code>ListHostedZonesByName</code> * returns only the first <code>maxitems</code> hosted zones. To get the next group of <code>maxitems</code> * hosted zones, submit another request to <code>ListHostedZonesByName</code> and include both * <code>dnsname</code> and <code>hostedzoneid</code> parameters. For the value of <code>hostedzoneid</code>, * specify the value of the <code>NextHostedZoneId</code> element from the previous response. */ public void setHostedZoneId(String hostedZoneId) { this.hostedZoneId = hostedZoneId; } /** * <p> * (Optional) For your first request to <code>ListHostedZonesByName</code>, do not include the * <code>hostedzoneid</code> parameter. * </p> * <p> * If you have more hosted zones than the value of <code>maxitems</code>, <code>ListHostedZonesByName</code> returns * only the first <code>maxitems</code> hosted zones. To get the next group of <code>maxitems</code> hosted zones, * submit another request to <code>ListHostedZonesByName</code> and include both <code>dnsname</code> and * <code>hostedzoneid</code> parameters. For the value of <code>hostedzoneid</code>, specify the value of the * <code>NextHostedZoneId</code> element from the previous response. * </p> * * @return (Optional) For your first request to <code>ListHostedZonesByName</code>, do not include the * <code>hostedzoneid</code> parameter.</p> * <p> * If you have more hosted zones than the value of <code>maxitems</code>, <code>ListHostedZonesByName</code> * returns only the first <code>maxitems</code> hosted zones. To get the next group of <code>maxitems</code> * hosted zones, submit another request to <code>ListHostedZonesByName</code> and include both * <code>dnsname</code> and <code>hostedzoneid</code> parameters. For the value of <code>hostedzoneid</code> * , specify the value of the <code>NextHostedZoneId</code> element from the previous response. */ public String getHostedZoneId() { return this.hostedZoneId; } /** * <p> * (Optional) For your first request to <code>ListHostedZonesByName</code>, do not include the * <code>hostedzoneid</code> parameter. * </p> * <p> * If you have more hosted zones than the value of <code>maxitems</code>, <code>ListHostedZonesByName</code> returns * only the first <code>maxitems</code> hosted zones. To get the next group of <code>maxitems</code> hosted zones, * submit another request to <code>ListHostedZonesByName</code> and include both <code>dnsname</code> and * <code>hostedzoneid</code> parameters. For the value of <code>hostedzoneid</code>, specify the value of the * <code>NextHostedZoneId</code> element from the previous response. * </p> * * @param hostedZoneId * (Optional) For your first request to <code>ListHostedZonesByName</code>, do not include the * <code>hostedzoneid</code> parameter.</p> * <p> * If you have more hosted zones than the value of <code>maxitems</code>, <code>ListHostedZonesByName</code> * returns only the first <code>maxitems</code> hosted zones. To get the next group of <code>maxitems</code> * hosted zones, submit another request to <code>ListHostedZonesByName</code> and include both * <code>dnsname</code> and <code>hostedzoneid</code> parameters. For the value of <code>hostedzoneid</code>, * specify the value of the <code>NextHostedZoneId</code> element from the previous response. * @return Returns a reference to this object so that method calls can be chained together. */ public ListHostedZonesByNameRequest withHostedZoneId(String hostedZoneId) { setHostedZoneId(hostedZoneId); return this; } /** * <p> * The maximum number of hosted zones to be included in the response body for this request. If you have more than * <code>maxitems</code> hosted zones, then the value of the <code>IsTruncated</code> element in the response is * true, and the values of <code>NextDNSName</code> and <code>NextHostedZoneId</code> specify the first hosted zone * in the next group of <code>maxitems</code> hosted zones. * </p> * * @param maxItems * The maximum number of hosted zones to be included in the response body for this request. If you have more * than <code>maxitems</code> hosted zones, then the value of the <code>IsTruncated</code> element in the * response is true, and the values of <code>NextDNSName</code> and <code>NextHostedZoneId</code> specify the * first hosted zone in the next group of <code>maxitems</code> hosted zones. */ public void setMaxItems(String maxItems) { this.maxItems = maxItems; } /** * <p> * The maximum number of hosted zones to be included in the response body for this request. If you have more than * <code>maxitems</code> hosted zones, then the value of the <code>IsTruncated</code> element in the response is * true, and the values of <code>NextDNSName</code> and <code>NextHostedZoneId</code> specify the first hosted zone * in the next group of <code>maxitems</code> hosted zones. * </p> * * @return The maximum number of hosted zones to be included in the response body for this request. If you have more * than <code>maxitems</code> hosted zones, then the value of the <code>IsTruncated</code> element in the * response is true, and the values of <code>NextDNSName</code> and <code>NextHostedZoneId</code> specify * the first hosted zone in the next group of <code>maxitems</code> hosted zones. */ public String getMaxItems() { return this.maxItems; } /** * <p> * The maximum number of hosted zones to be included in the response body for this request. If you have more than * <code>maxitems</code> hosted zones, then the value of the <code>IsTruncated</code> element in the response is * true, and the values of <code>NextDNSName</code> and <code>NextHostedZoneId</code> specify the first hosted zone * in the next group of <code>maxitems</code> hosted zones. * </p> * * @param maxItems * The maximum number of hosted zones to be included in the response body for this request. If you have more * than <code>maxitems</code> hosted zones, then the value of the <code>IsTruncated</code> element in the * response is true, and the values of <code>NextDNSName</code> and <code>NextHostedZoneId</code> specify the * first hosted zone in the next group of <code>maxitems</code> hosted zones. * @return Returns a reference to this object so that method calls can be chained together. */ public ListHostedZonesByNameRequest 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 (getDNSName() != null) sb.append("DNSName: ").append(getDNSName()).append(","); if (getHostedZoneId() != null) sb.append("HostedZoneId: ").append(getHostedZoneId()).append(","); if (getMaxItems() != null) sb.append("MaxItems: ").append(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 ListHostedZonesByNameRequest == false) return false; ListHostedZonesByNameRequest other = (ListHostedZonesByNameRequest) obj; if (other.getDNSName() == null ^ this.getDNSName() == null) return false; if (other.getDNSName() != null && other.getDNSName().equals(this.getDNSName()) == false) return false; if (other.getHostedZoneId() == null ^ this.getHostedZoneId() == null) return false; if (other.getHostedZoneId() != null && other.getHostedZoneId().equals(this.getHostedZoneId()) == 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 + ((getDNSName() == null) ? 0 : getDNSName().hashCode()); hashCode = prime * hashCode + ((getHostedZoneId() == null) ? 0 : getHostedZoneId().hashCode()); hashCode = prime * hashCode + ((getMaxItems() == null) ? 0 : getMaxItems().hashCode()); return hashCode; } @Override public ListHostedZonesByNameRequest clone() { return (ListHostedZonesByNameRequest) super.clone(); } }