ExtendHttpResponseHeaderValueRule

class oci.load_balancer.models.ExtendHttpResponseHeaderValueRule(**kwargs)

Bases: Rule

An object that represents the action of modifying a response header value. This rule applies only to HTTP listeners.

This rule adds a prefix, a suffix, or both to the header value.

NOTES:

• This rule requires a value for a prefix, suffix, or both.

• The system does not support this rule for headers with multiple values.

• 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. If two such headers appear in a request, the system applies the action to the first header it finds. The affected header cannot be determined in advance. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.

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.
header	[Required] Gets the header of this ExtendHttpResponseHeaderValueRule.
prefix	Gets the prefix of this ExtendHttpResponseHeaderValueRule.
suffix	Gets the suffix of this ExtendHttpResponseHeaderValueRule.

Methods:

__init__(**kwargs)	Initializes a new ExtendHttpResponseHeaderValueRule 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 ExtendHttpResponseHeaderValueRule object with values from keyword arguments. The default value of the action attribute of this class is EXTEND_HTTP_RESPONSE_HEADER_VALUE 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 ExtendHttpResponseHeaderValueRule. 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 ExtendHttpResponseHeaderValueRule.

• prefix (str) – The value to assign to the prefix property of this ExtendHttpResponseHeaderValueRule.

• suffix (str) – The value to assign to the suffix property of this ExtendHttpResponseHeaderValueRule.

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

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 header

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

Example: example_header_name

Returns

The header of this ExtendHttpResponseHeaderValueRule.

Return type

str

property prefix

Gets the prefix of this ExtendHttpResponseHeaderValueRule. A string to prepend to the header value. The resulting header value must still conform 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_prefix_value

Returns

The prefix of this ExtendHttpResponseHeaderValueRule.

Return type

str

property suffix

Gets the suffix of this ExtendHttpResponseHeaderValueRule. A string to append to the header value. The resulting header value must still conform 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_suffix_value

Returns

The suffix of this ExtendHttpResponseHeaderValueRule.

Return type

str