FilterHeaderPolicy¶

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

Bases: object

Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers 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 FilterHeaderPolicy.
`TYPE_BLOCK`	A constant which can be used with the type property of a FilterHeaderPolicy.
`items`	[Required] Gets the items of this FilterHeaderPolicy.
`type`	[Required] Gets the type of this FilterHeaderPolicy.

Methods

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

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

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

__init__(**kwargs)¶

Initializes a new FilterHeaderPolicy 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 FilterHeaderPolicy. 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.FilterHeaderPolicyItem]) – The value to assign to the items property of this FilterHeaderPolicy.

items¶

[Required] Gets the items of this FilterHeaderPolicy. The list of headers.

Returns:	The items of this FilterHeaderPolicy.
Return type:	list[oci.apigateway.models.FilterHeaderPolicyItem]

type¶

[Required] Gets the type of this FilterHeaderPolicy. BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers 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 FilterHeaderPolicy.
Return type:	str