Package com.oracle.bmc.apigateway.model

Class HeaderValidationRequestPolicy

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.apigateway.model.HeaderValidationRequestPolicy

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public final class HeaderValidationRequestPolicy
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Validate the HTTP headers on the incoming API requests on a specific route.
Note: Objects should always be created or deserialized using the HeaderValidationRequestPolicy.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the HeaderValidationRequestPolicy.Builder, which maintain a set of all explicitly set fields called HeaderValidationRequestPolicy.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HeaderValidationRequestPolicy.Builder
static class	HeaderValidationRequestPolicy.ValidationMode	Validation behavior mode.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
HeaderValidationRequestPolicy(List<HeaderValidationItem> headers, HeaderValidationRequestPolicy.ValidationMode validationMode)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static HeaderValidationRequestPolicy.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<HeaderValidationItem>	getHeaders()
HeaderValidationRequestPolicy.ValidationMode	getValidationMode()	Validation behavior mode.
int	hashCode()
HeaderValidationRequestPolicy.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HeaderValidationRequestPolicy

@Deprecated
@ConstructorProperties({"headers","validationMode"})
public HeaderValidationRequestPolicy(List<HeaderValidationItem> headers,
                                     HeaderValidationRequestPolicy.ValidationMode validationMode)

Deprecated.

Method Detail

builder

public static HeaderValidationRequestPolicy.Builder builder()

Create a new builder.

toBuilder

public HeaderValidationRequestPolicy.Builder toBuilder()

getHeaders

public List<HeaderValidationItem> getHeaders()

getValidationMode

public HeaderValidationRequestPolicy.ValidationMode getValidationMode()

Validation behavior mode.

In ENFORCING mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend.

In PERMISSIVE mode, the result of the validation will be exposed as metrics while the request will follow the normal path.

DISABLED type turns the validation off.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel