AddHttpRequestHeaderRule¶

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

Bases: oci.load_balancer.models.rule.Rule

An object that represents the action of adding a header to a request. This rule applies only to HTTP listeners. NOTES:

If a matching header already exists in the request, the system removes all of its occurrences, and then adds the

Attributes

`ACTION_ADD_HTTP_REQUEST_HEADER`	str(object=’’) -> str
`ACTION_ADD_HTTP_RESPONSE_HEADER`	str(object=’’) -> str
`ACTION_ALLOW`	str(object=’’) -> str
`ACTION_CONTROL_ACCESS_USING_HTTP_METHODS`	str(object=’’) -> str
`ACTION_EXTEND_HTTP_REQUEST_HEADER_VALUE`	str(object=’’) -> str
`ACTION_EXTEND_HTTP_RESPONSE_HEADER_VALUE`	str(object=’’) -> str
`ACTION_HTTP_HEADER`	str(object=’’) -> str
`ACTION_IP_BASED_MAX_CONNECTIONS`	str(object=’’) -> str
`ACTION_REDIRECT`	str(object=’’) -> str
`ACTION_REMOVE_HTTP_REQUEST_HEADER`	str(object=’’) -> str
`ACTION_REMOVE_HTTP_RESPONSE_HEADER`	str(object=’’) -> str
`action`	[Required] Gets the action of this Rule.
`header`	[Required] Gets the header of this AddHttpRequestHeaderRule.
`value`	[Required] Gets the value of this AddHttpRequestHeaderRule.

Methods

`__init__`(**kwargs)	Initializes a new AddHttpRequestHeaderRule 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.

new header.

The system does not distinquish between underscore and dash characters in headers. That is, it treats

example_header_name and example-header-name as identical. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.

ACTION_ADD_HTTP_REQUEST_HEADER = 'ADD_HTTP_REQUEST_HEADER'¶

ACTION_ADD_HTTP_RESPONSE_HEADER = 'ADD_HTTP_RESPONSE_HEADER'¶

ACTION_ALLOW = 'ALLOW'¶

ACTION_CONTROL_ACCESS_USING_HTTP_METHODS = 'CONTROL_ACCESS_USING_HTTP_METHODS'¶

ACTION_EXTEND_HTTP_REQUEST_HEADER_VALUE = 'EXTEND_HTTP_REQUEST_HEADER_VALUE'¶

ACTION_EXTEND_HTTP_RESPONSE_HEADER_VALUE = 'EXTEND_HTTP_RESPONSE_HEADER_VALUE'¶

ACTION_HTTP_HEADER = 'HTTP_HEADER'¶

ACTION_IP_BASED_MAX_CONNECTIONS = 'IP_BASED_MAX_CONNECTIONS'¶

ACTION_REDIRECT = 'REDIRECT'¶

ACTION_REMOVE_HTTP_REQUEST_HEADER = 'REMOVE_HTTP_REQUEST_HEADER'¶

ACTION_REMOVE_HTTP_RESPONSE_HEADER = 'REMOVE_HTTP_RESPONSE_HEADER'¶

__init__(**kwargs)¶

Initializes a new AddHttpRequestHeaderRule object with values from keyword arguments. The default value of the action attribute of this class is ADD_HTTP_REQUEST_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 AddHttpRequestHeaderRule. 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”
header (str) – The value to assign to the header property of this AddHttpRequestHeaderRule.
value (str) – The value to assign to the value property of this AddHttpRequestHeaderRule.

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

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.

header¶

[Required] Gets the header of this AddHttpRequestHeaderRule. A header name that conforms to RFC 7230.

Example: example_header_name

Returns:	The header of this AddHttpRequestHeaderRule.
Return type:	str

value¶

[Required] Gets the value of this AddHttpRequestHeaderRule. A header value that conforms to RFC 7230. With the following exceptions: * value cannot contain $ * value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.

Example: example_value

Returns:	The value of this AddHttpRequestHeaderRule.
Return type:	str