Package software.amazon.awssdk.services.wafv2.model

Interface RequestInspection.Builder

    • Method Detail

      • payloadType

        RequestInspection.Builder payloadType​(String payloadType)

        The payload type for your login endpoint, either JSON or form encoded.

        Parameters:
        payloadType - The payload type for your login endpoint, either JSON or form encoded.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PayloadType, PayloadType

      • payloadType

        RequestInspection.Builder payloadType​(PayloadType payloadType)

        The payload type for your login endpoint, either JSON or form encoded.

        Parameters:
        payloadType - The payload type for your login endpoint, either JSON or form encoded.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PayloadType, PayloadType

      • usernameField

        RequestInspection.Builder usernameField​(UsernameField usernameField)

        The name of the field in the request payload that contains your customer's username.

        How you specify this depends on the request inspection payload type.

        • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

          For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username field specification is /form/username.

        • For form encoded payload types, use the HTML form names.

          For example, for an HTML form with the input element named username1, the username field specification is username1

        Parameters:
        usernameField - The name of the field in the request payload that contains your customer's username.

        How you specify this depends on the request inspection payload type.

        • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

          For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username field specification is /form/username.

        • For form encoded payload types, use the HTML form names.

          For example, for an HTML form with the input element named username1, the username field specification is username1

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • usernameField

        default RequestInspection.Builder usernameField​(Consumer<UsernameField.Builder> usernameField)

        The name of the field in the request payload that contains your customer's username.

        How you specify this depends on the request inspection payload type.

        • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

          For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username field specification is /form/username.

        • For form encoded payload types, use the HTML form names.

          For example, for an HTML form with the input element named username1, the username field specification is username1

        This is a convenience method that creates an instance of the UsernameField.Builder avoiding the need to create one manually via UsernameField.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to usernameField(UsernameField).

        Parameters:
        usernameField - a consumer that will call methods on UsernameField.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        usernameField(UsernameField)

      • passwordField

        RequestInspection.Builder passwordField​(PasswordField passwordField)

        The name of the field in the request payload that contains your customer's password.

        How you specify this depends on the request inspection payload type.

        • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

          For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password field specification is /form/password.

        • For form encoded payload types, use the HTML form names.

          For example, for an HTML form with the input element named password1, the password field specification is password1.

        Parameters:
        passwordField - The name of the field in the request payload that contains your customer's password.

        How you specify this depends on the request inspection payload type.

        • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

          For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password field specification is /form/password.

        • For form encoded payload types, use the HTML form names.

          For example, for an HTML form with the input element named password1, the password field specification is password1.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • passwordField

        default RequestInspection.Builder passwordField​(Consumer<PasswordField.Builder> passwordField)

        The name of the field in the request payload that contains your customer's password.

        How you specify this depends on the request inspection payload type.

        • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

          For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password field specification is /form/password.

        • For form encoded payload types, use the HTML form names.

          For example, for an HTML form with the input element named password1, the password field specification is password1.

        This is a convenience method that creates an instance of the PasswordField.Builder avoiding the need to create one manually via PasswordField.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to passwordField(PasswordField).

        Parameters:
        passwordField - a consumer that will call methods on PasswordField.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        passwordField(PasswordField)