GetRandomPasswordRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.secretsmanager.model.GetRandomPasswordRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetRandomPasswordRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

GetRandomPasswordRequest()

Constructors
Constructor and Description
`GetRandomPasswordRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetRandomPasswordRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getExcludeCharacters()` A string of the characters that you don't want in the password.
`Boolean`	`getExcludeLowercase()` Specifies whether to exclude lowercase letters from the password.
`Boolean`	`getExcludeNumbers()` Specifies whether to exclude numbers from the password.
`Boolean`	`getExcludePunctuation()` Specifies whether to exclude the following punctuation characters from the password: `! " # $ % & ' ( ) * + , - .`
`Boolean`	`getExcludeUppercase()` Specifies whether to exclude uppercase letters from the password.
`Boolean`	`getIncludeSpace()` Specifies whether to include the space character.
`Long`	`getPasswordLength()` The length of the password.
`Boolean`	`getRequireEachIncludedType()` Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
`int`	`hashCode()`
`Boolean`	`isExcludeLowercase()` Specifies whether to exclude lowercase letters from the password.
`Boolean`	`isExcludeNumbers()` Specifies whether to exclude numbers from the password.
`Boolean`	`isExcludePunctuation()` Specifies whether to exclude the following punctuation characters from the password: `! " # $ % & ' ( ) * + , - .`
`Boolean`	`isExcludeUppercase()` Specifies whether to exclude uppercase letters from the password.
`Boolean`	`isIncludeSpace()` Specifies whether to include the space character.
`Boolean`	`isRequireEachIncludedType()` Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
`void`	`setExcludeCharacters(String excludeCharacters)` A string of the characters that you don't want in the password.
`void`	`setExcludeLowercase(Boolean excludeLowercase)` Specifies whether to exclude lowercase letters from the password.
`void`	`setExcludeNumbers(Boolean excludeNumbers)` Specifies whether to exclude numbers from the password.
`void`	`setExcludePunctuation(Boolean excludePunctuation)` Specifies whether to exclude the following punctuation characters from the password: `! " # $ % & ' ( ) * + , - .`
`void`	`setExcludeUppercase(Boolean excludeUppercase)` Specifies whether to exclude uppercase letters from the password.
`void`	`setIncludeSpace(Boolean includeSpace)` Specifies whether to include the space character.
`void`	`setPasswordLength(Long passwordLength)` The length of the password.
`void`	`setRequireEachIncludedType(Boolean requireEachIncludedType)` Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
`String`	`toString()` Returns a string representation of this object.
`GetRandomPasswordRequest`	`withExcludeCharacters(String excludeCharacters)` A string of the characters that you don't want in the password.
`GetRandomPasswordRequest`	`withExcludeLowercase(Boolean excludeLowercase)` Specifies whether to exclude lowercase letters from the password.
`GetRandomPasswordRequest`	`withExcludeNumbers(Boolean excludeNumbers)` Specifies whether to exclude numbers from the password.
`GetRandomPasswordRequest`	`withExcludePunctuation(Boolean excludePunctuation)` Specifies whether to exclude the following punctuation characters from the password: `! " # $ % & ' ( ) * + , - .`
`GetRandomPasswordRequest`	`withExcludeUppercase(Boolean excludeUppercase)` Specifies whether to exclude uppercase letters from the password.
`GetRandomPasswordRequest`	`withIncludeSpace(Boolean includeSpace)` Specifies whether to include the space character.
`GetRandomPasswordRequest`	`withPasswordLength(Long passwordLength)` The length of the password.
`GetRandomPasswordRequest`	`withRequireEachIncludedType(Boolean requireEachIncludedType)` Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetRandomPasswordRequest
```
public GetRandomPasswordRequest()
```
- Method Detail
  - setPasswordLength
```
public void setPasswordLength(Long passwordLength)
```
    The length of the password. If you don't include this parameter, the default length is 32 characters.
    
    Parameters:
    
    passwordLength - The length of the password. If you don't include this parameter, the default length is 32 characters.
  - getPasswordLength
```
public Long getPasswordLength()
```
    The length of the password. If you don't include this parameter, the default length is 32 characters.
    
    Returns:
    
    The length of the password. If you don't include this parameter, the default length is 32 characters.
  - withPasswordLength
```
public GetRandomPasswordRequest withPasswordLength(Long passwordLength)
```
    The length of the password. If you don't include this parameter, the default length is 32 characters.
    
    Parameters:
    
    passwordLength - The length of the password. If you don't include this parameter, the default length is 32 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExcludeCharacters
```
public void setExcludeCharacters(String excludeCharacters)
```
    A string of the characters that you don't want in the password.
    
    Parameters:
    
    excludeCharacters - A string of the characters that you don't want in the password.
  - getExcludeCharacters
```
public String getExcludeCharacters()
```
    A string of the characters that you don't want in the password.
    
    Returns:
    
    A string of the characters that you don't want in the password.
  - withExcludeCharacters
