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 that includes characters that should not be included in the generated password.
`Boolean`	`getExcludeLowercase()` Specifies that the generated password should not include lowercase letters.
`Boolean`	`getExcludeNumbers()` Specifies that the generated password should not include digits.
`Boolean`	`getExcludePunctuation()` Specifies that the generated password should not include punctuation characters.
`Boolean`	`getExcludeUppercase()` Specifies that the generated password should not include uppercase letters.
`Boolean`	`getIncludeSpace()` Specifies that the generated password can include the space character.
`Long`	`getPasswordLength()` The desired length of the generated password.
`Boolean`	`getRequireEachIncludedType()` A boolean value that specifies whether the generated password must include at least one of every allowed character type.
`int`	`hashCode()`
`Boolean`	`isExcludeLowercase()` Specifies that the generated password should not include lowercase letters.
`Boolean`	`isExcludeNumbers()` Specifies that the generated password should not include digits.
`Boolean`	`isExcludePunctuation()` Specifies that the generated password should not include punctuation characters.
`Boolean`	`isExcludeUppercase()` Specifies that the generated password should not include uppercase letters.
`Boolean`	`isIncludeSpace()` Specifies that the generated password can include the space character.
`Boolean`	`isRequireEachIncludedType()` A boolean value that specifies whether the generated password must include at least one of every allowed character type.
`void`	`setExcludeCharacters(String excludeCharacters)` A string that includes characters that should not be included in the generated password.
`void`	`setExcludeLowercase(Boolean excludeLowercase)` Specifies that the generated password should not include lowercase letters.
`void`	`setExcludeNumbers(Boolean excludeNumbers)` Specifies that the generated password should not include digits.
`void`	`setExcludePunctuation(Boolean excludePunctuation)` Specifies that the generated password should not include punctuation characters.
`void`	`setExcludeUppercase(Boolean excludeUppercase)` Specifies that the generated password should not include uppercase letters.
`void`	`setIncludeSpace(Boolean includeSpace)` Specifies that the generated password can include the space character.
`void`	`setPasswordLength(Long passwordLength)` The desired length of the generated password.
`void`	`setRequireEachIncludedType(Boolean requireEachIncludedType)` A boolean value that specifies whether the generated password must include at least one of every allowed character type.
`String`	`toString()` Returns a string representation of this object.
`GetRandomPasswordRequest`	`withExcludeCharacters(String excludeCharacters)` A string that includes characters that should not be included in the generated password.
`GetRandomPasswordRequest`	`withExcludeLowercase(Boolean excludeLowercase)` Specifies that the generated password should not include lowercase letters.
`GetRandomPasswordRequest`	`withExcludeNumbers(Boolean excludeNumbers)` Specifies that the generated password should not include digits.
`GetRandomPasswordRequest`	`withExcludePunctuation(Boolean excludePunctuation)` Specifies that the generated password should not include punctuation characters.
`GetRandomPasswordRequest`	`withExcludeUppercase(Boolean excludeUppercase)` Specifies that the generated password should not include uppercase letters.
`GetRandomPasswordRequest`	`withIncludeSpace(Boolean includeSpace)` Specifies that the generated password can include the space character.
`GetRandomPasswordRequest`	`withPasswordLength(Long passwordLength)` The desired length of the generated password.
`GetRandomPasswordRequest`	`withRequireEachIncludedType(Boolean requireEachIncludedType)` A boolean value that specifies whether the generated password must include at least one of every allowed character type.

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 desired length of the generated password. The default value if you do not include this parameter is 32 characters.
    
    Parameters:
    
    passwordLength - The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
  - getPasswordLength
```
public Long getPasswordLength()
```
    The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
    
    Returns:
    
    The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
  - withPasswordLength
```
public GetRandomPasswordRequest withPasswordLength(Long passwordLength)
```
    The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
    
    Parameters:
    
    passwordLength - The desired length of the generated password. The default value if you do not include this parameter 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 that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
    
    Parameters:
    
    excludeCharacters - A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
  - getExcludeCharacters
