/*
* 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.opsworkscm.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeBackups" target="_top">AWS API
* Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeBackupsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* <p>
* Describes a single backup.
* </p>
*/
private String backupId;
/**
* <p>
* Returns backups for the server with the specified ServerName.
* </p>
*/
private String serverName;
/**
* <p>
* NextToken is a string that is returned in some command responses. It indicates that not all entries have been
* returned, and that you must run at least one more request to get remaining items. To get remaining results, call
* <code>DescribeBackups</code> again, and assign the token from the previous results as the value of the
* <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code>
* parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your
* previous results causes an <code>InvalidNextTokenException</code> to occur.
* </p>
*/
private String nextToken;
/**
* <p>
* To receive a paginated response, use this parameter to specify the maximum number of results to be returned with
* a single call. If the number of available results exceeds this maximum, the response includes a
* <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next
* set of results.
* </p>
*/
private Integer maxResults;
/**
* <p>
* Describes a single backup.
* </p>
*
* @param backupId
* Describes a single backup.
*/
public void setBackupId(String backupId) {
this.backupId = backupId;
}
/**
* <p>
* Describes a single backup.
* </p>
*
* @return Describes a single backup.
*/
public String getBackupId() {
return this.backupId;
}
/**
* <p>
* Describes a single backup.
* </p>
*
* @param backupId
* Describes a single backup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupsRequest withBackupId(String backupId) {
setBackupId(backupId);
return this;
}
/**
* <p>
* Returns backups for the server with the specified ServerName.
* </p>
*
* @param serverName
* Returns backups for the server with the specified ServerName.
*/
public void setServerName(String serverName) {
this.serverName = serverName;
}
/**
* <p>
* Returns backups for the server with the specified ServerName.
* </p>
*
* @return Returns backups for the server with the specified ServerName.
*/
public String getServerName() {
return this.serverName;
}
/**
* <p>
* Returns backups for the server with the specified ServerName.
* </p>
*
* @param serverName
* Returns backups for the server with the specified ServerName.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupsRequest withServerName(String serverName) {
setServerName(serverName);
return this;
}
/**
* <p>
* NextToken is a string that is returned in some command responses. It indicates that not all entries have been
* returned, and that you must run at least one more request to get remaining items. To get remaining results, call
* <code>DescribeBackups</code> again, and assign the token from the previous results as the value of the
* <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code>
* parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your
* previous results causes an <code>InvalidNextTokenException</code> to occur.
* </p>
*
* @param nextToken
* NextToken is a string that is returned in some command responses. It indicates that not all entries have
* been returned, and that you must run at least one more request to get remaining items. To get remaining
* results, call <code>DescribeBackups</code> again, and assign the token from the previous results as the
* value of the <code>nextToken</code> parameter. If there are no more results, the response object's
* <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that
* was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
* <p>
* NextToken is a string that is returned in some command responses. It indicates that not all entries have been
* returned, and that you must run at least one more request to get remaining items. To get remaining results, call
* <code>DescribeBackups</code> again, and assign the token from the previous results as the value of the
* <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code>
* parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your
* previous results causes an <code>InvalidNextTokenException</code> to occur.
* </p>
*
* @return NextToken is a string that is returned in some command responses. It indicates that not all entries have
* been returned, and that you must run at least one more request to get remaining items. To get remaining
* results, call <code>DescribeBackups</code> again, and assign the token from the previous results as the
* value of the <code>nextToken</code> parameter. If there are no more results, the response object's
* <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that
* was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur.
*/
public String getNextToken() {
return this.nextToken;
}
/**
* <p>
* NextToken is a string that is returned in some command responses. It indicates that not all entries have been
* returned, and that you must run at least one more request to get remaining items. To get remaining results, call
* <code>DescribeBackups</code> again, and assign the token from the previous results as the value of the
* <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code>
* parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your
* previous results causes an <code>InvalidNextTokenException</code> to occur.
* </p>
*
* @param nextToken
* NextToken is a string that is returned in some command responses. It indicates that not all entries have
* been returned, and that you must run at least one more request to get remaining items. To get remaining
* results, call <code>DescribeBackups</code> again, and assign the token from the previous results as the
* value of the <code>nextToken</code> parameter. If there are no more results, the response object's
* <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that
* was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* <p>
* To receive a paginated response, use this parameter to specify the maximum number of results to be returned with
* a single call. If the number of available results exceeds this maximum, the response includes a
* <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next
* set of results.
* </p>
*
* @param maxResults
* To receive a paginated response, use this parameter to specify the maximum number of results to be
* returned with a single call. If the number of available results exceeds this maximum, the response
* includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request
* parameter to get the next set of results.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
* <p>
* To receive a paginated response, use this parameter to specify the maximum number of results to be returned with
* a single call. If the number of available results exceeds this maximum, the response includes a
* <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next
* set of results.
* </p>
*
* @return To receive a paginated response, use this parameter to specify the maximum number of results to be
* returned with a single call. If the number of available results exceeds this maximum, the response
* includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request
* parameter to get the next set of results.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
* <p>
* To receive a paginated response, use this parameter to specify the maximum number of results to be returned with
* a single call. If the number of available results exceeds this maximum, the response includes a
* <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next
* set of results.
* </p>
*
* @param maxResults
* To receive a paginated response, use this parameter to specify the maximum number of results to be
* returned with a single call. If the number of available results exceeds this maximum, the response
* includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request
* parameter to get the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 (getBackupId() != null)
sb.append("BackupId: ").append(getBackupId()).append(",");
if (getServerName() != null)
sb.append("ServerName: ").append(getServerName()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeBackupsRequest == false)
return false;
DescribeBackupsRequest other = (DescribeBackupsRequest) obj;
if (other.getBackupId() == null ^ this.getBackupId() == null)
return false;
if (other.getBackupId() != null && other.getBackupId().equals(this.getBackupId()) == false)
return false;
if (other.getServerName() == null ^ this.getServerName() == null)
return false;
if (other.getServerName() != null && other.getServerName().equals(this.getServerName()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBackupId() == null) ? 0 : getBackupId().hashCode());
hashCode = prime * hashCode + ((getServerName() == null) ? 0 : getServerName().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public DescribeBackupsRequest clone() {
return (DescribeBackupsRequest) super.clone();
}
}