com.amazonaws.services.simplesystemsmanagement.model.ListDocumentsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssm 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.simplesystemsmanagement.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 ListDocumentsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* This data type is deprecated. Instead, use Filters.
*
*/
private com.amazonaws.internal.SdkInternalList documentFilterList;
/**
*
* One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results.
* For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys
* include Owner, Name, PlatformTypes, DocumentType, and
* TargetType. For example, to return documents you own use Key=Owner,Values=Self. To
* specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
*
*
*
* This API operation only supports filtering documents by using a single tag key and one or more tag values. For
* example: Key=tag:tagName,Values=valueName1,valueName2
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The maximum number of items to return for this call. The call also returns a token that you can specify in a
* subsequent call to get the next set of results.
*
*/
private Integer maxResults;
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*/
private String nextToken;
/**
*
* This data type is deprecated. Instead, use Filters.
*
*
* @return This data type is deprecated. Instead, use Filters.
*/
public java.util.List getDocumentFilterList() {
if (documentFilterList == null) {
documentFilterList = new com.amazonaws.internal.SdkInternalList();
}
return documentFilterList;
}
/**
*
* This data type is deprecated. Instead, use Filters.
*
*
* @param documentFilterList
* This data type is deprecated. Instead, use Filters.
*/
public void setDocumentFilterList(java.util.Collection documentFilterList) {
if (documentFilterList == null) {
this.documentFilterList = null;
return;
}
this.documentFilterList = new com.amazonaws.internal.SdkInternalList(documentFilterList);
}
/**
*
* This data type is deprecated. Instead, use Filters.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDocumentFilterList(java.util.Collection)} or {@link #withDocumentFilterList(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param documentFilterList
* This data type is deprecated. Instead, use Filters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDocumentsRequest withDocumentFilterList(DocumentFilter... documentFilterList) {
if (this.documentFilterList == null) {
setDocumentFilterList(new com.amazonaws.internal.SdkInternalList(documentFilterList.length));
}
for (DocumentFilter ele : documentFilterList) {
this.documentFilterList.add(ele);
}
return this;
}
/**
*
* This data type is deprecated. Instead, use Filters.
*
*
* @param documentFilterList
* This data type is deprecated. Instead, use Filters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDocumentsRequest withDocumentFilterList(java.util.Collection documentFilterList) {
setDocumentFilterList(documentFilterList);
return this;
}
/**
*
* One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results.
* For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys
* include Owner, Name, PlatformTypes, DocumentType, and
* TargetType. For example, to return documents you own use Key=Owner,Values=Self. To
* specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
*
*
*
* This API operation only supports filtering documents by using a single tag key and one or more tag values. For
* example: Key=tag:tagName,Values=valueName1,valueName2
*
*
*
* @return One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of
* results. For keys, you can specify one or more key-value pair tags that have been applied to a document.
* Other valid keys include Owner, Name, PlatformTypes,
* DocumentType, and TargetType. For example, to return documents you own use
* Key=Owner,Values=Self. To specify a custom key-value pair, use the format
* Key=tag:tagName,Values=valueName.
*
* This API operation only supports filtering documents by using a single tag key and one or more tag
* values. For example: Key=tag:tagName,Values=valueName1,valueName2
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results.
* For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys
* include Owner, Name, PlatformTypes, DocumentType, and
* TargetType. For example, to return documents you own use Key=Owner,Values=Self. To
* specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
*
*
*
* This API operation only supports filtering documents by using a single tag key and one or more tag values. For
* example: Key=tag:tagName,Values=valueName1,valueName2
*
*
*
* @param filters
* One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of
* results. For keys, you can specify one or more key-value pair tags that have been applied to a document.
* Other valid keys include Owner, Name, PlatformTypes,
* DocumentType, and TargetType. For example, to return documents you own use
* Key=Owner,Values=Self. To specify a custom key-value pair, use the format
* Key=tag:tagName,Values=valueName.
*
* This API operation only supports filtering documents by using a single tag key and one or more tag values.
* For example: Key=tag:tagName,Values=valueName1,valueName2
*
*/
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 DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results.
* For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys
* include Owner, Name, PlatformTypes, DocumentType, and
* TargetType. For example, to return documents you own use Key=Owner,Values=Self. To
* specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
*
*
*
* This API operation only supports filtering documents by using a single tag key and one or more tag values. For
* example: Key=tag:tagName,Values=valueName1,valueName2
*
*
*
* 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 DocumentKeyValuesFilter objects. Use a filter to return a more specific list of
* results. For keys, you can specify one or more key-value pair tags that have been applied to a document.
* Other valid keys include Owner, Name, PlatformTypes,
* DocumentType, and TargetType. For example, to return documents you own use
* Key=Owner,Values=Self. To specify a custom key-value pair, use the format
* Key=tag:tagName,Values=valueName.
*
* This API operation only supports filtering documents by using a single tag key and one or more tag values.
* For example: Key=tag:tagName,Values=valueName1,valueName2
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDocumentsRequest withFilters(DocumentKeyValuesFilter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (DocumentKeyValuesFilter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results.
* For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys
* include Owner, Name, PlatformTypes, DocumentType, and
* TargetType. For example, to return documents you own use Key=Owner,Values=Self. To
* specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
*
*
*
* This API operation only supports filtering documents by using a single tag key and one or more tag values. For
* example: Key=tag:tagName,Values=valueName1,valueName2
*
*
*
* @param filters
* One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of
* results. For keys, you can specify one or more key-value pair tags that have been applied to a document.
* Other valid keys include Owner, Name, PlatformTypes,
* DocumentType, and TargetType. For example, to return documents you own use
* Key=Owner,Values=Self. To specify a custom key-value pair, use the format
* Key=tag:tagName,Values=valueName.
*
* This API operation only supports filtering documents by using a single tag key and one or more tag values.
* For example: Key=tag:tagName,Values=valueName1,valueName2
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDocumentsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The maximum number of items to return for this call. The call also returns a token that you can specify in a
* subsequent call to get the next set of results.
*
*
* @param maxResults
* The maximum number of items to return for this call. The call also returns a token that you can specify in
* a subsequent call to get the next set of results.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of items to return for this call. The call also returns a token that you can specify in a
* subsequent call to get the next set of results.
*
*
* @return The maximum number of items to return for this call. The call also returns a token that you can specify
* in a subsequent call to get the next set of results.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of items to return for this call. The call also returns a token that you can specify in a
* subsequent call to get the next set of results.
*
*
* @param maxResults
* The maximum number of items to return for this call. The call also returns a token that you can specify in
* a subsequent call to get the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDocumentsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @param nextToken
* The token for the next set of items to return. (You received this token from a previous call.)
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @return The token for the next set of items to return. (You received this token from a previous call.)
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @param nextToken
* The token for the next set of items to return. (You received this token from a previous call.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDocumentsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 (getDocumentFilterList() != null)
sb.append("DocumentFilterList: ").append(getDocumentFilterList()).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());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListDocumentsRequest == false)
return false;
ListDocumentsRequest other = (ListDocumentsRequest) obj;
if (other.getDocumentFilterList() == null ^ this.getDocumentFilterList() == null)
return false;
if (other.getDocumentFilterList() != null && other.getDocumentFilterList().equals(this.getDocumentFilterList()) == 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.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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDocumentFilterList() == null) ? 0 : getDocumentFilterList().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public ListDocumentsRequest clone() {
return (ListDocumentsRequest) super.clone();
}
}