com.amazonaws.services.secretsmanager.model.GetRandomPasswordRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-secretsmanager Show documentation
/*
* Copyright 2017-2022 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 GetRandomPasswordRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The length of the password. If you don't include this parameter, the default length is 32 characters.
*
*/
private Long passwordLength;
/**
*
* A string of the characters that you don't want in the password.
*
*/
private String excludeCharacters;
/**
*
* Specifies whether to exclude numbers from the password. If you don't include this switch, the password can
* contain numbers.
*
*/
private Boolean excludeNumbers;
/**
*
* Specifies whether to exclude the following punctuation characters from the password:
* ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this
* switch, the password can contain punctuation.
*
*/
private Boolean excludePunctuation;
/**
*
* Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password
* can contain uppercase letters.
*
*/
private Boolean excludeUppercase;
/**
*
* Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password
* can contain lowercase letters.
*
*/
private Boolean excludeLowercase;
/**
*
* Specifies whether to include the space character. If you include this switch, the password can contain space
* characters.
*
*/
private Boolean includeSpace;
/**
*
* Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you
* don't include this switch, the password contains at least one of every character type.
*
*/
private Boolean requireEachIncludedType;
/**
*
* The length of the password. If you don't include this parameter, the default length is 32 characters.
*
*
* @param passwordLength
* The length of the password. If you don't include this parameter, the default length is 32 characters.
*/
public void setPasswordLength(Long passwordLength) {
this.passwordLength = passwordLength;
}
/**
*
* The length of the password. If you don't include this parameter, the default length is 32 characters.
*
*
* @return The length of the password. If you don't include this parameter, the default length is 32 characters.
*/
public Long getPasswordLength() {
return this.passwordLength;
}
/**
*
* The length of the password. If you don't include this parameter, the default length is 32 characters.
*
*
* @param passwordLength
* The length of the password. If you don't include this parameter, the default length is 32 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetRandomPasswordRequest withPasswordLength(Long passwordLength) {
setPasswordLength(passwordLength);
return this;
}
/**
*
* A string of the characters that you don't want in the password.
*
*
* @param excludeCharacters
* A string of the characters that you don't want in the password.
*/
public void setExcludeCharacters(String excludeCharacters) {
this.excludeCharacters = excludeCharacters;
}
/**
*
* A string of the characters that you don't want in the password.
*
*
* @return A string of the characters that you don't want in the password.
*/
public String getExcludeCharacters() {
return this.excludeCharacters;
}
/**
*
* A string of the characters that you don't want in the password.
*
*
* @param excludeCharacters
* A string of the characters that you don't want in the password.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetRandomPasswordRequest withExcludeCharacters(String excludeCharacters) {
setExcludeCharacters(excludeCharacters);
return this;
}
/**
*
* Specifies whether to exclude numbers from the password. If you don't include this switch, the password can
* contain numbers.
*
*
* @param excludeNumbers
* Specifies whether to exclude numbers from the password. If you don't include this switch, the password can
* contain numbers.
*/
public void setExcludeNumbers(Boolean excludeNumbers) {
this.excludeNumbers = excludeNumbers;
}
/**
*
* Specifies whether to exclude numbers from the password. If you don't include this switch, the password can
* contain numbers.
*
*
* @return Specifies whether to exclude numbers from the password. If you don't include this switch, the password
* can contain numbers.
*/
public Boolean getExcludeNumbers() {
return this.excludeNumbers;
}
/**
*
* Specifies whether to exclude numbers from the password. If you don't include this switch, the password can
* contain numbers.
*
*
* @param excludeNumbers
* Specifies whether to exclude numbers from the password. If you don't include this switch, the password can
* contain numbers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetRandomPasswordRequest withExcludeNumbers(Boolean excludeNumbers) {
setExcludeNumbers(excludeNumbers);
return this;
}
/**
*
* Specifies whether to exclude numbers from the password. If you don't include this switch, the password can
* contain numbers.
*
*
* @return Specifies whether to exclude numbers from the password. If you don't include this switch, the password
* can contain numbers.
*/
public Boolean isExcludeNumbers() {
return this.excludeNumbers;
}
/**
*
* Specifies whether to exclude the following punctuation characters from the password:
* ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this
* switch, the password can contain punctuation.
*
*
* @param excludePunctuation
* Specifies whether to exclude the following punctuation characters from the password:
* ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't
* include this switch, the password can contain punctuation.
*/
public void setExcludePunctuation(Boolean excludePunctuation) {
this.excludePunctuation = excludePunctuation;
}
/**
*
* Specifies whether to exclude the following punctuation characters from the password:
* ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this
* switch, the password can contain punctuation.
*
*
* @return Specifies whether to exclude the following punctuation characters from the password:
* ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't
* include this switch, the password can contain punctuation.
*/
public Boolean getExcludePunctuation() {
return this.excludePunctuation;
}
/**
*
* Specifies whether to exclude the following punctuation characters from the password:
* ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this
* switch, the password can contain punctuation.
*
*
* @param excludePunctuation
* Specifies whether to exclude the following punctuation characters from the password:
* ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't
* include this switch, the password can contain punctuation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetRandomPasswordRequest withExcludePunctuation(Boolean excludePunctuation) {
setExcludePunctuation(excludePunctuation);
return this;
}
/**
*
* Specifies whether to exclude the following punctuation characters from the password:
* ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this
* switch, the password can contain punctuation.
*
*
* @return Specifies whether to exclude the following punctuation characters from the password:
* ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't
* include this switch, the password can contain punctuation.
*/
public Boolean isExcludePunctuation() {
return this.excludePunctuation;
}
/**
*
* Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password
* can contain uppercase letters.
*
*
* @param excludeUppercase
* Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the
* password can contain uppercase letters.
*/
public void setExcludeUppercase(Boolean excludeUppercase) {
this.excludeUppercase = excludeUppercase;
}
/**
*
* Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password
* can contain uppercase letters.
*
*
* @return Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the
* password can contain uppercase letters.
*/
public Boolean getExcludeUppercase() {
return this.excludeUppercase;
}
/**
*
* Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password
* can contain uppercase letters.
*
*
* @param excludeUppercase
* Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the
* password can contain uppercase letters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetRandomPasswordRequest withExcludeUppercase(Boolean excludeUppercase) {
setExcludeUppercase(excludeUppercase);
return this;
}
/**
*
* Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password
* can contain uppercase letters.
*
*
* @return Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the
* password can contain uppercase letters.
*/
public Boolean isExcludeUppercase() {
return this.excludeUppercase;
}
/**
*
* Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password
* can contain lowercase letters.
*
*
* @param excludeLowercase
* Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the
* password can contain lowercase letters.
*/
public void setExcludeLowercase(Boolean excludeLowercase) {
this.excludeLowercase = excludeLowercase;
}
/**
*
* Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password
* can contain lowercase letters.
*
*
* @return Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the
* password can contain lowercase letters.
*/
public Boolean getExcludeLowercase() {
return this.excludeLowercase;
}
/**
*
* Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password
* can contain lowercase letters.
*
*
* @param excludeLowercase
* Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the
* password can contain lowercase letters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetRandomPasswordRequest withExcludeLowercase(Boolean excludeLowercase) {
setExcludeLowercase(excludeLowercase);
return this;
}
/**
*
* Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password
* can contain lowercase letters.
*
*
* @return Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the
* password can contain lowercase letters.
*/
public Boolean isExcludeLowercase() {
return this.excludeLowercase;
}
/**
*
* Specifies whether to include the space character. If you include this switch, the password can contain space
* characters.
*
*
* @param includeSpace
* Specifies whether to include the space character. If you include this switch, the password can contain
* space characters.
*/
public void setIncludeSpace(Boolean includeSpace) {
this.includeSpace = includeSpace;
}
/**
*
* Specifies whether to include the space character. If you include this switch, the password can contain space
* characters.
*
*
* @return Specifies whether to include the space character. If you include this switch, the password can contain
* space characters.
*/
public Boolean getIncludeSpace() {
return this.includeSpace;
}
/**
*
* Specifies whether to include the space character. If you include this switch, the password can contain space
* characters.
*
*
* @param includeSpace
* Specifies whether to include the space character. If you include this switch, the password can contain
* space characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetRandomPasswordRequest withIncludeSpace(Boolean includeSpace) {
setIncludeSpace(includeSpace);
return this;
}
/**
*
* Specifies whether to include the space character. If you include this switch, the password can contain space
* characters.
*
*
* @return Specifies whether to include the space character. If you include this switch, the password can contain
* space characters.
*/
public Boolean isIncludeSpace() {
return this.includeSpace;
}
/**
*
* Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you
* don't include this switch, the password contains at least one of every character type.
*
*
* @param requireEachIncludedType
* Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If
* you don't include this switch, the password contains at least one of every character type.
*/
public void setRequireEachIncludedType(Boolean requireEachIncludedType) {
this.requireEachIncludedType = requireEachIncludedType;
}
/**
*
* Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you
* don't include this switch, the password contains at least one of every character type.
*
*
* @return Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If
* you don't include this switch, the password contains at least one of every character type.
*/
public Boolean getRequireEachIncludedType() {
return this.requireEachIncludedType;
}
/**
*
* Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you
* don't include this switch, the password contains at least one of every character type.
*
*
* @param requireEachIncludedType
* Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If
* you don't include this switch, the password contains at least one of every character type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetRandomPasswordRequest withRequireEachIncludedType(Boolean requireEachIncludedType) {
setRequireEachIncludedType(requireEachIncludedType);
return this;
}
/**
*
* Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you
* don't include this switch, the password contains at least one of every character type.
*
*
* @return Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If
* you don't include this switch, the password contains at least one of every character type.
*/
public Boolean isRequireEachIncludedType() {
return this.requireEachIncludedType;
}
/**
* 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 (getPasswordLength() != null)
sb.append("PasswordLength: ").append(getPasswordLength()).append(",");
if (getExcludeCharacters() != null)
sb.append("ExcludeCharacters: ").append(getExcludeCharacters()).append(",");
if (getExcludeNumbers() != null)
sb.append("ExcludeNumbers: ").append(getExcludeNumbers()).append(",");
if (getExcludePunctuation() != null)
sb.append("ExcludePunctuation: ").append(getExcludePunctuation()).append(",");
if (getExcludeUppercase() != null)
sb.append("ExcludeUppercase: ").append(getExcludeUppercase()).append(",");
if (getExcludeLowercase() != null)
sb.append("ExcludeLowercase: ").append(getExcludeLowercase()).append(",");
if (getIncludeSpace() != null)
sb.append("IncludeSpace: ").append(getIncludeSpace()).append(",");
if (getRequireEachIncludedType() != null)
sb.append("RequireEachIncludedType: ").append(getRequireEachIncludedType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetRandomPasswordRequest == false)
return false;
GetRandomPasswordRequest other = (GetRandomPasswordRequest) obj;
if (other.getPasswordLength() == null ^ this.getPasswordLength() == null)
return false;
if (other.getPasswordLength() != null && other.getPasswordLength().equals(this.getPasswordLength()) == false)
return false;
if (other.getExcludeCharacters() == null ^ this.getExcludeCharacters() == null)
return false;
if (other.getExcludeCharacters() != null && other.getExcludeCharacters().equals(this.getExcludeCharacters()) == false)
return false;
if (other.getExcludeNumbers() == null ^ this.getExcludeNumbers() == null)
return false;
if (other.getExcludeNumbers() != null && other.getExcludeNumbers().equals(this.getExcludeNumbers()) == false)
return false;
if (other.getExcludePunctuation() == null ^ this.getExcludePunctuation() == null)
return false;
if (other.getExcludePunctuation() != null && other.getExcludePunctuation().equals(this.getExcludePunctuation()) == false)
return false;
if (other.getExcludeUppercase() == null ^ this.getExcludeUppercase() == null)
return false;
if (other.getExcludeUppercase() != null && other.getExcludeUppercase().equals(this.getExcludeUppercase()) == false)
return false;
if (other.getExcludeLowercase() == null ^ this.getExcludeLowercase() == null)
return false;
if (other.getExcludeLowercase() != null && other.getExcludeLowercase().equals(this.getExcludeLowercase()) == false)
return false;
if (other.getIncludeSpace() == null ^ this.getIncludeSpace() == null)
return false;
if (other.getIncludeSpace() != null && other.getIncludeSpace().equals(this.getIncludeSpace()) == false)
return false;
if (other.getRequireEachIncludedType() == null ^ this.getRequireEachIncludedType() == null)
return false;
if (other.getRequireEachIncludedType() != null && other.getRequireEachIncludedType().equals(this.getRequireEachIncludedType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPasswordLength() == null) ? 0 : getPasswordLength().hashCode());
hashCode = prime * hashCode + ((getExcludeCharacters() == null) ? 0 : getExcludeCharacters().hashCode());
hashCode = prime * hashCode + ((getExcludeNumbers() == null) ? 0 : getExcludeNumbers().hashCode());
hashCode = prime * hashCode + ((getExcludePunctuation() == null) ? 0 : getExcludePunctuation().hashCode());
hashCode = prime * hashCode + ((getExcludeUppercase() == null) ? 0 : getExcludeUppercase().hashCode());
hashCode = prime * hashCode + ((getExcludeLowercase() == null) ? 0 : getExcludeLowercase().hashCode());
hashCode = prime * hashCode + ((getIncludeSpace() == null) ? 0 : getIncludeSpace().hashCode());
hashCode = prime * hashCode + ((getRequireEachIncludedType() == null) ? 0 : getRequireEachIncludedType().hashCode());
return hashCode;
}
@Override
public GetRandomPasswordRequest clone() {
return (GetRandomPasswordRequest) super.clone();
}
}