WildcardSelectionKey

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

Bases: DynamicSelectionKey

When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a selection key containing a wildcard is used if the context variable in an incoming request matches that key.

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.

expression

[Required] Gets the expression of this WildcardSelectionKey.

is_default

Gets the is_default of this DynamicSelectionKey.

name

[Required] Gets the name of this DynamicSelectionKey.

type

Gets the type of this DynamicSelectionKey.

Methods:

__init__(**kwargs)

Initializes a new WildcardSelectionKey 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 WildcardSelectionKey object with values from keyword arguments. The default value of the type attribute of this class is WILDCARD 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 WildcardSelectionKey. Allowed values for this property are: “ANY_OF”, “WILDCARD”

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

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

  • expression (str) – The value to assign to the expression property of this WildcardSelectionKey.

property expression

[Required] Gets the expression of this WildcardSelectionKey. A selection key string containing a wildcard to match with the context variable in an incoming request. If the context variable matches the string, the request is sent to the route or authentication server associated with the selection key. Valid wildcards are ‘*’ (zero or more characters) and ‘+’ (one or more characters). The string can only contain one wildcard, and the wildcard must be at the start or the end of the string.

Returns

The expression of this WildcardSelectionKey.

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