GetRandomPasswordRequest (AWS Java SDK :: Services :: AWS Secrets Manager 2.18.28 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest
    - - software.amazon.awssdk.services.secretsmanager.model.GetRandomPasswordRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetRandomPasswordRequest.Builder,GetRandomPasswordRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetRandomPasswordRequest
extends SecretsManagerRequest
implements ToCopyableBuilder<GetRandomPasswordRequest.Builder,GetRandomPasswordRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetRandomPasswordRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetRandomPasswordRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetRandomPasswordRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`excludeCharacters()` A string of the characters that you don't want in the password.
`Boolean`	`excludeLowercase()` Specifies whether to exclude lowercase letters from the password.
`Boolean`	`excludeNumbers()` Specifies whether to exclude numbers from the password.
`Boolean`	`excludePunctuation()` Specifies whether to exclude the following punctuation characters from the password: `! " # $ % & ' ( ) * + , - .`
`Boolean`	`excludeUppercase()` Specifies whether to exclude uppercase letters from the password.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`includeSpace()` Specifies whether to include the space character.
`Long`	`passwordLength()` The length of the password.
`Boolean`	`requireEachIncludedType()` Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetRandomPasswordRequest.Builder>`	`serializableBuilderClass()`
`GetRandomPasswordRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - passwordLength
```
public final Long passwordLength()
```
    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.
  - excludeCharacters
```
public final String excludeCharacters()
```
    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.
  - excludeNumbers
```
public final Boolean excludeNumbers()
```
    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.
  - excludePunctuation
```
public final 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.
    
    Returns:
    
    Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
  - excludeUppercase
```
public final Boolean excludeUppercase()
```
    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.
  - excludeLowercase
```
public final Boolean excludeLowercase()
```
    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.
  - includeSpace
```
public final Boolean includeSpace()
```
    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.
  - requireEachIncludedType
```
public final 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.
    
    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.
  - toBuilder
```
public GetRandomPasswordRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetRandomPasswordRequest.Builder,GetRandomPasswordRequest>
    
    Specified by:
    
    toBuilder in class SecretsManagerRequest
  - builder
```
public static GetRandomPasswordRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetRandomPasswordRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetRandomPasswordRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

passwordLength

excludeCharacters

excludeNumbers

excludePunctuation

excludeUppercase

excludeLowercase

includeSpace

requireEachIncludedType

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields