com.amazonaws.services.route53.model.ListHealthChecksRequest 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 retrieve a list of your health checks, send a GET request to
* the /2013-04-01/healthcheck resource. The response to this
* request includes a HealthChecks element with zero or more
* HealthCheck child elements. By default, the list of health
* checks 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 Marker parameter to control the health check that the list
* begins with.
*
*
*
* Amazon Route 53 returns a maximum of 100 items. If you set
* MaxItems to a value greater than 100, Amazon Route 53 returns
* only the first 100.
*
*
*/
public class ListHealthChecksRequest extends
com.amazonaws.AmazonWebServiceRequest implements Serializable,
Cloneable {
/**
*
* If the response to a ListHealthChecks is more than one page,
* marker is the health check ID for the first health check on the next page
* of results. For more information, see
* ListHealthChecksResponse$MaxItems.
*
*/
private String marker;
/**
*
* The maximum number of HealthCheck elements you want
* ListHealthChecks to return on each page of the response
* body. If the AWS account includes more HealthCheck elements
* than the value of maxitems, the response is broken into
* pages. Each page contains the number of HealthCheck elements
* specified by maxitems.
*
*
* For example, suppose you specify 10 for
* maxitems and the current AWS account has 51
* health checks. In the response, ListHealthChecks sets
* ListHealthChecksResponse$IsTruncated to true and includes the
* ListHealthChecksResponse$NextMarker element. To access the second
* and subsequent pages, you resend the GET
* ListHealthChecks request, add the
* ListHealthChecksResponse$Marker parameter to the request, and
* specify the value of the ListHealthChecksResponse$NextMarker
* element from the previous response. On the last (sixth) page of the
* response, which contains only one HealthCheck element:
*
*
* -
*
* The value of ListHealthChecksResponse$IsTruncated is
* false.
*
*
* -
*
* ListHealthChecksResponse$NextMarker is omitted.
*
*
*
*/
private String maxItems;
/**
*
* If the response to a ListHealthChecks is more than one page,
* marker is the health check ID for the first health check on the next page
* of results. For more information, see
* ListHealthChecksResponse$MaxItems.
*
*
* @param marker
* If the response to a ListHealthChecks is more than
* one page, marker is the health check ID for the first health check
* on the next page of results. For more information, see
* ListHealthChecksResponse$MaxItems.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* If the response to a ListHealthChecks is more than one page,
* marker is the health check ID for the first health check on the next page
* of results. For more information, see
* ListHealthChecksResponse$MaxItems.
*
*
* @return If the response to a ListHealthChecks is more than
* one page, marker is the health check ID for the first health
* check on the next page of results. For more information, see
* ListHealthChecksResponse$MaxItems.
*/
public String getMarker() {
return this.marker;
}
/**
*
* If the response to a ListHealthChecks is more than one page,
* marker is the health check ID for the first health check on the next page
* of results. For more information, see
* ListHealthChecksResponse$MaxItems.
*
*
* @param marker
* If the response to a ListHealthChecks is more than
* one page, marker is the health check ID for the first health check
* on the next page of results. For more information, see
* ListHealthChecksResponse$MaxItems.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ListHealthChecksRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
*
* The maximum number of HealthCheck elements you want
* ListHealthChecks to return on each page of the response
* body. If the AWS account includes more HealthCheck elements
* than the value of maxitems, the response is broken into
* pages. Each page contains the number of HealthCheck elements
* specified by maxitems.
*
*
* For example, suppose you specify 10 for
* maxitems and the current AWS account has 51
* health checks. In the response, ListHealthChecks sets
* ListHealthChecksResponse$IsTruncated to true and includes the
* ListHealthChecksResponse$NextMarker element. To access the second
* and subsequent pages, you resend the GET
* ListHealthChecks request, add the
* ListHealthChecksResponse$Marker parameter to the request, and
* specify the value of the ListHealthChecksResponse$NextMarker
* element from the previous response. On the last (sixth) page of the
* response, which contains only one HealthCheck element:
*
*
* -
*
* The value of ListHealthChecksResponse$IsTruncated is
* false.
*
*
* -
*
* ListHealthChecksResponse$NextMarker is omitted.
*
*
*
*
* @param maxItems
* The maximum number of HealthCheck elements you want
* ListHealthChecks to return on each page of the
* response body. If the AWS account includes more
* HealthCheck elements than the value of
* maxitems, the response is broken into pages. Each
* page contains the number of HealthCheck elements
* specified by maxitems.
*
* For example, suppose you specify 10 for
* maxitems and the current AWS account has
* 51 health checks. In the response,
* ListHealthChecks sets
* ListHealthChecksResponse$IsTruncated to true and includes
* the ListHealthChecksResponse$NextMarker element. To access
* the second and subsequent pages, you resend the GET
* ListHealthChecks request, add the
* ListHealthChecksResponse$Marker parameter to the request,
* and specify the value of the
* ListHealthChecksResponse$NextMarker element from the
* previous response. On the last (sixth) page of the response, which
* contains only one HealthCheck element:
*
*
* -
*
* The value of ListHealthChecksResponse$IsTruncated is
* false.
*
*
* -
*
* ListHealthChecksResponse$NextMarker is omitted.
*
*
*/
public void setMaxItems(String maxItems) {
this.maxItems = maxItems;
}
/**
*
* The maximum number of HealthCheck elements you want
* ListHealthChecks to return on each page of the response
* body. If the AWS account includes more HealthCheck elements
* than the value of maxitems, the response is broken into
* pages. Each page contains the number of HealthCheck elements
* specified by maxitems.
*
*
* For example, suppose you specify 10 for
* maxitems and the current AWS account has 51
* health checks. In the response, ListHealthChecks sets
* ListHealthChecksResponse$IsTruncated to true and includes the
* ListHealthChecksResponse$NextMarker element. To access the second
* and subsequent pages, you resend the GET
* ListHealthChecks request, add the
* ListHealthChecksResponse$Marker parameter to the request, and
* specify the value of the ListHealthChecksResponse$NextMarker
* element from the previous response. On the last (sixth) page of the
* response, which contains only one HealthCheck element:
*
*
* -
*
* The value of ListHealthChecksResponse$IsTruncated is
* false.
*
*
* -
*
* ListHealthChecksResponse$NextMarker is omitted.
*
*
*
*
* @return The maximum number of HealthCheck elements you want
* ListHealthChecks to return on each page of the
* response body. If the AWS account includes more
* HealthCheck elements than the value of
* maxitems, the response is broken into pages. Each
* page contains the number of HealthCheck elements
* specified by maxitems.
*
* For example, suppose you specify 10 for
* maxitems and the current AWS account has
* 51 health checks. In the response,
* ListHealthChecks sets
* ListHealthChecksResponse$IsTruncated to true and includes
* the ListHealthChecksResponse$NextMarker element. To access
* the second and subsequent pages, you resend the GET
* ListHealthChecks request, add the
* ListHealthChecksResponse$Marker parameter to the request,
* and specify the value of the
* ListHealthChecksResponse$NextMarker element from the
* previous response. On the last (sixth) page of the response,
* which contains only one HealthCheck element:
*
*
* -
*
* The value of ListHealthChecksResponse$IsTruncated is
* false.
*
*
* -
*
* ListHealthChecksResponse$NextMarker is omitted.
*
*
*/
public String getMaxItems() {
return this.maxItems;
}
/**
*
* The maximum number of HealthCheck elements you want
* ListHealthChecks to return on each page of the response
* body. If the AWS account includes more HealthCheck elements
* than the value of maxitems, the response is broken into
* pages. Each page contains the number of HealthCheck elements
* specified by maxitems.
*
*
* For example, suppose you specify 10 for
* maxitems and the current AWS account has 51
* health checks. In the response, ListHealthChecks sets
* ListHealthChecksResponse$IsTruncated to true and includes the
* ListHealthChecksResponse$NextMarker element. To access the second
* and subsequent pages, you resend the GET
* ListHealthChecks request, add the
* ListHealthChecksResponse$Marker parameter to the request, and
* specify the value of the ListHealthChecksResponse$NextMarker
* element from the previous response. On the last (sixth) page of the
* response, which contains only one HealthCheck element:
*
*
* -
*
* The value of ListHealthChecksResponse$IsTruncated is
* false.
*
*
* -
*
* ListHealthChecksResponse$NextMarker is omitted.
*
*
*
*
* @param maxItems
* The maximum number of HealthCheck elements you want
* ListHealthChecks to return on each page of the
* response body. If the AWS account includes more
* HealthCheck elements than the value of
* maxitems, the response is broken into pages. Each
* page contains the number of HealthCheck elements
* specified by maxitems.
*
* For example, suppose you specify 10 for
* maxitems and the current AWS account has
* 51 health checks. In the response,
* ListHealthChecks sets
* ListHealthChecksResponse$IsTruncated to true and includes
* the ListHealthChecksResponse$NextMarker element. To access
* the second and subsequent pages, you resend the GET
* ListHealthChecks request, add the
* ListHealthChecksResponse$Marker parameter to the request,
* and specify the value of the
* ListHealthChecksResponse$NextMarker element from the
* previous response. On the last (sixth) page of the response, which
* contains only one HealthCheck element:
*
*
* -
*
* The value of ListHealthChecksResponse$IsTruncated is
* false.
*
*
* -
*
* ListHealthChecksResponse$NextMarker is omitted.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ListHealthChecksRequest 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 (getMarker() != null)
sb.append("Marker: " + getMarker() + ",");
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 ListHealthChecksRequest == false)
return false;
ListHealthChecksRequest other = (ListHealthChecksRequest) obj;
if (other.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null
&& other.getMarker().equals(this.getMarker()) == 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
+ ((getMarker() == null) ? 0 : getMarker().hashCode());
hashCode = prime * hashCode
+ ((getMaxItems() == null) ? 0 : getMaxItems().hashCode());
return hashCode;
}
@Override
public ListHealthChecksRequest clone() {
return (ListHealthChecksRequest) super.clone();
}
}