Struct aws_sdk_wafv2::types::builders::RequestInspectionBuilder
source · #[non_exhaustive]pub struct RequestInspectionBuilder { /* private fields */ }
Expand description
A builder for RequestInspection
.
Implementations§
source§impl RequestInspectionBuilder
impl RequestInspectionBuilder
sourcepub fn payload_type(self, input: PayloadType) -> Self
pub fn payload_type(self, input: PayloadType) -> Self
The payload type for your login endpoint, either JSON or form encoded.
This field is required.sourcepub fn set_payload_type(self, input: Option<PayloadType>) -> Self
pub fn set_payload_type(self, input: Option<PayloadType>) -> Self
The payload type for your login endpoint, either JSON or form encoded.
sourcepub fn get_payload_type(&self) -> &Option<PayloadType>
pub fn get_payload_type(&self) -> &Option<PayloadType>
The payload type for your login endpoint, either JSON or form encoded.
sourcepub fn username_field(self, input: UsernameField) -> Self
pub fn username_field(self, input: UsernameField) -> Self
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
sourcepub fn set_username_field(self, input: Option<UsernameField>) -> Self
pub fn set_username_field(self, input: Option<UsernameField>) -> Self
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
sourcepub fn get_username_field(&self) -> &Option<UsernameField>
pub fn get_username_field(&self) -> &Option<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
sourcepub fn password_field(self, input: PasswordField) -> Self
pub fn password_field(self, input: PasswordField) -> Self
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
.
sourcepub fn set_password_field(self, input: Option<PasswordField>) -> Self
pub fn set_password_field(self, input: Option<PasswordField>) -> Self
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
.
sourcepub fn get_password_field(&self) -> &Option<PasswordField>
pub fn get_password_field(&self) -> &Option<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
.
sourcepub fn build(self) -> Result<RequestInspection, BuildError>
pub fn build(self) -> Result<RequestInspection, BuildError>
Consumes the builder and constructs a RequestInspection
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for RequestInspectionBuilder
impl Clone for RequestInspectionBuilder
source§fn clone(&self) -> RequestInspectionBuilder
fn clone(&self) -> RequestInspectionBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for RequestInspectionBuilder
impl Debug for RequestInspectionBuilder
source§impl Default for RequestInspectionBuilder
impl Default for RequestInspectionBuilder
source§fn default() -> RequestInspectionBuilder
fn default() -> RequestInspectionBuilder
source§impl PartialEq for RequestInspectionBuilder
impl PartialEq for RequestInspectionBuilder
source§fn eq(&self, other: &RequestInspectionBuilder) -> bool
fn eq(&self, other: &RequestInspectionBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.