Interface RequestInspection.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<RequestInspection.Builder,
,RequestInspection> SdkBuilder<RequestInspection.Builder,
,RequestInspection> SdkPojo
- Enclosing class:
RequestInspection
-
Method Summary
Modifier and TypeMethodDescriptiondefault RequestInspection.Builder
passwordField
(Consumer<PasswordField.Builder> passwordField) The name of the field in the request payload that contains your customer's password.passwordField
(PasswordField passwordField) The name of the field in the request payload that contains your customer's password.payloadType
(String payloadType) The payload type for your login endpoint, either JSON or form encoded.payloadType
(PayloadType payloadType) The payload type for your login endpoint, either JSON or form encoded.default RequestInspection.Builder
usernameField
(Consumer<UsernameField.Builder> usernameField) The name of the field in the request payload that contains your customer's username.usernameField
(UsernameField usernameField) The name of the field in the request payload that contains your customer's username.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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:
-
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 isusername1
- 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 isusername1
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 isusername1
UsernameField.Builder
avoiding the need to create one manually viaUsernameField.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tousernameField(UsernameField)
.- Parameters:
usernameField
- a consumer that will call methods onUsernameField.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 ispassword1
.
- 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 ispassword1
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 ispassword1
.
PasswordField.Builder
avoiding the need to create one manually viaPasswordField.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topasswordField(PasswordField)
.- Parameters:
passwordField
- a consumer that will call methods onPasswordField.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-