GetRandomPasswordRequest (AWS SDK for Java

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)` Indicates whether some other object is "equal to" this one by SDK fields.
`String`	`excludeCharacters()` A string that includes characters that should not be included in the generated password.
`Boolean`	`excludeLowercase()` Specifies that the generated password should not include lowercase letters.
`Boolean`	`excludeNumbers()` Specifies that the generated password should not include digits.
`Boolean`	`excludePunctuation()` Specifies that the generated password should not include punctuation characters.
`Boolean`	`excludeUppercase()` Specifies that the generated password should not include uppercase letters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`Boolean`	`includeSpace()` Specifies that the generated password can include the space character.
`Long`	`passwordLength()` The desired length of the generated password.
`Boolean`	`requireEachIncludedType()` A boolean value that specifies whether the generated password must include at least one of every allowed character type.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetRandomPasswordRequest.Builder>`	`serializableBuilderClass()`
`GetRandomPasswordRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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
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 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.
  - excludeCharacters
```
public final 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.
    
    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.
  - excludeNumbers
```
public final 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.
    
    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.
  - excludePunctuation
```
public final 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:
    
    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
    
    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:
    
    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
  - excludeUppercase
```
public final 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.
    
    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.
  - excludeLowercase
```
public final 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.
    
    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.
  - includeSpace
```
public final 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.
    
    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.
  - requireEachIncludedType
```
public final 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.
    
    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.
  - toBuilder
```
public GetRandomPasswordRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetRandomPasswordRequest.Builder,GetRandomPasswordRequest>
    
    Specified by:
    
    toBuilder in class SecretsManagerRequest
    
    Returns:
    
    a builder for type T
  - 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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.63

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