DynamicSelectionKey¶
- class oci.apigateway.models.DynamicSelectionKey(**kwargs)¶
Bases:
objectBase policy for defining how to match the context variable in an incoming request with selection keys when dynamically routing and dynamically authenticating requests.
Attributes:
A constant which can be used with the type property of a DynamicSelectionKey.
A constant which can be used with the type property of a DynamicSelectionKey.
Gets the is_default of this DynamicSelectionKey.
[Required] Gets the name of this DynamicSelectionKey.
Gets the type of this DynamicSelectionKey.
Methods:
__init__(**kwargs)Initializes a new DynamicSelectionKey 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 DynamicSelectionKey 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:
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 DynamicSelectionKey. 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’.
is_default (bool) – The value to assign to the is_default property of this DynamicSelectionKey.
name (str) – The value to assign to the name property of this DynamicSelectionKey.
- 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