com.amazonaws.services.route53.model.ListHostedZonesByNameRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
 * Copyright 2010-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 retrieve a list of your hosted zones in lexicographic order, send a
 * GET request to the
 * /Route 53 API version/hostedzonesbyname resource. The
 * response to this request includes a HostedZones element with
 * zero or more HostedZone child elements lexicographically ordered
 * by DNS name. By default, the list of hosted zones is displayed on a single
 * page. You can control the length of the page that is displayed by using the
 * MaxItems parameter. You can use the DNSName and
 * HostedZoneId parameters to control the hosted zone that the list
 * begins with.
 * 
 * 
 * For more information about listing hosted zones, see Listing the Hosted Zones for an AWS Account in the Amazon Route 53
 * Developer Guide.
 * 
 */
public class ListHostedZonesByNameRequest extends AmazonWebServiceRequest
        implements Serializable, Cloneable {
    /**
     * 
     * The first name in the lexicographic ordering of domain names that you
     * want the ListHostedZonesByNameRequest request to list.
     * 
     * 
     * If the request returned more than one page of results, submit another
     * request and specify the value of NextDNSName and
     * NextHostedZoneId from the last response in the
     * DNSName and HostedZoneId parameters to get the
     * next page of results.
     * 
     */
    private String dNSName;
    /**
     * 
     * If the request returned more than one page of results, submit another
     * request and specify the value of NextDNSName and
     * NextHostedZoneId from the last response in the
     * DNSName and HostedZoneId parameters to get the
     * next page of results.
     * 
     */
    private String hostedZoneId;
    /**
     * 
     * Specify the maximum number of hosted zones to return per page of results.
     * 
     */
    private String maxItems;
    /**
     * 
     * The first name in the lexicographic ordering of domain names that you
     * want the ListHostedZonesByNameRequest request to list.
     * 
     * 
     * If the request returned more than one page of results, submit another
     * request and specify the value of NextDNSName and
     * NextHostedZoneId from the last response in the
     * DNSName and HostedZoneId parameters to get the
     * next page of results.
     * 
     * 
     * @param dNSName
     *        The first name in the lexicographic ordering of domain names that
     *        you want the ListHostedZonesByNameRequest request to
     *        list.
     *        
     *        If the request returned more than one page of results, submit
     *        another request and specify the value of NextDNSName
     *        and NextHostedZoneId from the last response in the
     *        DNSName and HostedZoneId parameters to
     *        get the next page of results.
     */
    public void setDNSName(String dNSName) {
        this.dNSName = dNSName;
    }
    /**
     * 
     * The first name in the lexicographic ordering of domain names that you
     * want the ListHostedZonesByNameRequest request to list.
     * 
     * 
     * If the request returned more than one page of results, submit another
     * request and specify the value of NextDNSName and
     * NextHostedZoneId from the last response in the
     * DNSName and HostedZoneId parameters to get the
     * next page of results.
     * 
     * 
     * @return The first name in the lexicographic ordering of domain names that
     *         you want the ListHostedZonesByNameRequest request to
     *         list.
     *         
     *         If the request returned more than one page of results, submit
     *         another request and specify the value of NextDNSName
     *         and NextHostedZoneId from the last response in the
     *         DNSName and HostedZoneId parameters to
     *         get the next page of results.
     */
    public String getDNSName() {
        return this.dNSName;
    }
    /**
     * 
     * The first name in the lexicographic ordering of domain names that you
     * want the ListHostedZonesByNameRequest request to list.
     * 
     * 
     * If the request returned more than one page of results, submit another
     * request and specify the value of NextDNSName and
     * NextHostedZoneId from the last response in the
     * DNSName and HostedZoneId parameters to get the
     * next page of results.
     * 
     * 
     * @param dNSName
     *        The first name in the lexicographic ordering of domain names that
     *        you want the ListHostedZonesByNameRequest request to
     *        list.
     *        
     *        If the request returned more than one page of results, submit
     *        another request and specify the value of NextDNSName
     *        and NextHostedZoneId from the last response in the
     *        DNSName and HostedZoneId parameters to
     *        get the next page of results.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ListHostedZonesByNameRequest withDNSName(String dNSName) {
        setDNSName(dNSName);
        return this;
    }
    /**
     * 
     * If the request returned more than one page of results, submit another
     * request and specify the value of NextDNSName and
     * NextHostedZoneId from the last response in the
     * DNSName and HostedZoneId parameters to get the
     * next page of results.
     * 
     * 
     * @param hostedZoneId
     *        If the request returned more than one page of results, submit
     *        another request and specify the value of NextDNSName
     *        and NextHostedZoneId from the last response in the
     *        DNSName and HostedZoneId parameters to
     *        get the next page of results.
     */
    public void setHostedZoneId(String hostedZoneId) {
        this.hostedZoneId = hostedZoneId;
    }
    /**
     * 
     * If the request returned more than one page of results, submit another
     * request and specify the value of NextDNSName and
     * NextHostedZoneId from the last response in the
     * DNSName and HostedZoneId parameters to get the
     * next page of results.
     * 
     * 
     * @return If the request returned more than one page of results, submit
     *         another request and specify the value of NextDNSName
     *         and NextHostedZoneId from the last response in the
     *         DNSName and HostedZoneId parameters to
     *         get the next page of results.
     */
    public String getHostedZoneId() {
        return this.hostedZoneId;
    }
    /**
     * 
     * If the request returned more than one page of results, submit another
     * request and specify the value of NextDNSName and
     * NextHostedZoneId from the last response in the
     * DNSName and HostedZoneId parameters to get the
     * next page of results.
     * 
     * 
     * @param hostedZoneId
     *        If the request returned more than one page of results, submit
     *        another request and specify the value of NextDNSName
     *        and NextHostedZoneId from the last response in the
     *        DNSName and HostedZoneId parameters to
     *        get the next page of results.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ListHostedZonesByNameRequest withHostedZoneId(String hostedZoneId) {
        setHostedZoneId(hostedZoneId);
        return this;
    }
    /**
     * 
     * Specify the maximum number of hosted zones to return per page of results.
     * 
     * 
     * @param maxItems
     *        Specify the maximum number of hosted zones to return per page of
     *        results.
     */
    public void setMaxItems(String maxItems) {
        this.maxItems = maxItems;
    }
    /**
     * 
     * Specify the maximum number of hosted zones to return per page of results.
     * 
     * 
     * @return Specify the maximum number of hosted zones to return per page of
     *         results.
     */
    public String getMaxItems() {
        return this.maxItems;
    }
    /**
     * 
     * Specify the maximum number of hosted zones to return per page of results.
     * 
     * 
     * @param maxItems
     *        Specify the maximum number of hosted zones to return per page of
     *        results.
     * @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: " + getDNSName() + ",");
        if (getHostedZoneId() != null)
            sb.append("HostedZoneId: " + getHostedZoneId() + ",");
        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 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();
    }
}