AnyOfSelectionKey

class oci.apigateway.models.AnyOfSelectionKey(**kwargs)

Bases: DynamicSelectionKey

When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a set of selection keys is used if the context variable in an incoming request exactly matches one of the keys in the set.

Attributes:

TYPE_ANY_OF

A constant which can be used with the type property of a DynamicSelectionKey.

TYPE_WILDCARD

A constant which can be used with the type property of a DynamicSelectionKey.

is_default

Gets the is_default of this DynamicSelectionKey.

name

[Required] Gets the name of this DynamicSelectionKey.

type

Gets the type of this DynamicSelectionKey.

values

Gets the values of this AnyOfSelectionKey.

Methods:

__init__(**kwargs)

Initializes a new AnyOfSelectionKey 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.

TYPE_ANY_OF = 'ANY_OF'

A constant which can be used with the type property of a DynamicSelectionKey. This constant has a value of “ANY_OF”

TYPE_WILDCARD = 'WILDCARD'

A constant which can be used with the type property of a DynamicSelectionKey. This constant has a value of “WILDCARD”

__init__(**kwargs)

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

Parameters
  • type (str) – The value to assign to the type property of this AnyOfSelectionKey. Allowed values for this property are: “ANY_OF”, “WILDCARD”

  • is_default (bool) – The value to assign to the is_default property of this AnyOfSelectionKey.

  • name (str) – The value to assign to the name property of this AnyOfSelectionKey.

  • values (list[str]) – The value to assign to the values property of this AnyOfSelectionKey.

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 is_default

Gets the is_default of this DynamicSelectionKey. Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests.

Returns

The is_default of this DynamicSelectionKey.

Return type

bool

property name

[Required] Gets the name of this DynamicSelectionKey. Name assigned to the branch.

Returns

The name of this DynamicSelectionKey.

Return type

str

property type

Gets the type of this DynamicSelectionKey. Type of the selection key.

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

Returns

The type of this DynamicSelectionKey.

Return type

str

property values

Gets the values of this AnyOfSelectionKey. The set of selection keys to match with the context variable in an incoming request. If the context variable exactly matches one of the keys in the set, the request is sent to the route or authentication server associated with the set.

Returns

The values of this AnyOfSelectionKey.

Return type

list[str]