FilterQueryParameterPolicy¶

class oci.apigateway.models.FilterQueryParameterPolicy(**kwargs)¶

Bases: object

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.

Attributes

`TYPE_ALLOW`	A constant which can be used with the type property of a FilterQueryParameterPolicy.
`TYPE_BLOCK`	A constant which can be used with the type property of a FilterQueryParameterPolicy.
`items`	[Required] Gets the items of this FilterQueryParameterPolicy.
`type`	[Required] Gets the type of this FilterQueryParameterPolicy.

Methods

__init__(**kwargs) Initializes a new FilterQueryParameterPolicy object with values from keyword arguments.

TYPE_ALLOW = 'ALLOW'¶: A constant which can be used with the type property of a FilterQueryParameterPolicy. This constant has a value of “ALLOW”

TYPE_BLOCK = 'BLOCK'¶: A constant which can be used with the type property of a FilterQueryParameterPolicy. This constant has a value of “BLOCK”

__init__(**kwargs)¶

Initializes a new FilterQueryParameterPolicy object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

type (str) – The value to assign to the type property of this FilterQueryParameterPolicy. Allowed values for this property are: “ALLOW”, “BLOCK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
items (list[oci.apigateway.models.FilterQueryParameterPolicyItem]) – The value to assign to the items property of this FilterQueryParameterPolicy.

items¶

[Required] Gets the items of this FilterQueryParameterPolicy. The list of query parameters.

Returns:	The items of this FilterQueryParameterPolicy.
Return type:	list[oci.apigateway.models.FilterQueryParameterPolicyItem]

type¶

[Required] Gets the type of this FilterQueryParameterPolicy. 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.

Allowed values for this property are: “ALLOW”, “BLOCK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this FilterQueryParameterPolicy.
Return type:	str