ExtendHttpResponseHeaderValueRule

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

Bases: oci.load_balancer.models.rule.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

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_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 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.

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.

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_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 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”
  • 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.
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”, ‘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 ExtendHttpResponseHeaderValueRule. A header name that conforms to RFC 7230.

Example: example_header_name

Returns:The header of this ExtendHttpResponseHeaderValueRule.
Return type:str
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.

Example: example_prefix_value

Returns:The prefix of this ExtendHttpResponseHeaderValueRule.
Return type:str
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.

Example: example_suffix_value

Returns:The suffix of this ExtendHttpResponseHeaderValueRule.
Return type:str