com.amazonaws.services.ec2.model.DescribeSnapshotsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 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.ec2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeSnapshotsRequestMarshaller;
/**
*
* Contains the parameters for DescribeSnapshots.
*
*/
public class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* One or more snapshot IDs.
*
*
* Default: Describes snapshots for which you have launch permissions.
*
*/
private com.amazonaws.internal.SdkInternalList snapshotIds;
/**
*
* Returns the snapshots owned by the specified owner. Multiple owners can
* be specified.
*
*/
private com.amazonaws.internal.SdkInternalList ownerIds;
/**
*
* One or more AWS accounts IDs that can create volumes from the snapshot.
*
*/
private com.amazonaws.internal.SdkInternalList restorableByUserIds;
/**
*
* One or more filters.
*
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* owner-alias - Value from an Amazon-maintained list (
* amazon | aws-marketplace |
* microsoft) of snapshot owners. Not to be confused with the
* user-configured AWS account alias, which is set from the IAM consolew.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the snapshot.
*
*
* -
*
* progress - The progress of the snapshot, as a percentage
* (for example, 80%).
*
*
* -
*
* snapshot-id - The snapshot ID.
*
*
* -
*
* start-time - The time stamp when the snapshot was initiated.
*
*
* -
*
* status - The status of the snapshot (pending |
* completed | error).
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The NextToken value returned from a previous paginated
* DescribeSnapshots request where MaxResults was
* used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* NextToken value. This value is null when there
* are no more results to return.
*
*/
private String nextToken;
/**
*
* The maximum number of snapshot results returned by
* DescribeSnapshots in paginated output. When this parameter
* is used, DescribeSnapshots only returns
* MaxResults results in a single page along with a
* NextToken response element. The remaining results of the
* initial request can be seen by sending another
* DescribeSnapshots request with the returned
* NextToken value. This value can be between 5 and 1000; if
* MaxResults is given a value larger than 1000, only 1000
* results are returned. If this parameter is not used, then
* DescribeSnapshots returns all results. You cannot specify
* this parameter and the snapshot IDs parameter in the same request.
*
*/
private Integer maxResults;
/**
*
* One or more snapshot IDs.
*
*
* Default: Describes snapshots for which you have launch permissions.
*
*
* @return One or more snapshot IDs.
*
* Default: Describes snapshots for which you have launch
* permissions.
*/
public java.util.List getSnapshotIds() {
if (snapshotIds == null) {
snapshotIds = new com.amazonaws.internal.SdkInternalList();
}
return snapshotIds;
}
/**
*
* One or more snapshot IDs.
*
*
* Default: Describes snapshots for which you have launch permissions.
*
*
* @param snapshotIds
* One or more snapshot IDs.
*
* Default: Describes snapshots for which you have launch
* permissions.
*/
public void setSnapshotIds(java.util.Collection snapshotIds) {
if (snapshotIds == null) {
this.snapshotIds = null;
return;
}
this.snapshotIds = new com.amazonaws.internal.SdkInternalList(
snapshotIds);
}
/**
*
* One or more snapshot IDs.
*
*
* Default: Describes snapshots for which you have launch permissions.
*
*
* 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
* One or more snapshot IDs.
*
* Default: Describes snapshots for which you have launch
* permissions.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSnapshotsRequest 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;
}
/**
*
* One or more snapshot IDs.
*
*
* Default: Describes snapshots for which you have launch permissions.
*
*
* @param snapshotIds
* One or more snapshot IDs.
*
* Default: Describes snapshots for which you have launch
* permissions.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSnapshotsRequest withSnapshotIds(
java.util.Collection snapshotIds) {
setSnapshotIds(snapshotIds);
return this;
}
/**
*
* Returns the snapshots owned by the specified owner. Multiple owners can
* be specified.
*
*
* @return Returns the snapshots owned by the specified owner. Multiple
* owners can be specified.
*/
public java.util.List getOwnerIds() {
if (ownerIds == null) {
ownerIds = new com.amazonaws.internal.SdkInternalList();
}
return ownerIds;
}
/**
*
* Returns the snapshots owned by the specified owner. Multiple owners can
* be specified.
*
*
* @param ownerIds
* Returns the snapshots owned by the specified owner. Multiple
* owners can be specified.
*/
public void setOwnerIds(java.util.Collection ownerIds) {
if (ownerIds == null) {
this.ownerIds = null;
return;
}
this.ownerIds = new com.amazonaws.internal.SdkInternalList(
ownerIds);
}
/**
*
* Returns the snapshots owned by the specified owner. Multiple owners can
* be specified.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setOwnerIds(java.util.Collection)} or
* {@link #withOwnerIds(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param ownerIds
* Returns the snapshots owned by the specified owner. Multiple
* owners can be specified.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSnapshotsRequest withOwnerIds(String... ownerIds) {
if (this.ownerIds == null) {
setOwnerIds(new com.amazonaws.internal.SdkInternalList(
ownerIds.length));
}
for (String ele : ownerIds) {
this.ownerIds.add(ele);
}
return this;
}
/**
*
* Returns the snapshots owned by the specified owner. Multiple owners can
* be specified.
*
*
* @param ownerIds
* Returns the snapshots owned by the specified owner. Multiple
* owners can be specified.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSnapshotsRequest withOwnerIds(
java.util.Collection ownerIds) {
setOwnerIds(ownerIds);
return this;
}
/**
*
* One or more AWS accounts IDs that can create volumes from the snapshot.
*
*
* @return One or more AWS accounts IDs that can create volumes from the
* snapshot.
*/
public java.util.List getRestorableByUserIds() {
if (restorableByUserIds == null) {
restorableByUserIds = new com.amazonaws.internal.SdkInternalList();
}
return restorableByUserIds;
}
/**
*
* One or more AWS accounts IDs that can create volumes from the snapshot.
*
*
* @param restorableByUserIds
* One or more AWS accounts IDs that can create volumes from the
* snapshot.
*/
public void setRestorableByUserIds(
java.util.Collection restorableByUserIds) {
if (restorableByUserIds == null) {
this.restorableByUserIds = null;
return;
}
this.restorableByUserIds = new com.amazonaws.internal.SdkInternalList(
restorableByUserIds);
}
/**
*
* One or more AWS accounts IDs that can create volumes from the snapshot.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setRestorableByUserIds(java.util.Collection)} or
* {@link #withRestorableByUserIds(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param restorableByUserIds
* One or more AWS accounts IDs that can create volumes from the
* snapshot.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSnapshotsRequest withRestorableByUserIds(
String... restorableByUserIds) {
if (this.restorableByUserIds == null) {
setRestorableByUserIds(new com.amazonaws.internal.SdkInternalList(
restorableByUserIds.length));
}
for (String ele : restorableByUserIds) {
this.restorableByUserIds.add(ele);
}
return this;
}
/**
*
* One or more AWS accounts IDs that can create volumes from the snapshot.
*
*
* @param restorableByUserIds
* One or more AWS accounts IDs that can create volumes from the
* snapshot.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSnapshotsRequest withRestorableByUserIds(
java.util.Collection restorableByUserIds) {
setRestorableByUserIds(restorableByUserIds);
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* owner-alias - Value from an Amazon-maintained list (
* amazon | aws-marketplace |
* microsoft) of snapshot owners. Not to be confused with the
* user-configured AWS account alias, which is set from the IAM consolew.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the snapshot.
*
*
* -
*
* progress - The progress of the snapshot, as a percentage
* (for example, 80%).
*
*
* -
*
* snapshot-id - The snapshot ID.
*
*
* -
*
* start-time - The time stamp when the snapshot was initiated.
*
*
* -
*
* status - The status of the snapshot (pending |
* completed | error).
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
*
*
* @return One or more filters.
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* owner-alias - Value from an Amazon-maintained list (
* amazon | aws-marketplace |
* microsoft) of snapshot owners. Not to be confused
* with the user-configured AWS account alias, which is set from the
* IAM consolew.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the
* snapshot.
*
*
* -
*
* progress - The progress of the snapshot, as a
* percentage (for example, 80%).
*
*
* -
*
* snapshot-id - The snapshot ID.
*
*
* -
*
* start-time - The time stamp when the snapshot was
* initiated.
*
*
* -
*
* status - The status of the snapshot (
* pending | completed |
* error).
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to
* list only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is
* for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters.
*
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* owner-alias - Value from an Amazon-maintained list (
* amazon | aws-marketplace |
* microsoft) of snapshot owners. Not to be confused with the
* user-configured AWS account alias, which is set from the IAM consolew.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the snapshot.
*
*
* -
*
* progress - The progress of the snapshot, as a percentage
* (for example, 80%).
*
*
* -
*
* snapshot-id - The snapshot ID.
*
*
* -
*
* start-time - The time stamp when the snapshot was initiated.
*
*
* -
*
* status - The status of the snapshot (pending |
* completed | error).
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* owner-alias - Value from an Amazon-maintained list (
* amazon | aws-marketplace |
* microsoft) of snapshot owners. Not to be confused
* with the user-configured AWS account alias, which is set from the
* IAM consolew.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the
* snapshot.
*
*
* -
*
* progress - The progress of the snapshot, as a
* percentage (for example, 80%).
*
*
* -
*
* snapshot-id - The snapshot ID.
*
*
* -
*
* start-time - The time stamp when the snapshot was
* initiated.
*
*
* -
*
* status - The status of the snapshot (
* pending | completed | error
* ).
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to list
* only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(
filters);
}
/**
*
* One or more filters.
*
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* owner-alias - Value from an Amazon-maintained list (
* amazon | aws-marketplace |
* microsoft) of snapshot owners. Not to be confused with the
* user-configured AWS account alias, which is set from the IAM consolew.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the snapshot.
*
*
* -
*
* progress - The progress of the snapshot, as a percentage
* (for example, 80%).
*
*
* -
*
* snapshot-id - The snapshot ID.
*
*
* -
*
* start-time - The time stamp when the snapshot was initiated.
*
*
* -
*
* status - The status of the snapshot (pending |
* completed | error).
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setFilters(java.util.Collection)} or
* {@link #withFilters(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param filters
* One or more filters.
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* owner-alias - Value from an Amazon-maintained list (
* amazon | aws-marketplace |
* microsoft) of snapshot owners. Not to be confused
* with the user-configured AWS account alias, which is set from the
* IAM consolew.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the
* snapshot.
*
*
* -
*
* progress - The progress of the snapshot, as a
* percentage (for example, 80%).
*
*
* -
*
* snapshot-id - The snapshot ID.
*
*
* -
*
* start-time - The time stamp when the snapshot was
* initiated.
*
*
* -
*
* status - The status of the snapshot (
* pending | completed | error
* ).
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to list
* only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSnapshotsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(
filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* owner-alias - Value from an Amazon-maintained list (
* amazon | aws-marketplace |
* microsoft) of snapshot owners. Not to be confused with the
* user-configured AWS account alias, which is set from the IAM consolew.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the snapshot.
*
*
* -
*
* progress - The progress of the snapshot, as a percentage
* (for example, 80%).
*
*
* -
*
* snapshot-id - The snapshot ID.
*
*
* -
*
* start-time - The time stamp when the snapshot was initiated.
*
*
* -
*
* status - The status of the snapshot (pending |
* completed | error).
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* owner-alias - Value from an Amazon-maintained list (
* amazon | aws-marketplace |
* microsoft) of snapshot owners. Not to be confused
* with the user-configured AWS account alias, which is set from the
* IAM consolew.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the
* snapshot.
*
*
* -
*
* progress - The progress of the snapshot, as a
* percentage (for example, 80%).
*
*
* -
*
* snapshot-id - The snapshot ID.
*
*
* -
*
* start-time - The time stamp when the snapshot was
* initiated.
*
*
* -
*
* status - The status of the snapshot (
* pending | completed | error
* ).
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to list
* only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSnapshotsRequest withFilters(
java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The NextToken value returned from a previous paginated
* DescribeSnapshots request where MaxResults was
* used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* NextToken value. This value is null when there
* are no more results to return.
*
*
* @param nextToken
* The NextToken value returned from a previous
* paginated DescribeSnapshots request where
* MaxResults was used and the results exceeded the
* value of that parameter. Pagination continues from the end of the
* previous results that returned the NextToken value.
* This value is null when there are no more results to
* return.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The NextToken value returned from a previous paginated
* DescribeSnapshots request where MaxResults was
* used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* NextToken value. This value is null when there
* are no more results to return.
*
*
* @return The NextToken value returned from a previous
* paginated DescribeSnapshots request where
* MaxResults was used and the results exceeded the
* value of that parameter. Pagination continues from the end of the
* previous results that returned the NextToken value.
* This value is null when there are no more results to
* return.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The NextToken value returned from a previous paginated
* DescribeSnapshots request where MaxResults was
* used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* NextToken value. This value is null when there
* are no more results to return.
*
*
* @param nextToken
* The NextToken value returned from a previous
* paginated DescribeSnapshots request where
* MaxResults was used and the results exceeded the
* value of that parameter. Pagination continues from the end of the
* previous results that returned the NextToken value.
* This value is null when there are no more results to
* return.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSnapshotsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of snapshot results returned by
* DescribeSnapshots in paginated output. When this parameter
* is used, DescribeSnapshots only returns
* MaxResults results in a single page along with a
* NextToken response element. The remaining results of the
* initial request can be seen by sending another
* DescribeSnapshots request with the returned
* NextToken value. This value can be between 5 and 1000; if
* MaxResults is given a value larger than 1000, only 1000
* results are returned. If this parameter is not used, then
* DescribeSnapshots returns all results. You cannot specify
* this parameter and the snapshot IDs parameter in the same request.
*
*
* @param maxResults
* The maximum number of snapshot results returned by
* DescribeSnapshots in paginated output. When this
* parameter is used, DescribeSnapshots only returns
* MaxResults results in a single page along with a
* NextToken response element. The remaining results of
* the initial request can be seen by sending another
* DescribeSnapshots request with the returned
* NextToken value. This value can be between 5 and
* 1000; if MaxResults is given a value larger than
* 1000, only 1000 results are returned. If this parameter is not
* used, then DescribeSnapshots returns all results. You
* cannot specify this parameter and the snapshot IDs parameter in
* the same request.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of snapshot results returned by
* DescribeSnapshots in paginated output. When this parameter
* is used, DescribeSnapshots only returns
* MaxResults results in a single page along with a
* NextToken response element. The remaining results of the
* initial request can be seen by sending another
* DescribeSnapshots request with the returned
* NextToken value. This value can be between 5 and 1000; if
* MaxResults is given a value larger than 1000, only 1000
* results are returned. If this parameter is not used, then
* DescribeSnapshots returns all results. You cannot specify
* this parameter and the snapshot IDs parameter in the same request.
*
*
* @return The maximum number of snapshot results returned by
* DescribeSnapshots in paginated output. When this
* parameter is used, DescribeSnapshots only returns
* MaxResults results in a single page along with a
* NextToken response element. The remaining results of
* the initial request can be seen by sending another
* DescribeSnapshots request with the returned
* NextToken value. This value can be between 5 and
* 1000; if MaxResults is given a value larger than
* 1000, only 1000 results are returned. If this parameter is not
* used, then DescribeSnapshots returns all results.
* You cannot specify this parameter and the snapshot IDs parameter
* in the same request.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of snapshot results returned by
* DescribeSnapshots in paginated output. When this parameter
* is used, DescribeSnapshots only returns
* MaxResults results in a single page along with a
* NextToken response element. The remaining results of the
* initial request can be seen by sending another
* DescribeSnapshots request with the returned
* NextToken value. This value can be between 5 and 1000; if
* MaxResults is given a value larger than 1000, only 1000
* results are returned. If this parameter is not used, then
* DescribeSnapshots returns all results. You cannot specify
* this parameter and the snapshot IDs parameter in the same request.
*
*
* @param maxResults
* The maximum number of snapshot results returned by
* DescribeSnapshots in paginated output. When this
* parameter is used, DescribeSnapshots only returns
* MaxResults results in a single page along with a
* NextToken response element. The remaining results of
* the initial request can be seen by sending another
* DescribeSnapshots request with the returned
* NextToken value. This value can be between 5 and
* 1000; if MaxResults is given a value larger than
* 1000, only 1000 results are returned. If this parameter is not
* used, then DescribeSnapshots returns all results. You
* cannot specify this parameter and the snapshot IDs parameter in
* the same request.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSnapshotsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 DescribeSnapshotsRequestMarshaller()
.marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getSnapshotIds() != null)
sb.append("SnapshotIds: " + getSnapshotIds() + ",");
if (getOwnerIds() != null)
sb.append("OwnerIds: " + getOwnerIds() + ",");
if (getRestorableByUserIds() != null)
sb.append("RestorableByUserIds: " + getRestorableByUserIds() + ",");
if (getFilters() != null)
sb.append("Filters: " + getFilters() + ",");
if (getNextToken() != null)
sb.append("NextToken: " + getNextToken() + ",");
if (getMaxResults() != null)
sb.append("MaxResults: " + 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 DescribeSnapshotsRequest == false)
return false;
DescribeSnapshotsRequest other = (DescribeSnapshotsRequest) obj;
if (other.getSnapshotIds() == null ^ this.getSnapshotIds() == null)
return false;
if (other.getSnapshotIds() != null
&& other.getSnapshotIds().equals(this.getSnapshotIds()) == false)
return false;
if (other.getOwnerIds() == null ^ this.getOwnerIds() == null)
return false;
if (other.getOwnerIds() != null
&& other.getOwnerIds().equals(this.getOwnerIds()) == false)
return false;
if (other.getRestorableByUserIds() == null
^ this.getRestorableByUserIds() == null)
return false;
if (other.getRestorableByUserIds() != null
&& other.getRestorableByUserIds().equals(
this.getRestorableByUserIds()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null
&& other.getFilters().equals(this.getFilters()) == 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
+ ((getSnapshotIds() == null) ? 0 : getSnapshotIds().hashCode());
hashCode = prime * hashCode
+ ((getOwnerIds() == null) ? 0 : getOwnerIds().hashCode());
hashCode = prime
* hashCode
+ ((getRestorableByUserIds() == null) ? 0
: getRestorableByUserIds().hashCode());
hashCode = prime * hashCode
+ ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode
+ ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode
+ ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public DescribeSnapshotsRequest clone() {
return (DescribeSnapshotsRequest) super.clone();
}
}