/* * Copyright 2018-2023 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.cloudhsmv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeBackupsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The NextToken value that you received in the previous response. Use this value to get more backups. *

*/ private String nextToken; /** *

* The maximum number of backups to return in the response. When there are more backups than the number you specify, * the response contains a NextToken value. *

*/ private Integer maxResults; /** *

* One or more filters to limit the items returned in the response. *

*

* Use the backupIds filter to return only the specified backups. Specify backups by their backup * identifier (ID). *

*

* Use the sourceBackupIds filter to return only the backups created from a source backup. The * sourceBackupID of a source backup is returned by the CopyBackupToRegion operation. *

*

* Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by * their cluster identifier (ID). *

*

* Use the states filter to return only backups that match the specified state. *

*

* Use the neverExpires filter to return backups filtered by the value in the neverExpires * parameter. True returns all backups exempt from the backup retention policy. False * returns all backups with a backup retention policy defined at the cluster. *

*/ private java.util.Map> filters; /** *

* Designates whether or not to sort the return backups by ascending chronological order of generation. *

*/ private Boolean sortAscending; /** *

* The NextToken value that you received in the previous response. Use this value to get more backups. *

* * @param nextToken * The NextToken value that you received in the previous response. Use this value to get more * backups. */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** *

* The NextToken value that you received in the previous response. Use this value to get more backups. *

* * @return The NextToken value that you received in the previous response. Use this value to get more * backups. */ public String getNextToken() { return this.nextToken; } /** *

* The NextToken value that you received in the previous response. Use this value to get more backups. *

* * @param nextToken * The NextToken value that you received in the previous response. Use this value to get more * backups. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeBackupsRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** *

* The maximum number of backups to return in the response. When there are more backups than the number you specify, * the response contains a NextToken value. *

* * @param maxResults * The maximum number of backups to return in the response. When there are more backups than the number you * specify, the response contains a NextToken value. */ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** *

* The maximum number of backups to return in the response. When there are more backups than the number you specify, * the response contains a NextToken value. *

* * @return The maximum number of backups to return in the response. When there are more backups than the number you * specify, the response contains a NextToken value. */ public Integer getMaxResults() { return this.maxResults; } /** *

* The maximum number of backups to return in the response. When there are more backups than the number you specify, * the response contains a NextToken value. *

* * @param maxResults * The maximum number of backups to return in the response. When there are more backups than the number you * specify, the response contains a NextToken value. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeBackupsRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** *

* One or more filters to limit the items returned in the response. *

*

* Use the backupIds filter to return only the specified backups. Specify backups by their backup * identifier (ID). *

*

* Use the sourceBackupIds filter to return only the backups created from a source backup. The * sourceBackupID of a source backup is returned by the CopyBackupToRegion operation. *

*

* Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by * their cluster identifier (ID). *

*

* Use the states filter to return only backups that match the specified state. *

*

* Use the neverExpires filter to return backups filtered by the value in the neverExpires * parameter. True returns all backups exempt from the backup retention policy. False * returns all backups with a backup retention policy defined at the cluster. *

* * @return One or more filters to limit the items returned in the response.

*

* Use the backupIds filter to return only the specified backups. Specify backups by their * backup identifier (ID). *

*

* Use the sourceBackupIds filter to return only the backups created from a source backup. The * sourceBackupID of a source backup is returned by the CopyBackupToRegion operation. *

*

* Use the clusterIds filter to return only the backups for the specified clusters. Specify * clusters by their cluster identifier (ID). *

*

* Use the states filter to return only backups that match the specified state. *

*

* Use the neverExpires filter to return backups filtered by the value in the * neverExpires parameter. True returns all backups exempt from the backup * retention policy. False returns all backups with a backup retention policy defined at the * cluster. */ public java.util.Map> getFilters() { return filters; } /** *

* One or more filters to limit the items returned in the response. *

*

* Use the backupIds filter to return only the specified backups. Specify backups by their backup * identifier (ID). *

*

* Use the sourceBackupIds filter to return only the backups created from a source backup. The * sourceBackupID of a source backup is returned by the CopyBackupToRegion operation. *

*

* Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by * their cluster identifier (ID). *

*

* Use the states filter to return only backups that match the specified state. *

*

* Use the neverExpires filter to return backups filtered by the value in the neverExpires * parameter. True returns all backups exempt from the backup retention policy. False * returns all backups with a backup retention policy defined at the cluster. *

* * @param filters * One or more filters to limit the items returned in the response.

*

* Use the backupIds filter to return only the specified backups. Specify backups by their * backup identifier (ID). *

*

* Use the sourceBackupIds filter to return only the backups created from a source backup. The * sourceBackupID of a source backup is returned by the CopyBackupToRegion operation. *

*

* Use the clusterIds filter to return only the backups for the specified clusters. Specify * clusters by their cluster identifier (ID). *

*

* Use the states filter to return only backups that match the specified state. *

*

* Use the neverExpires filter to return backups filtered by the value in the * neverExpires parameter. True returns all backups exempt from the backup * retention policy. False returns all backups with a backup retention policy defined at the * cluster. */ public void setFilters(java.util.Map> filters) { this.filters = filters; } /** *

* One or more filters to limit the items returned in the response. *

*

* Use the backupIds filter to return only the specified backups. Specify backups by their backup * identifier (ID). *

*

* Use the sourceBackupIds filter to return only the backups created from a source backup. The * sourceBackupID of a source backup is returned by the CopyBackupToRegion operation. *

*

* Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by * their cluster identifier (ID). *

*

* Use the states filter to return only backups that match the specified state. *

*

* Use the neverExpires filter to return backups filtered by the value in the neverExpires * parameter. True returns all backups exempt from the backup retention policy. False * returns all backups with a backup retention policy defined at the cluster. *

* * @param filters * One or more filters to limit the items returned in the response.

*

* Use the backupIds filter to return only the specified backups. Specify backups by their * backup identifier (ID). *

*

* Use the sourceBackupIds filter to return only the backups created from a source backup. The * sourceBackupID of a source backup is returned by the CopyBackupToRegion operation. *

*

* Use the clusterIds filter to return only the backups for the specified clusters. Specify * clusters by their cluster identifier (ID). *

*

* Use the states filter to return only backups that match the specified state. *

*

* Use the neverExpires filter to return backups filtered by the value in the * neverExpires parameter. True returns all backups exempt from the backup * retention policy. False returns all backups with a backup retention policy defined at the * cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeBackupsRequest withFilters(java.util.Map> filters) { setFilters(filters); return this; } /** * Add a single Filters entry * * @see DescribeBackupsRequest#withFilters * @returns a reference to this object so that method calls can be chained together. */ public DescribeBackupsRequest addFiltersEntry(String key, java.util.List value) { if (null == this.filters) { this.filters = new java.util.HashMap>(); } if (this.filters.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.filters.put(key, value); return this; } /** * Removes all the entries added into Filters. * * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeBackupsRequest clearFiltersEntries() { this.filters = null; return this; } /** *

* Designates whether or not to sort the return backups by ascending chronological order of generation. *

* * @param sortAscending * Designates whether or not to sort the return backups by ascending chronological order of generation. */ public void setSortAscending(Boolean sortAscending) { this.sortAscending = sortAscending; } /** *

* Designates whether or not to sort the return backups by ascending chronological order of generation. *

* * @return Designates whether or not to sort the return backups by ascending chronological order of generation. */ public Boolean getSortAscending() { return this.sortAscending; } /** *

* Designates whether or not to sort the return backups by ascending chronological order of generation. *

* * @param sortAscending * Designates whether or not to sort the return backups by ascending chronological order of generation. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeBackupsRequest withSortAscending(Boolean sortAscending) { setSortAscending(sortAscending); return this; } /** *

* Designates whether or not to sort the return backups by ascending chronological order of generation. *

* * @return Designates whether or not to sort the return backups by ascending chronological order of generation. */ public Boolean isSortAscending() { return this.sortAscending; } /** * 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 (getNextToken() != null) sb.append("NextToken: ").append(getNextToken()).append(","); if (getMaxResults() != null) sb.append("MaxResults: ").append(getMaxResults()).append(","); if (getFilters() != null) sb.append("Filters: ").append(getFilters()).append(","); if (getSortAscending() != null) sb.append("SortAscending: ").append(getSortAscending()); 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.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; if (other.getFilters() == null ^ this.getFilters() == null) return false; if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false; if (other.getSortAscending() == null ^ this.getSortAscending() == null) return false; if (other.getSortAscending() != null && other.getSortAscending().equals(this.getSortAscending()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); hashCode = prime * hashCode + ((getSortAscending() == null) ? 0 : getSortAscending().hashCode()); return hashCode; } @Override public DescribeBackupsRequest clone() { return (DescribeBackupsRequest) super.clone(); } }