StickyCookieLoadBalancingMethod

class oci.waas.models.StickyCookieLoadBalancingMethod(**kwargs)

Bases: oci.waas.models.load_balancing_method.LoadBalancingMethod

An object that represents the sticky-cookie load balancing method and its properties.

Attributes

METHOD_IP_HASH str(object=’‘) -> str
METHOD_ROUND_ROBIN str(object=’‘) -> str
METHOD_STICKY_COOKIE str(object=’‘) -> str
domain Gets the domain of this StickyCookieLoadBalancingMethod.
expiration_time_in_seconds Gets the expiration_time_in_seconds of this StickyCookieLoadBalancingMethod.
method [Required] Gets the method of this LoadBalancingMethod.
name Gets the name of this StickyCookieLoadBalancingMethod.

Methods

__init__(**kwargs) Initializes a new StickyCookieLoadBalancingMethod 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.
METHOD_IP_HASH = 'IP_HASH'
METHOD_ROUND_ROBIN = 'ROUND_ROBIN'
__init__(**kwargs)

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

Parameters:
  • method (str) – The value to assign to the method property of this StickyCookieLoadBalancingMethod. Allowed values for this property are: “IP_HASH”, “ROUND_ROBIN”, “STICKY_COOKIE”
  • name (str) – The value to assign to the name property of this StickyCookieLoadBalancingMethod.
  • domain (str) – The value to assign to the domain property of this StickyCookieLoadBalancingMethod.
  • expiration_time_in_seconds (int) – The value to assign to the expiration_time_in_seconds property of this StickyCookieLoadBalancingMethod.
domain

Gets the domain of this StickyCookieLoadBalancingMethod. The domain for which the cookie is set, defaults to WAAS policy domain.

Returns:The domain of this StickyCookieLoadBalancingMethod.
Return type:str
expiration_time_in_seconds

Gets the expiration_time_in_seconds of this StickyCookieLoadBalancingMethod. The time for which a browser should keep the cookie in seconds. Empty value will cause the cookie to expire at the end of a browser session.

Returns:The expiration_time_in_seconds of this StickyCookieLoadBalancingMethod.
Return type:int
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.

method

[Required] Gets the method of this LoadBalancingMethod. Load balancing methods are algorithms used to efficiently distribute traffic among origin servers.

  • IP_HASH: All the incoming requests from the same client IP address should go to the same content origination server. IP_HASH load balancing method uses origin weights when choosing which origin should the hash be assigned to initially.
  • ROUND_ROBIN: Forwards requests sequentially to the available origin servers. The first request - to the first origin server, the second request - to the next origin server, and so on. After it sends a request to the last origin server, it starts again with the first origin server. When using weights on origins, Weighted Round Robin assigns more requests to origins with a greater weight. Over a period of time, origins will receive a number of requests in proportion to their weight.
  • STICKY_COOKIE: Adds a session cookie to the first response from the origin server and identifies the server that sent the response. The client’s next request contains the cookie value, and nginx routes the request to the origin server that responded to the first request. STICKY_COOKIE load balancing method falls back to Round Robin for the first request.

Allowed values for this property are: “IP_HASH”, “ROUND_ROBIN”, “STICKY_COOKIE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The method of this LoadBalancingMethod.
Return type:str
name

Gets the name of this StickyCookieLoadBalancingMethod. The name of the cookie used to track the persistence. Can contain any US-ASCII character except separator or control character.

Returns:The name of this StickyCookieLoadBalancingMethod.
Return type:str