Interface FieldToProtect.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FieldToProtect.Builder,FieldToProtect>, SdkBuilder<FieldToProtect.Builder,FieldToProtect>, SdkPojo
Enclosing class:
FieldToProtect
@Mutable @NotThreadSafe public static interface FieldToProtect.Builder extends SdkPojo, CopyableBuilder<FieldToProtect.Builder,FieldToProtect>

  • Method Details

    • fieldType

      FieldToProtect.Builder fieldType(String fieldType)

      Specifies the web request component type to protect.

      Parameters:
      fieldType - Specifies the web request component type to protect.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fieldType

      FieldToProtect.Builder fieldType(FieldToProtectType fieldType)

      Specifies the web request component type to protect.

      Parameters:
      fieldType - Specifies the web request component type to protect.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fieldKeys

      FieldToProtect.Builder fieldKeys(Collection<String> fieldKeys)

      Specifies the keys to protect for the specified field type.

      Required for SINGLE_HEADER, SINGLE_COOKIE, and SINGLE_QUERY_ARGUMENT: provide a non-empty array naming the specific headers, cookies, or query arguments to protect. There is no option to protect all keys of these field types, so enumerate each key you intend to protect.

      Must be omitted for QUERY_STRING and BODY: the entire component is protected and these field types take no keys. Supplying FieldKeys for them is rejected.

      Parameters:
      fieldKeys - Specifies the keys to protect for the specified field type.

      Required for SINGLE_HEADER, SINGLE_COOKIE, and SINGLE_QUERY_ARGUMENT: provide a non-empty array naming the specific headers, cookies, or query arguments to protect. There is no option to protect all keys of these field types, so enumerate each key you intend to protect.

      Must be omitted for QUERY_STRING and BODY: the entire component is protected and these field types take no keys. Supplying FieldKeys for them is rejected.

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

    • fieldKeys

      FieldToProtect.Builder fieldKeys(String... fieldKeys)

      Specifies the keys to protect for the specified field type.

      Required for SINGLE_HEADER, SINGLE_COOKIE, and SINGLE_QUERY_ARGUMENT: provide a non-empty array naming the specific headers, cookies, or query arguments to protect. There is no option to protect all keys of these field types, so enumerate each key you intend to protect.

      Must be omitted for QUERY_STRING and BODY: the entire component is protected and these field types take no keys. Supplying FieldKeys for them is rejected.

      Parameters:
      fieldKeys - Specifies the keys to protect for the specified field type.

      Required for SINGLE_HEADER, SINGLE_COOKIE, and SINGLE_QUERY_ARGUMENT: provide a non-empty array naming the specific headers, cookies, or query arguments to protect. There is no option to protect all keys of these field types, so enumerate each key you intend to protect.

      Must be omitted for QUERY_STRING and BODY: the entire component is protected and these field types take no keys. Supplying FieldKeys for them is rejected.

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