Rule

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

Bases: object

An object that represents an action to apply to a 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.

Methods:

__init__(**kwargs)	Initializes a new Rule 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 Rule object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• AddHttpRequestHeaderRule

• RedirectRule

• RemoveHttpRequestHeaderRule

• ExtendHttpRequestHeaderValueRule

• RemoveHttpResponseHeaderRule

• ControlAccessUsingHttpMethodsRule

• AllowRule

• IpBasedMaxConnectionsRule

• HttpHeaderRule

• AddHttpResponseHeaderRule

• ExtendHttpResponseHeaderValueRule

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

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.