```
public String getExcludeCharacters()
```
    A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
    
    Returns:
    
    A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
  - withExcludeCharacters
```
public GetRandomPasswordRequest withExcludeCharacters(String excludeCharacters)
```
    A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
    
    Parameters:
    
    excludeCharacters - A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExcludeNumbers
```
public void setExcludeNumbers(Boolean excludeNumbers)
```
    Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
    
    Parameters:
    
    excludeNumbers - Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
  - getExcludeNumbers
```
public Boolean getExcludeNumbers()
```
    Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
    
    Returns:
    
    Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
  - withExcludeNumbers
```
public GetRandomPasswordRequest withExcludeNumbers(Boolean excludeNumbers)
```
    Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
    
    Parameters:
    
    excludeNumbers - Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExcludeNumbers
```
public Boolean isExcludeNumbers()
```
    Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
    
    Returns:
    
    Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
  - setExcludePunctuation
```
public void setExcludePunctuation(Boolean excludePunctuation)
```
    Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
    
    The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:
    
    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
    
    Parameters:
    
    excludePunctuation - Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
    
    The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:
    
    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
  - getExcludePunctuation
```
public Boolean getExcludePunctuation()
```
    Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
    
    The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:
    
    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
    
    Returns:
    
    Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
    
    The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:
    
    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
  - withExcludePunctuation
```
public GetRandomPasswordRequest withExcludePunctuation(Boolean excludePunctuation)
```
    Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
    
    The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:
    
    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
    
    Parameters:
    
    excludePunctuation - Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
    
    The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:
    
    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExcludePunctuation
```
public Boolean isExcludePunctuation()
```
    Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
    
    The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:
    
    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
    
    Returns:
    
    Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
    
    The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:
    
    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
  - setExcludeUppercase
```
public void setExcludeUppercase(Boolean excludeUppercase)
```
    Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
    
    Parameters:
    
    excludeUppercase - Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
  - getExcludeUppercase
```
public Boolean getExcludeUppercase()
```
    Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
    
    Returns:
    
    Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
  - withExcludeUppercase
```
public GetRandomPasswordRequest withExcludeUppercase(Boolean excludeUppercase)
```
    Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
    
    Parameters:
    
    excludeUppercase - Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExcludeUppercase
```
public Boolean isExcludeUppercase()
```
    Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
    
    Returns:
    
    Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
  - setExcludeLowercase
```
public void setExcludeLowercase(Boolean excludeLowercase)
```
    Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
    
    Parameters:
    
    excludeLowercase - Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
  - getExcludeLowercase
```
public Boolean getExcludeLowercase()
```
    Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
    
    Returns:
    
    Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
  - withExcludeLowercase
```
public GetRandomPasswordRequest withExcludeLowercase(Boolean excludeLowercase)
```
    Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
    
    Parameters:
    
    excludeLowercase - Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExcludeLowercase
```
public Boolean isExcludeLowercase()
```
    Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
    
    Returns:
    
    Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
  - setIncludeSpace
```
public void setIncludeSpace(Boolean includeSpace)
```
    Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
    
    Parameters:
    
    includeSpace - Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
  - getIncludeSpace
```
public Boolean getIncludeSpace()
```
    Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
    
    Returns:
    
    Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
  - withIncludeSpace
```
public GetRandomPasswordRequest withIncludeSpace(Boolean includeSpace)
```
    Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
    
    Parameters:
    
    includeSpace - Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeSpace
```
public Boolean isIncludeSpace()
```
    Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
    
    Returns:
    
    Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
  - setRequireEachIncludedType
```
public void setRequireEachIncludedType(Boolean requireEachIncludedType)
```
    A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.
    
    Parameters:
    
    requireEachIncludedType - A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.
  - getRequireEachIncludedType
```
public Boolean getRequireEachIncludedType()
```
    A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.
    
    Returns:
    
    A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.
  - withRequireEachIncludedType
```
public GetRandomPasswordRequest withRequireEachIncludedType(Boolean requireEachIncludedType)
```
    A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.
    
    Parameters:
    
    requireEachIncludedType - A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires 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()
```
    A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.
    
    Returns:
    
    A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires 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()

Did this page help you?

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