Class GetRandomPasswordRequest

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("software.amazon.awssdk:codegen") public final class GetRandomPasswordRequest extends SecretsManagerRequest implements ToCopyableBuilder<GetRandomPasswordRequest.Builder,GetRandomPasswordRequest>

  • Method Details

    • 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()
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.