HttpHeaderRule¶

class oci.load_balancer.models.HttpHeaderRule(**kwargs)¶

Bases: Rule

An object that represents the advance http header options that allow the setting of http header size and allow/disallow invalid characters in the http headers. For example httpLargeHeaderSizeInKB=32, the http header could have 4 buffers of 32KBs each This rule applies only to HTTP listeners. No more than one HttpHeaderRule object can be present in a given listener.

Attributes:

`ACTION_ADD_HTTP_REQUEST_HEADER`	A constant which can be used with the action property of a Rule.
`ACTION_ADD_HTTP_RESPONSE_HEADER`	A constant which can be used with the action property of a Rule.
`ACTION_ALLOW`	A constant which can be used with the action property of a Rule.
`ACTION_CONTROL_ACCESS_USING_HTTP_METHODS`	A constant which can be used with the action property of a Rule.
`ACTION_EXTEND_HTTP_REQUEST_HEADER_VALUE`	A constant which can be used with the action property of a Rule.
`ACTION_EXTEND_HTTP_RESPONSE_HEADER_VALUE`	A constant which can be used with the action property of a Rule.
`ACTION_HTTP_HEADER`	A constant which can be used with the action property of a Rule.
`ACTION_IP_BASED_MAX_CONNECTIONS`	A constant which can be used with the action property of a Rule.
`ACTION_REDIRECT`	A constant which can be used with the action property of a Rule.
`ACTION_REMOVE_HTTP_REQUEST_HEADER`	A constant which can be used with the action property of a Rule.
`ACTION_REMOVE_HTTP_RESPONSE_HEADER`	A constant which can be used with the action property of a Rule.
`action`	[Required] Gets the action of this Rule.
`are_invalid_characters_allowed`	Gets the are_invalid_characters_allowed of this HttpHeaderRule.
`http_large_header_size_in_kb`	Gets the http_large_header_size_in_kb of this HttpHeaderRule.

Methods:

`__init__`(**kwargs)	Initializes a new HttpHeaderRule object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ACTION_ADD_HTTP_REQUEST_HEADER = 'ADD_HTTP_REQUEST_HEADER'¶: A constant which can be used with the action property of a Rule. This constant has a value of “ADD_HTTP_REQUEST_HEADER”

ACTION_ADD_HTTP_RESPONSE_HEADER = 'ADD_HTTP_RESPONSE_HEADER'¶: A constant which can be used with the action property of a Rule. This constant has a value of “ADD_HTTP_RESPONSE_HEADER”

ACTION_ALLOW = 'ALLOW'¶: A constant which can be used with the action property of a Rule. This constant has a value of “ALLOW”

ACTION_CONTROL_ACCESS_USING_HTTP_METHODS = 'CONTROL_ACCESS_USING_HTTP_METHODS'¶: A constant which can be used with the action property of a Rule. This constant has a value of “CONTROL_ACCESS_USING_HTTP_METHODS”

ACTION_EXTEND_HTTP_REQUEST_HEADER_VALUE = 'EXTEND_HTTP_REQUEST_HEADER_VALUE'¶: A constant which can be used with the action property of a Rule. This constant has a value of “EXTEND_HTTP_REQUEST_HEADER_VALUE”

ACTION_EXTEND_HTTP_RESPONSE_HEADER_VALUE = 'EXTEND_HTTP_RESPONSE_HEADER_VALUE'¶: A constant which can be used with the action property of a Rule. This constant has a value of “EXTEND_HTTP_RESPONSE_HEADER_VALUE”

ACTION_HTTP_HEADER = 'HTTP_HEADER'¶: A constant which can be used with the action property of a Rule. This constant has a value of “HTTP_HEADER”

ACTION_IP_BASED_MAX_CONNECTIONS = 'IP_BASED_MAX_CONNECTIONS'¶: A constant which can be used with the action property of a Rule. This constant has a value of “IP_BASED_MAX_CONNECTIONS”

ACTION_REDIRECT = 'REDIRECT'¶: A constant which can be used with the action property of a Rule. This constant has a value of “REDIRECT”

ACTION_REMOVE_HTTP_REQUEST_HEADER = 'REMOVE_HTTP_REQUEST_HEADER'¶: A constant which can be used with the action property of a Rule. This constant has a value of “REMOVE_HTTP_REQUEST_HEADER”

ACTION_REMOVE_HTTP_RESPONSE_HEADER = 'REMOVE_HTTP_RESPONSE_HEADER'¶: A constant which can be used with the action property of a Rule. This constant has a value of “REMOVE_HTTP_RESPONSE_HEADER”

__init__(**kwargs)¶

Initializes a new HttpHeaderRule object with values from keyword arguments. The default value of the action attribute of this class is HTTP_HEADER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

action (str) – The value to assign to the action property of this HttpHeaderRule. Allowed values for this property are: “ADD_HTTP_REQUEST_HEADER”, “EXTEND_HTTP_REQUEST_HEADER_VALUE”, “REMOVE_HTTP_REQUEST_HEADER”, “ADD_HTTP_RESPONSE_HEADER”, “EXTEND_HTTP_RESPONSE_HEADER_VALUE”, “REMOVE_HTTP_RESPONSE_HEADER”, “ALLOW”, “CONTROL_ACCESS_USING_HTTP_METHODS”, “REDIRECT”, “HTTP_HEADER”, “IP_BASED_MAX_CONNECTIONS”
are_invalid_characters_allowed (bool) – The value to assign to the are_invalid_characters_allowed property of this HttpHeaderRule.
http_large_header_size_in_kb (int) – The value to assign to the http_large_header_size_in_kb property of this HttpHeaderRule.

property action¶

[Required] Gets the action of this Rule. Allowed values for this property are: “ADD_HTTP_REQUEST_HEADER”, “EXTEND_HTTP_REQUEST_HEADER_VALUE”, “REMOVE_HTTP_REQUEST_HEADER”, “ADD_HTTP_RESPONSE_HEADER”, “EXTEND_HTTP_RESPONSE_HEADER_VALUE”, “REMOVE_HTTP_RESPONSE_HEADER”, “ALLOW”, “CONTROL_ACCESS_USING_HTTP_METHODS”, “REDIRECT”, “HTTP_HEADER”, “IP_BASED_MAX_CONNECTIONS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The action of this Rule.
Return type: str

property are_invalid_characters_allowed¶

Gets the are_invalid_characters_allowed of this HttpHeaderRule. Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If “true”, invalid characters are allowed in the HTTP header. If “false”, invalid characters are not allowed in the HTTP header

Returns: The are_invalid_characters_allowed of this HttpHeaderRule.
Return type: bool

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property http_large_header_size_in_kb¶

Gets the http_large_header_size_in_kb of this HttpHeaderRule. The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64.

Returns: The http_large_header_size_in_kb of this HttpHeaderRule.
Return type: int