com.amazonaws.services.simplesystemsmanagement.model.DescribeParametersRequest 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 DescribeParametersRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* This data type is deprecated. Instead, use ParameterFilters.
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* Filters to limit the request results.
*
*/
private com.amazonaws.internal.SdkInternalList parameterFilters;
/**
*
* 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;
/**
*
* Lists parameters that are shared with you.
*
*
*
* By default when using this option, the command returns parameters that have been shared using a standard Resource
* Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy
* command to be returned, the associated RAM Resource Share Created From Policy must have been
* promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.
*
*
* For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*
*/
private Boolean shared;
/**
*
* This data type is deprecated. Instead, use ParameterFilters.
*
*
* @return This data type is deprecated. Instead, use ParameterFilters.
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* This data type is deprecated. Instead, use ParameterFilters.
*
*
* @param filters
* This data type is deprecated. Instead, use ParameterFilters.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* This data type is deprecated. Instead, use ParameterFilters.
*
*
* 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
* This data type is deprecated. Instead, use ParameterFilters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeParametersRequest withFilters(ParametersFilter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (ParametersFilter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* This data type is deprecated. Instead, use ParameterFilters.
*
*
* @param filters
* This data type is deprecated. Instead, use ParameterFilters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeParametersRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* Filters to limit the request results.
*
*
* @return Filters to limit the request results.
*/
public java.util.List getParameterFilters() {
if (parameterFilters == null) {
parameterFilters = new com.amazonaws.internal.SdkInternalList();
}
return parameterFilters;
}
/**
*
* Filters to limit the request results.
*
*
* @param parameterFilters
* Filters to limit the request results.
*/
public void setParameterFilters(java.util.Collection parameterFilters) {
if (parameterFilters == null) {
this.parameterFilters = null;
return;
}
this.parameterFilters = new com.amazonaws.internal.SdkInternalList(parameterFilters);
}
/**
*
* Filters to limit the request results.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setParameterFilters(java.util.Collection)} or {@link #withParameterFilters(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param parameterFilters
* Filters to limit the request results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeParametersRequest withParameterFilters(ParameterStringFilter... parameterFilters) {
if (this.parameterFilters == null) {
setParameterFilters(new com.amazonaws.internal.SdkInternalList(parameterFilters.length));
}
for (ParameterStringFilter ele : parameterFilters) {
this.parameterFilters.add(ele);
}
return this;
}
/**
*
* Filters to limit the request results.
*
*
* @param parameterFilters
* Filters to limit the request results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeParametersRequest withParameterFilters(java.util.Collection parameterFilters) {
setParameterFilters(parameterFilters);
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 DescribeParametersRequest 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 DescribeParametersRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* Lists parameters that are shared with you.
*
*
*
* By default when using this option, the command returns parameters that have been shared using a standard Resource
* Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy
* command to be returned, the associated RAM Resource Share Created From Policy must have been
* promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.
*
*
* For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*
*
* @param shared
* Lists parameters that are shared with you.
*
* By default when using this option, the command returns parameters that have been shared using a standard
* Resource Access Manager Resource Share. In order for a parameter that was shared using the
* PutResourcePolicy command to be returned, the associated
* RAM Resource Share Created From Policy must have been promoted to a standard Resource Share
* using the RAM PromoteResourceShareCreatedFromPolicy API operation.
*
*
* For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*/
public void setShared(Boolean shared) {
this.shared = shared;
}
/**
*
* Lists parameters that are shared with you.
*
*
*
* By default when using this option, the command returns parameters that have been shared using a standard Resource
* Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy
* command to be returned, the associated RAM Resource Share Created From Policy must have been
* promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.
*
*
* For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*
*
* @return Lists parameters that are shared with you.
*
* By default when using this option, the command returns parameters that have been shared using a standard
* Resource Access Manager Resource Share. In order for a parameter that was shared using the
* PutResourcePolicy command to be returned, the associated
* RAM Resource Share Created From Policy must have been promoted to a standard Resource Share
* using the RAM PromoteResourceShareCreatedFromPolicy API operation.
*
*
* For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*/
public Boolean getShared() {
return this.shared;
}
/**
*
* Lists parameters that are shared with you.
*
*
*
* By default when using this option, the command returns parameters that have been shared using a standard Resource
* Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy
* command to be returned, the associated RAM Resource Share Created From Policy must have been
* promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.
*
*
* For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*
*
* @param shared
* Lists parameters that are shared with you.
*
* By default when using this option, the command returns parameters that have been shared using a standard
* Resource Access Manager Resource Share. In order for a parameter that was shared using the
* PutResourcePolicy command to be returned, the associated
* RAM Resource Share Created From Policy must have been promoted to a standard Resource Share
* using the RAM PromoteResourceShareCreatedFromPolicy API operation.
*
*
* For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeParametersRequest withShared(Boolean shared) {
setShared(shared);
return this;
}
/**
*
* Lists parameters that are shared with you.
*
*
*
* By default when using this option, the command returns parameters that have been shared using a standard Resource
* Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy
* command to be returned, the associated RAM Resource Share Created From Policy must have been
* promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.
*
*
* For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*
*
* @return Lists parameters that are shared with you.
*
* By default when using this option, the command returns parameters that have been shared using a standard
* Resource Access Manager Resource Share. In order for a parameter that was shared using the
* PutResourcePolicy command to be returned, the associated
* RAM Resource Share Created From Policy must have been promoted to a standard Resource Share
* using the RAM PromoteResourceShareCreatedFromPolicy API operation.
*
*
* For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*/
public Boolean isShared() {
return this.shared;
}
/**
* 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 (getParameterFilters() != null)
sb.append("ParameterFilters: ").append(getParameterFilters()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getShared() != null)
sb.append("Shared: ").append(getShared());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeParametersRequest == false)
return false;
DescribeParametersRequest other = (DescribeParametersRequest) obj;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getParameterFilters() == null ^ this.getParameterFilters() == null)
return false;
if (other.getParameterFilters() != null && other.getParameterFilters().equals(this.getParameterFilters()) == 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.getShared() == null ^ this.getShared() == null)
return false;
if (other.getShared() != null && other.getShared().equals(this.getShared()) == 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 + ((getParameterFilters() == null) ? 0 : getParameterFilters().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getShared() == null) ? 0 : getShared().hashCode());
return hashCode;
}
@Override
public DescribeParametersRequest clone() {
return (DescribeParametersRequest) super.clone();
}
}