com.amazonaws.services.simplesystemsmanagement.model.GetParametersRequest 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 GetParametersRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with
* you from another account, you must use the full ARNs.
*
*
* To query by parameter label, use "Name": "name:label". To query by parameter version, use
* "Name": "name:version".
*
*
*
* The results for GetParameters requests are listed in alphabetical order in query responses.
*
*
*
* For information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*/
private com.amazonaws.internal.SdkInternalList names;
/**
*
* Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored
* for String and StringList parameter types.
*
*/
private Boolean withDecryption;
/**
*
* The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with
* you from another account, you must use the full ARNs.
*
*
* To query by parameter label, use "Name": "name:label". To query by parameter version, use
* "Name": "name:version".
*
*
*
* The results for GetParameters requests are listed in alphabetical order in query responses.
*
*
*
* For information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*
* @return The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared
* with you from another account, you must use the full ARNs.
*
* To query by parameter label, use "Name": "name:label". To query by parameter version, use
* "Name": "name:version".
*
*
*
* The results for GetParameters requests are listed in alphabetical order in query responses.
*
*
*
* For information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*/
public java.util.List getNames() {
if (names == null) {
names = new com.amazonaws.internal.SdkInternalList();
}
return names;
}
/**
*
* The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with
* you from another account, you must use the full ARNs.
*
*
* To query by parameter label, use "Name": "name:label". To query by parameter version, use
* "Name": "name:version".
*
*
*
* The results for GetParameters requests are listed in alphabetical order in query responses.
*
*
*
* For information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*
* @param names
* The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared
* with you from another account, you must use the full ARNs.
*
* To query by parameter label, use "Name": "name:label". To query by parameter version, use
* "Name": "name:version".
*
*
*
* The results for GetParameters requests are listed in alphabetical order in query responses.
*
*
*
* For information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*/
public void setNames(java.util.Collection names) {
if (names == null) {
this.names = null;
return;
}
this.names = new com.amazonaws.internal.SdkInternalList(names);
}
/**
*
* The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with
* you from another account, you must use the full ARNs.
*
*
* To query by parameter label, use "Name": "name:label". To query by parameter version, use
* "Name": "name:version".
*
*
*
* The results for GetParameters requests are listed in alphabetical order in query responses.
*
*
*
* For information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setNames(java.util.Collection)} or {@link #withNames(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param names
* The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared
* with you from another account, you must use the full ARNs.
*
* To query by parameter label, use "Name": "name:label". To query by parameter version, use
* "Name": "name:version".
*
*
*
* The results for GetParameters requests are listed in alphabetical order in query responses.
*
*
*
* For information about shared 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 GetParametersRequest withNames(String... names) {
if (this.names == null) {
setNames(new com.amazonaws.internal.SdkInternalList(names.length));
}
for (String ele : names) {
this.names.add(ele);
}
return this;
}
/**
*
* The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with
* you from another account, you must use the full ARNs.
*
*
* To query by parameter label, use "Name": "name:label". To query by parameter version, use
* "Name": "name:version".
*
*
*
* The results for GetParameters requests are listed in alphabetical order in query responses.
*
*
*
* For information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*
*
* @param names
* The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared
* with you from another account, you must use the full ARNs.
*
* To query by parameter label, use "Name": "name:label". To query by parameter version, use
* "Name": "name:version".
*
*
*
* The results for GetParameters requests are listed in alphabetical order in query responses.
*
*
*
* For information about shared 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 GetParametersRequest withNames(java.util.Collection names) {
setNames(names);
return this;
}
/**
*
* Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored
* for String and StringList parameter types.
*
*
* @param withDecryption
* Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is
* ignored for String and StringList parameter types.
*/
public void setWithDecryption(Boolean withDecryption) {
this.withDecryption = withDecryption;
}
/**
*
* Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored
* for String and StringList parameter types.
*
*
* @return Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is
* ignored for String and StringList parameter types.
*/
public Boolean getWithDecryption() {
return this.withDecryption;
}
/**
*
* Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored
* for String and StringList parameter types.
*
*
* @param withDecryption
* Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is
* ignored for String and StringList parameter types.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetParametersRequest withWithDecryption(Boolean withDecryption) {
setWithDecryption(withDecryption);
return this;
}
/**
*
* Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored
* for String and StringList parameter types.
*
*
* @return Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is
* ignored for String and StringList parameter types.
*/
public Boolean isWithDecryption() {
return this.withDecryption;
}
/**
* 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 (getNames() != null)
sb.append("Names: ").append(getNames()).append(",");
if (getWithDecryption() != null)
sb.append("WithDecryption: ").append(getWithDecryption());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetParametersRequest == false)
return false;
GetParametersRequest other = (GetParametersRequest) obj;
if (other.getNames() == null ^ this.getNames() == null)
return false;
if (other.getNames() != null && other.getNames().equals(this.getNames()) == false)
return false;
if (other.getWithDecryption() == null ^ this.getWithDecryption() == null)
return false;
if (other.getWithDecryption() != null && other.getWithDecryption().equals(this.getWithDecryption()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNames() == null) ? 0 : getNames().hashCode());
hashCode = prime * hashCode + ((getWithDecryption() == null) ? 0 : getWithDecryption().hashCode());
return hashCode;
}
@Override
public GetParametersRequest clone() {
return (GetParametersRequest) super.clone();
}
}