```
public GetRandomPasswordRequest withExcludeCharacters(String excludeCharacters)
```
    A string of the characters that you don't want in the password.
    
    Parameters:
    
    excludeCharacters - A string of the characters that you don't want in the password.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExcludeNumbers
```
public void setExcludeNumbers(Boolean excludeNumbers)
```
    Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
    
    Parameters:
    
    excludeNumbers - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
  - getExcludeNumbers
```
public Boolean getExcludeNumbers()
```
    Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
    
    Returns:
    
    Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
  - withExcludeNumbers
```
public GetRandomPasswordRequest withExcludeNumbers(Boolean excludeNumbers)
```
    Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
    
    Parameters:
    
    excludeNumbers - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExcludeNumbers
```
public Boolean isExcludeNumbers()
```
    Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
    
    Returns:
    
    Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
  - setExcludePunctuation
```
public void setExcludePunctuation(Boolean excludePunctuation)
```
    Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
    
    Parameters:
    
    excludePunctuation - Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
  - getExcludePunctuation
```
public Boolean getExcludePunctuation()
```
    Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
    
    Returns:
    
    Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
  - withExcludePunctuation
```
public GetRandomPasswordRequest withExcludePunctuation(Boolean excludePunctuation)
```
    Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
    
    Parameters:
    
    excludePunctuation - Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExcludePunctuation
```
public Boolean isExcludePunctuation()
```
    Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
    
    Returns:
    
    Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
  - setExcludeUppercase
```
public void setExcludeUppercase(Boolean excludeUppercase)
```
    Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
    
    Parameters:
    
    excludeUppercase - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
  - getExcludeUppercase
```
public Boolean getExcludeUppercase()
```
    Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
    
    Returns:
    
    Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
  - withExcludeUppercase
```
public GetRandomPasswordRequest withExcludeUppercase(Boolean excludeUppercase)
```
    Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
    
    Parameters:
    
    excludeUppercase - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExcludeUppercase
```
public Boolean isExcludeUppercase()
```
    Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
    
    Returns:
    
    Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
  - setExcludeLowercase
```
public void setExcludeLowercase(Boolean excludeLowercase)
```
    Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
    
    Parameters:
    
    excludeLowercase - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
  - getExcludeLowercase
```
public Boolean getExcludeLowercase()
```
    Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
    
    Returns:
    
    Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
  - withExcludeLowercase
```
public GetRandomPasswordRequest withExcludeLowercase(Boolean excludeLowercase)
```
    Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
    
    Parameters:
    
    excludeLowercase - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExcludeLowercase
```
public Boolean isExcludeLowercase()
```
    Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
    
    Returns:
    
    Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
  - setIncludeSpace
```
public void setIncludeSpace(Boolean includeSpace)
```
    Specifies whether to include the space character. If you include this switch, the password can contain space characters.
    
    Parameters:
    
    includeSpace - Specifies whether to include the space character. If you include this switch, the password can contain space characters.
  - getIncludeSpace
```
public Boolean getIncludeSpace()
```
    Specifies whether to include the space character. If you include this switch, the password can contain space characters.
    
    Returns:
    
    Specifies whether to include the space character. If you include this switch, the password can contain space characters.
  - withIncludeSpace
```
public GetRandomPasswordRequest withIncludeSpace(Boolean includeSpace)
```
    Specifies whether to include the space character. If you include this switch, the password can contain space characters.
    
    Parameters:
    
    includeSpace - Specifies whether to include the space character. If you include this switch, the password can contain space characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeSpace
```
public Boolean isIncludeSpace()
```
    Specifies whether to include the space character. If you include this switch, the password can contain space characters.
    
    Returns:
    
    Specifies whether to include the space character. If you include this switch, the password can contain space characters.
  - setRequireEachIncludedType
```
public void setRequireEachIncludedType(Boolean 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.
    
    Parameters:
    
    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.
  - getRequireEachIncludedType
```
public Boolean getRequireEachIncludedType()
```
    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.
    
    Returns:
    
    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.
  - withRequireEachIncludedType
```
public GetRandomPasswordRequest withRequireEachIncludedType(Boolean 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRequireEachIncludedType
```
public Boolean isRequireEachIncludedType()
```
    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.
    
    Returns:
    
    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.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetRandomPasswordRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.780

Class GetRandomPasswordRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetRandomPasswordRequest

Method Detail

setPasswordLength

getPasswordLength

withPasswordLength

setExcludeCharacters

getExcludeCharacters

withExcludeCharacters

setExcludeNumbers

getExcludeNumbers

withExcludeNumbers

isExcludeNumbers

setExcludePunctuation

getExcludePunctuation

withExcludePunctuation

isExcludePunctuation

setExcludeUppercase

getExcludeUppercase

withExcludeUppercase

isExcludeUppercase

setExcludeLowercase

getExcludeLowercase

withExcludeLowercase

isExcludeLowercase

setIncludeSpace

getIncludeSpace

withIncludeSpace

isIncludeSpace

setRequireEachIncludedType

getRequireEachIncludedType

withRequireEachIncludedType

isRequireEachIncludedType

toString

equals

hashCode

clone