com.oracle.bmc.apigateway.model

Class FilterQueryParameterPolicy

java.lang.Object

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

com.oracle.bmc.apigateway.model.FilterQueryParameterPolicy

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

Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
Note: Objects should always be created or deserialized using the FilterQueryParameterPolicy.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 FilterQueryParameterPolicy.Builder, which maintain a set of all explicitly set fields called FilterQueryParameterPolicy.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 and Description
static class	FilterQueryParameterPolicy.Builder
static class	FilterQueryParameterPolicy.Type BLOCK drops any query parameters that are in the list of items, so it acts as an exclusion list.

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 and Description
FilterQueryParameterPolicy(FilterQueryParameterPolicy.Type type, List<FilterQueryParameterPolicyItem> items) Deprecated.

Method Summary

Modifier and Type	Method and Description
static FilterQueryParameterPolicy.Builder	builder() Create a new builder.
boolean	equals(Object o)
List<FilterQueryParameterPolicyItem>	getItems() The list of query parameters.
FilterQueryParameterPolicy.Type	getType() BLOCK drops any query parameters that are in the list of items, so it acts as an exclusion list.
int	hashCode()
FilterQueryParameterPolicy.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

FilterQueryParameterPolicy

@Deprecated
 @ConstructorProperties(value={"type","items"})
public FilterQueryParameterPolicy(FilterQueryParameterPolicy.Type type,
                                                                                              List<FilterQueryParameterPolicyItem> items)

Deprecated.

Method Detail

builder

public static FilterQueryParameterPolicy.Builder builder()

Create a new builder.

toBuilder

public FilterQueryParameterPolicy.Builder toBuilder()

getType

public FilterQueryParameterPolicy.Type getType()

BLOCK drops any query parameters that are in the list of items, so it acts as an exclusion list. ALLOW permits only the parameters in the list and removes all others, so it acts as an inclusion list.

Returns:

the value

getItems

public List<FilterQueryParameterPolicyItem> getItems()

The list of query parameters.

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