com.amazonaws.services.secretsmanager.model.ListSecretsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-secretsmanager 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.secretsmanager.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 ListSecretsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't
* included.
*
*/
private Boolean includePlannedDeletion;
/**
*
* The number of results to include in the response.
*
*
* If there are more results available, in the response, Secrets Manager includes NextToken. To get the
* next results, call ListSecrets again with the value from NextToken.
*
*/
private Integer maxResults;
/**
*
* A token that indicates where the output should continue from, if a previous call did not show all results. To get
* the next results, call ListSecrets again with this value.
*
*/
private String nextToken;
/**
*
* The filters to apply to the list of secrets.
*
*/
private java.util.List filters;
/**
*
* Secrets are listed by CreatedDate.
*
*/
private String sortOrder;
/**
*
* Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't
* included.
*
*
* @param includePlannedDeletion
* Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion
* aren't included.
*/
public void setIncludePlannedDeletion(Boolean includePlannedDeletion) {
this.includePlannedDeletion = includePlannedDeletion;
}
/**
*
* Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't
* included.
*
*
* @return Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion
* aren't included.
*/
public Boolean getIncludePlannedDeletion() {
return this.includePlannedDeletion;
}
/**
*
* Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't
* included.
*
*
* @param includePlannedDeletion
* Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion
* aren't included.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSecretsRequest withIncludePlannedDeletion(Boolean includePlannedDeletion) {
setIncludePlannedDeletion(includePlannedDeletion);
return this;
}
/**
*
* Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't
* included.
*
*
* @return Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion
* aren't included.
*/
public Boolean isIncludePlannedDeletion() {
return this.includePlannedDeletion;
}
/**
*
* The number of results to include in the response.
*
*
* If there are more results available, in the response, Secrets Manager includes NextToken. To get the
* next results, call ListSecrets again with the value from NextToken.
*
*
* @param maxResults
* The number of results to include in the response.
*
* If there are more results available, in the response, Secrets Manager includes NextToken. To
* get the next results, call ListSecrets again with the value from NextToken.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The number of results to include in the response.
*
*
* If there are more results available, in the response, Secrets Manager includes NextToken. To get the
* next results, call ListSecrets again with the value from NextToken.
*
*
* @return The number of results to include in the response.
*
* If there are more results available, in the response, Secrets Manager includes NextToken. To
* get the next results, call ListSecrets again with the value from NextToken.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The number of results to include in the response.
*
*
* If there are more results available, in the response, Secrets Manager includes NextToken. To get the
* next results, call ListSecrets again with the value from NextToken.
*
*
* @param maxResults
* The number of results to include in the response.
*
* If there are more results available, in the response, Secrets Manager includes NextToken. To
* get the next results, call ListSecrets again with the value from NextToken.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSecretsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* A token that indicates where the output should continue from, if a previous call did not show all results. To get
* the next results, call ListSecrets again with this value.
*
*
* @param nextToken
* A token that indicates where the output should continue from, if a previous call did not show all results.
* To get the next results, call ListSecrets again with this value.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* A token that indicates where the output should continue from, if a previous call did not show all results. To get
* the next results, call ListSecrets again with this value.
*
*
* @return A token that indicates where the output should continue from, if a previous call did not show all
* results. To get the next results, call ListSecrets again with this value.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* A token that indicates where the output should continue from, if a previous call did not show all results. To get
* the next results, call ListSecrets again with this value.
*
*
* @param nextToken
* A token that indicates where the output should continue from, if a previous call did not show all results.
* To get the next results, call ListSecrets again with this value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSecretsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The filters to apply to the list of secrets.
*
*
* @return The filters to apply to the list of secrets.
*/
public java.util.List getFilters() {
return filters;
}
/**
*
* The filters to apply to the list of secrets.
*
*
* @param filters
* The filters to apply to the list of secrets.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList(filters);
}
/**
*
* The filters to apply to the list of secrets.
*
*
* 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 to apply to the list of secrets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSecretsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* The filters to apply to the list of secrets.
*
*
* @param filters
* The filters to apply to the list of secrets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSecretsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* Secrets are listed by CreatedDate.
*
*
* @param sortOrder
* Secrets are listed by CreatedDate.
* @see SortOrderType
*/
public void setSortOrder(String sortOrder) {
this.sortOrder = sortOrder;
}
/**
*
* Secrets are listed by CreatedDate.
*
*
* @return Secrets are listed by CreatedDate.
* @see SortOrderType
*/
public String getSortOrder() {
return this.sortOrder;
}
/**
*
* Secrets are listed by CreatedDate.
*
*
* @param sortOrder
* Secrets are listed by CreatedDate.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrderType
*/
public ListSecretsRequest withSortOrder(String sortOrder) {
setSortOrder(sortOrder);
return this;
}
/**
*
* Secrets are listed by CreatedDate.
*
*
* @param sortOrder
* Secrets are listed by CreatedDate.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrderType
*/
public ListSecretsRequest withSortOrder(SortOrderType sortOrder) {
this.sortOrder = sortOrder.toString();
return this;
}
/**
* 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 (getIncludePlannedDeletion() != null)
sb.append("IncludePlannedDeletion: ").append(getIncludePlannedDeletion()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getSortOrder() != null)
sb.append("SortOrder: ").append(getSortOrder());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListSecretsRequest == false)
return false;
ListSecretsRequest other = (ListSecretsRequest) obj;
if (other.getIncludePlannedDeletion() == null ^ this.getIncludePlannedDeletion() == null)
return false;
if (other.getIncludePlannedDeletion() != null && other.getIncludePlannedDeletion().equals(this.getIncludePlannedDeletion()) == 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.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getSortOrder() == null ^ this.getSortOrder() == null)
return false;
if (other.getSortOrder() != null && other.getSortOrder().equals(this.getSortOrder()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIncludePlannedDeletion() == null) ? 0 : getIncludePlannedDeletion().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getSortOrder() == null) ? 0 : getSortOrder().hashCode());
return hashCode;
}
@Override
public ListSecretsRequest clone() {
return (ListSecretsRequest) super.clone();
}
}