com.amazonaws.services.ec2.model.DescribeSnapshotsRequest Maven / Gradle / Ivy
/*
* Copyright 2017-2022 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.DescribeSnapshotsRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The filters.
*
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* encrypted - Indicates whether the snapshot is encrypted (true | false)
*
*
* -
*
* owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the
* user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the
* related parameter instead of this filter.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related
* parameter instead of this filter.
*
*
* -
*
* 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).
*
*
* -
*
* storage-tier - The storage tier of the snapshot (archive | standard).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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 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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 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;
/**
*
* 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;
/**
*
* Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services
* account IDs, self, and amazon.
*
*/
private com.amazonaws.internal.SdkInternalList ownerIds;
/**
*
* The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
*
*/
private com.amazonaws.internal.SdkInternalList restorableByUserIds;
/**
*
* The snapshot IDs.
*
*
* Default: Describes the snapshots for which you have create volume permissions.
*
*/
private com.amazonaws.internal.SdkInternalList snapshotIds;
/**
*
* The filters.
*
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* encrypted - Indicates whether the snapshot is encrypted (true | false)
*
*
* -
*
* owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the
* user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the
* related parameter instead of this filter.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related
* parameter instead of this filter.
*
*
* -
*
* 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).
*
*
* -
*
* storage-tier - The storage tier of the snapshot (archive | standard).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
*
*
* @return The filters.
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* encrypted - Indicates whether the snapshot is encrypted (true |
* false)
*
*
* -
*
* owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is
* not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that
* you use the related parameter instead of this filter.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the
* related parameter instead of this filter.
*
*
* -
*
* 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).
*
*
* -
*
* storage-tier - The storage tier of the snapshot (archive |
* standard).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that
* have a tag with the key Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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;
}
/**
*
* The filters.
*
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* encrypted - Indicates whether the snapshot is encrypted (true | false)
*
*
* -
*
* owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the
* user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the
* related parameter instead of this filter.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related
* parameter instead of this filter.
*
*
* -
*
* 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).
*
*
* -
*
* storage-tier - The storage tier of the snapshot (archive | standard).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* encrypted - Indicates whether the snapshot is encrypted (true |
* false)
*
*
* -
*
* owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is
* not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you
* use the related parameter instead of this filter.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the
* related parameter instead of this filter.
*
*
* -
*
* 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).
*
*
* -
*
* storage-tier - The storage tier of the snapshot (archive | standard
* ).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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);
}
/**
*
* The filters.
*
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* encrypted - Indicates whether the snapshot is encrypted (true | false)
*
*
* -
*
* owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the
* user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the
* related parameter instead of this filter.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related
* parameter instead of this filter.
*
*
* -
*
* 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).
*
*
* -
*
* storage-tier - The storage tier of the snapshot (archive | standard).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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
* The filters.
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* encrypted - Indicates whether the snapshot is encrypted (true |
* false)
*
*
* -
*
* owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is
* not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you
* use the related parameter instead of this filter.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the
* related parameter instead of this filter.
*
*
* -
*
* 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).
*
*
* -
*
* storage-tier - The storage tier of the snapshot (archive | standard
* ).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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;
}
/**
*
* The filters.
*
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* encrypted - Indicates whether the snapshot is encrypted (true | false)
*
*
* -
*
* owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the
* user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the
* related parameter instead of this filter.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related
* parameter instead of this filter.
*
*
* -
*
* 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).
*
*
* -
*
* storage-tier - The storage tier of the snapshot (archive | standard).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* volume-id - The ID of the volume the snapshot is for.
*
*
* -
*
* volume-size - The size of the volume, in GiB.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* description - A description of the snapshot.
*
*
* -
*
* encrypted - Indicates whether the snapshot is encrypted (true |
* false)
*
*
* -
*
* owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is
* not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you
* use the related parameter instead of this filter.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the
* related parameter instead of this filter.
*
*
* -
*
* 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).
*
*
* -
*
* storage-tier - The storage tier of the snapshot (archive | standard
* ).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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 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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 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 1,000; if MaxResults is given a
* value larger than 1,000, only 1,000 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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 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 1,000; if MaxResults is given
* a value larger than 1,000, only 1,000 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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 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 1,000; if MaxResults is given a
* value larger than 1,000, only 1,000 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;
}
/**
*
* 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;
}
/**
*
* Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services
* account IDs, self, and amazon.
*
*
* @return Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web
* Services account IDs, self, and amazon.
*/
public java.util.List getOwnerIds() {
if (ownerIds == null) {
ownerIds = new com.amazonaws.internal.SdkInternalList();
}
return ownerIds;
}
/**
*
* Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services
* account IDs, self, and amazon.
*
*
* @param ownerIds
* Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web
* Services account IDs, self, and amazon.
*/
public void setOwnerIds(java.util.Collection ownerIds) {
if (ownerIds == null) {
this.ownerIds = null;
return;
}
this.ownerIds = new com.amazonaws.internal.SdkInternalList(ownerIds);
}
/**
*
* Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services
* account IDs, self, and amazon.
*
*
* 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
* Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web
* Services account IDs, self, and amazon.
* @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;
}
/**
*
* Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services
* account IDs, self, and amazon.
*
*
* @param ownerIds
* Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web
* Services account IDs, self, and amazon.
* @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;
}
/**
*
* The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
*
*
* @return The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
*/
public java.util.List getRestorableByUserIds() {
if (restorableByUserIds == null) {
restorableByUserIds = new com.amazonaws.internal.SdkInternalList();
}
return restorableByUserIds;
}
/**
*
* The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
*
*
* @param restorableByUserIds
* The IDs of the Amazon Web Services accounts 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);
}
/**
*
* The IDs of the Amazon Web Services accounts 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
* The IDs of the Amazon Web Services accounts 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;
}
/**
*
* The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
*
*
* @param restorableByUserIds
* The IDs of the Amazon Web Services accounts 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;
}
/**
*
* The snapshot IDs.
*
*
* Default: Describes the snapshots for which you have create volume permissions.
*
*
* @return The snapshot IDs.
*
* Default: Describes the snapshots for which you have create volume permissions.
*/
public java.util.List getSnapshotIds() {
if (snapshotIds == null) {
snapshotIds = new com.amazonaws.internal.SdkInternalList();
}
return snapshotIds;
}
/**
*
* The snapshot IDs.
*
*
* Default: Describes the snapshots for which you have create volume permissions.
*
*
* @param snapshotIds
* The snapshot IDs.
*
* Default: Describes the snapshots for which you have create volume permissions.
*/
public void setSnapshotIds(java.util.Collection snapshotIds) {
if (snapshotIds == null) {
this.snapshotIds = null;
return;
}
this.snapshotIds = new com.amazonaws.internal.SdkInternalList(snapshotIds);
}
/**
*
* The snapshot IDs.
*
*
* Default: Describes the snapshots for which you have create volume 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
* The snapshot IDs.
*
* Default: Describes the snapshots for which you have create volume 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;
}
/**
*
* The snapshot IDs.
*
*
* Default: Describes the snapshots for which you have create volume permissions.
*
*
* @param snapshotIds
* The snapshot IDs.
*
* Default: Describes the snapshots for which you have create volume 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;
}
/**
* 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. 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 (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getOwnerIds() != null)
sb.append("OwnerIds: ").append(getOwnerIds()).append(",");
if (getRestorableByUserIds() != null)
sb.append("RestorableByUserIds: ").append(getRestorableByUserIds()).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 DescribeSnapshotsRequest == false)
return false;
DescribeSnapshotsRequest other = (DescribeSnapshotsRequest) obj;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
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.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.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 + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getOwnerIds() == null) ? 0 : getOwnerIds().hashCode());
hashCode = prime * hashCode + ((getRestorableByUserIds() == null) ? 0 : getRestorableByUserIds().hashCode());
hashCode = prime * hashCode + ((getSnapshotIds() == null) ? 0 : getSnapshotIds().hashCode());
return hashCode;
}
@Override
public DescribeSnapshotsRequest clone() {
return (DescribeSnapshotsRequest) super.clone();
}
}