com.amazonaws.services.ec2.model.ListSnapshotsInRecycleBinRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.ListSnapshotsInRecycleBinRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListSnapshotsInRecycleBinRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*/
private Integer maxResults;
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*/
private String nextToken;
/**
*
* The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.
*
*/
private com.amazonaws.internal.SdkInternalList snapshotIds;
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @return The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSnapshotsInRecycleBinRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @return The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSnapshotsInRecycleBinRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.
*
*
* @return The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the
* Recycle Bin.
*/
public java.util.List getSnapshotIds() {
if (snapshotIds == null) {
snapshotIds = new com.amazonaws.internal.SdkInternalList();
}
return snapshotIds;
}
/**
*
* The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.
*
*
* @param snapshotIds
* The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle
* Bin.
*/
public void setSnapshotIds(java.util.Collection snapshotIds) {
if (snapshotIds == null) {
this.snapshotIds = null;
return;
}
this.snapshotIds = new com.amazonaws.internal.SdkInternalList(snapshotIds);
}
/**
*
* The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSnapshotIds(java.util.Collection)} or {@link #withSnapshotIds(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param snapshotIds
* The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle
* Bin.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSnapshotsInRecycleBinRequest withSnapshotIds(String... snapshotIds) {
if (this.snapshotIds == null) {
setSnapshotIds(new com.amazonaws.internal.SdkInternalList(snapshotIds.length));
}
for (String ele : snapshotIds) {
this.snapshotIds.add(ele);
}
return this;
}
/**
*
* The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.
*
*
* @param snapshotIds
* The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle
* Bin.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSnapshotsInRecycleBinRequest withSnapshotIds(java.util.Collection snapshotIds) {
setSnapshotIds(snapshotIds);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new ListSnapshotsInRecycleBinRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getSnapshotIds() != null)
sb.append("SnapshotIds: ").append(getSnapshotIds());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListSnapshotsInRecycleBinRequest == false)
return false;
ListSnapshotsInRecycleBinRequest other = (ListSnapshotsInRecycleBinRequest) obj;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == 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.getSnapshotIds() == null ^ this.getSnapshotIds() == null)
return false;
if (other.getSnapshotIds() != null && other.getSnapshotIds().equals(this.getSnapshotIds()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getSnapshotIds() == null) ? 0 : getSnapshotIds().hashCode());
return hashCode;
}
@Override
public ListSnapshotsInRecycleBinRequest clone() {
return (ListSnapshotsInRecycleBinRequest) super.clone();
}
}