o ɶdm@s8ddlmZmZmZddlmZeGdddeZdS))formatted_flat_dict NONE_SENTINEL#value_allowed_none_or_none_sentinel)init_model_state_from_kwargsc@seZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZddZeddZejddZeddZejddZeddZejddZeddZejddZeddZejd dZed!d"Zejd#d"Zed$d%Zejd&d%Zed'd(Zejd)d(Zed*d+Zejd,d+Zed-d.Zejd/d.Zed0d1Zejd2d1Zed3d4Z e jd5d4Z ed6d7Z!e!jd8d7Z!ed9d:Z"e"jd;d:Z"edd=Z#ed?d@Z$e$jdAd@Z$dBdCZ%dDdEZ&dFdGZ'dHS)I AccessRulezy A content access rule. An access rule specifies an action to take if a set of criteria is matched by a request. ALLOWDETECTBLOCKBYPASSREDIRECT SHOW_CAPTCHASET_RESPONSE_CODESHOW_ERROR_PAGE JS_CHALLENGEDEVICE_FINGERPRINT_CHALLENGEHUMAN_INTERACTION_CHALLENGECAPTCHAMOVED_PERMANENTLYFOUNDcKs0iddddddddddd dd dd dd d dddddddddddddd|_iddddddddddd dd dd dd ddddddddddd dd!dd"|_d#|_d#|_d#|_d#|_d#|_d#|_d#|_d#|_ d#|_ d#|_ d#|_ d#|_ d#|_d#|_d#|_d#|_d#S)$am Initializes a new AccessRule object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class): :param name: The value to assign to the name property of this AccessRule. :type name: str :param criteria: The value to assign to the criteria property of this AccessRule. :type criteria: list[oci.waas.models.AccessRuleCriteria] :param action: The value to assign to the action property of this AccessRule. Allowed values for this property are: "ALLOW", "DETECT", "BLOCK", "BYPASS", "REDIRECT", "SHOW_CAPTCHA", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type action: str :param block_action: The value to assign to the block_action property of this AccessRule. Allowed values for this property are: "SET_RESPONSE_CODE", "SHOW_ERROR_PAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type block_action: str :param block_response_code: The value to assign to the block_response_code property of this AccessRule. :type block_response_code: int :param block_error_page_message: The value to assign to the block_error_page_message property of this AccessRule. :type block_error_page_message: str :param block_error_page_code: The value to assign to the block_error_page_code property of this AccessRule. :type block_error_page_code: str :param block_error_page_description: The value to assign to the block_error_page_description property of this AccessRule. :type block_error_page_description: str :param bypass_challenges: The value to assign to the bypass_challenges property of this AccessRule. Allowed values for items in this list are: "JS_CHALLENGE", "DEVICE_FINGERPRINT_CHALLENGE", "HUMAN_INTERACTION_CHALLENGE", "CAPTCHA", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type bypass_challenges: list[str] :param redirect_url: The value to assign to the redirect_url property of this AccessRule. :type redirect_url: str :param redirect_response_code: The value to assign to the redirect_response_code property of this AccessRule. Allowed values for this property are: "MOVED_PERMANENTLY", "FOUND", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type redirect_response_code: str :param captcha_title: The value to assign to the captcha_title property of this AccessRule. :type captcha_title: str :param captcha_header: The value to assign to the captcha_header property of this AccessRule. :type captcha_header: str :param captcha_footer: The value to assign to the captcha_footer property of this AccessRule. :type captcha_footer: str :param captcha_submit_label: The value to assign to the captcha_submit_label property of this AccessRule. :type captcha_submit_label: str :param response_header_manipulation: The value to assign to the response_header_manipulation property of this AccessRule. :type response_header_manipulation: list[oci.waas.models.HeaderManipulationAction] namestrcriteriazlist[AccessRuleCriteria]action block_actionblock_response_codeintblock_error_page_messageblock_error_page_codeblock_error_page_descriptionbypass_challengesz list[str] redirect_urlredirect_response_code captcha_titlecaptcha_headercaptcha_footercaptcha_submit_labelresponse_header_manipulationzlist[HeaderManipulationAction]Z blockActionZblockResponseCodeZblockErrorPageMessageZblockErrorPageCodeZblockErrorPageDescriptionZbypassChallengesZ redirectUrlZredirectResponseCodeZ captchaTitleZ captchaHeaderZ captchaFooterZcaptchaSubmitLabelZresponseHeaderManipulationN)Z swagger_typesZ attribute_map_name _criteria_action _block_action_block_response_code_block_error_page_message_block_error_page_code_block_error_page_description_bypass_challenges _redirect_url_redirect_response_code_captcha_title_captcha_header_captcha_footer_captcha_submit_label_response_header_manipulation)selfkwargsr9?usr/lib/python3.10/site-packages/oci/waas/models/access_rule.py__init__JsN           zAccessRule.__init__cC|jS)z **[Required]** Gets the name of this AccessRule. The unique name of the access rule. :return: The name of this AccessRule. :rtype: str r'r7r9r9r:r zAccessRule.namecC ||_dS)z Sets the name of this AccessRule. The unique name of the access rule. :param name: The name of this AccessRule. :type: str Nr=)r7rr9r9r:r cCr<)a5 **[Required]** Gets the criteria of this AccessRule. The list of access rule criteria. The rule would be applied only for the requests that matched all the listed conditions. :return: The criteria of this AccessRule. :rtype: list[oci.waas.models.AccessRuleCriteria] r(r>r9r9r:rr?zAccessRule.criteriacCr@)a- Sets the criteria of this AccessRule. The list of access rule criteria. The rule would be applied only for the requests that matched all the listed conditions. :param criteria: The criteria of this AccessRule. :type: list[oci.waas.models.AccessRuleCriteria] NrB)r7rr9r9r:rrAcCr<)aX **[Required]** Gets the action of this AccessRule. The action to take when the access criteria are met for a rule. If unspecified, defaults to `ALLOW`. - **ALLOW:** Takes no action, just logs the request. - **DETECT:** Takes no action, but creates an alert for the request. - **BLOCK:** Blocks the request by returning specified response code or showing error page. - **BYPASS:** Bypasses some or all challenges. - **REDIRECT:** Redirects the request to the specified URL. These fields are required when `REDIRECT` is selected: `redirectUrl`, `redirectResponseCode`. - **SHOW_CAPTCHA:** Show a CAPTCHA Challenge page instead of the requested page. Regardless of action, no further rules are processed once a rule is matched. Allowed values for this property are: "ALLOW", "DETECT", "BLOCK", "BYPASS", "REDIRECT", "SHOW_CAPTCHA", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The action of this AccessRule. :rtype: str )r)r>r9r9r:rszAccessRule.actioncCs gd}t||s d}||_dS)ai Sets the action of this AccessRule. The action to take when the access criteria are met for a rule. If unspecified, defaults to `ALLOW`. - **ALLOW:** Takes no action, just logs the request. - **DETECT:** Takes no action, but creates an alert for the request. - **BLOCK:** Blocks the request by returning specified response code or showing error page. - **BYPASS:** Bypasses some or all challenges. - **REDIRECT:** Redirects the request to the specified URL. These fields are required when `REDIRECT` is selected: `redirectUrl`, `redirectResponseCode`. - **SHOW_CAPTCHA:** Show a CAPTCHA Challenge page instead of the requested page. Regardless of action, no further rules are processed once a rule is matched. :param action: The action of this AccessRule. :type: str )rrr r r r UNKNOWN_ENUM_VALUEN)rr))r7rallowed_valuesr9r9r:rs  cCr<)a Gets the block_action of this AccessRule. The method used to block requests if `action` is set to `BLOCK` and the access criteria are met. If unspecified, defaults to `SET_RESPONSE_CODE`. Allowed values for this property are: "SET_RESPONSE_CODE", "SHOW_ERROR_PAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The block_action of this AccessRule. :rtype: str )r*r>r9r9r:r9s zAccessRule.block_actioncC ddg}t||s d}||_dS)a, Sets the block_action of this AccessRule. The method used to block requests if `action` is set to `BLOCK` and the access criteria are met. If unspecified, defaults to `SET_RESPONSE_CODE`. :param block_action: The block_action of this AccessRule. :type: str r rrCN)rr*)r7rrDr9r9r:rHs  cCr<)a{ Gets the block_response_code of this AccessRule. The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the access criteria are met. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`. :return: The block_response_code of this AccessRule. :rtype: int r+r>r9r9r:rWr?zAccessRule.block_response_codecCr@)a Sets the block_response_code of this AccessRule. The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the access criteria are met. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`. :param block_response_code: The block_response_code of this AccessRule. :type: int NrF)r7rr9r9r:rcrAcCr<)az Gets the block_error_page_message of this AccessRule. The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access to the website is blocked.' :return: The block_error_page_message of this AccessRule. :rtype: str r,r>r9r9r:ror?z#AccessRule.block_error_page_messagecCr@)a Sets the block_error_page_message of this AccessRule. The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access to the website is blocked.' :param block_error_page_message: The block_error_page_message of this AccessRule. :type: str NrG)r7rr9r9r:r{rAcCr<)ac Gets the block_error_page_code of this AccessRule. The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access rules'. :return: The block_error_page_code of this AccessRule. :rtype: str r-r>r9r9r:rr?z AccessRule.block_error_page_codecCr@)aw Sets the block_error_page_code of this AccessRule. The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access rules'. :param block_error_page_code: The block_error_page_code of this AccessRule. :type: str NrH)r7rr9r9r:rrAcCr<)a Gets the block_error_page_description of this AccessRule. The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access blocked by website owner. Please contact support.' :return: The block_error_page_description of this AccessRule. :rtype: str r.r>r9r9r:rr?z'AccessRule.block_error_page_descriptioncCr@)a Sets the block_error_page_description of this AccessRule. The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access blocked by website owner. Please contact support.' :param block_error_page_description: The block_error_page_description of this AccessRule. :type: str NrI)r7rr9r9r:rrAcCr<)a0 Gets the bypass_challenges of this AccessRule. The list of challenges to bypass when `action` is set to `BYPASS`. If unspecified or empty, all challenges are bypassed. - **JS_CHALLENGE:** Bypasses JavaScript Challenge. - **DEVICE_FINGERPRINT_CHALLENGE:** Bypasses Device Fingerprint Challenge. - **HUMAN_INTERACTION_CHALLENGE:** Bypasses Human Interaction Challenge. - **CAPTCHA:** Bypasses CAPTCHA Challenge. Allowed values for items in this list are: "JS_CHALLENGE", "DEVICE_FINGERPRINT_CHALLENGE", "HUMAN_INTERACTION_CHALLENGE", "CAPTCHA", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The bypass_challenges of this AccessRule. :rtype: list[str] r/r>r9r9r:rszAccessRule.bypass_challengescs0gd|rfdd|D|dd<||_dS)a> Sets the bypass_challenges of this AccessRule. The list of challenges to bypass when `action` is set to `BYPASS`. If unspecified or empty, all challenges are bypassed. - **JS_CHALLENGE:** Bypasses JavaScript Challenge. - **DEVICE_FINGERPRINT_CHALLENGE:** Bypasses Device Fingerprint Challenge. - **HUMAN_INTERACTION_CHALLENGE:** Bypasses Human Interaction Challenge. - **CAPTCHA:** Bypasses CAPTCHA Challenge. :param bypass_challenges: The bypass_challenges of this AccessRule. :type: list[str] )rrrrcsg|] }t|s dn|qS)rC)r).0xrDr9r: sz0AccessRule.bypass_challenges..NrJ)r7rr9rMr:rs cCr<)a  Gets the redirect_url of this AccessRule. The target to which the request should be redirected, represented as a URI reference. Required when `action` is `REDIRECT`. :return: The redirect_url of this AccessRule. :rtype: str r0r>r9r9r:r r?zAccessRule.redirect_urlcCr@)a Sets the redirect_url of this AccessRule. The target to which the request should be redirected, represented as a URI reference. Required when `action` is `REDIRECT`. :param redirect_url: The redirect_url of this AccessRule. :type: str NrO)r7r r9r9r:r rAcCr<)a Gets the redirect_response_code of this AccessRule. The response status code to return when `action` is set to `REDIRECT`. - **MOVED_PERMANENTLY:** Used for designating the permanent movement of a page (numerical code - 301). - **FOUND:** Used for designating the temporary movement of a page (numerical code - 302). Allowed values for this property are: "MOVED_PERMANENTLY", "FOUND", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The redirect_response_code of this AccessRule. :rtype: str )r1r>r9r9r:r!sz!AccessRule.redirect_response_codecCrE)a Sets the redirect_response_code of this AccessRule. The response status code to return when `action` is set to `REDIRECT`. - **MOVED_PERMANENTLY:** Used for designating the permanent movement of a page (numerical code - 301). - **FOUND:** Used for designating the temporary movement of a page (numerical code - 302). :param redirect_response_code: The redirect_response_code of this AccessRule. :type: str rrrCN)rr1)r7r!rDr9r9r:r!s  cCr<)a Gets the captcha_title of this AccessRule. The title used when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. :return: The captcha_title of this AccessRule. :rtype: str r2r>r9r9r:r"#r?zAccessRule.captcha_titlecCr@)a Sets the captcha_title of this AccessRule. The title used when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. :param captcha_title: The captcha_title of this AccessRule. :type: str NrP)r7r"r9r9r:r"/rAcCr<)a Gets the captcha_header of this AccessRule. The text to show in the header when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. :return: The captcha_header of this AccessRule. :rtype: str r3r>r9r9r:r#;r?zAccessRule.captcha_headercCr@)a& Sets the captcha_header of this AccessRule. The text to show in the header when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. :param captcha_header: The captcha_header of this AccessRule. :type: str NrQ)r7r#r9r9r:r#GrAcCr<)a Gets the captcha_footer of this AccessRule. The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. :return: The captcha_footer of this AccessRule. :rtype: str r4r>r9r9r:r$Sr?zAccessRule.captcha_footercCr@)a& Sets the captcha_footer of this AccessRule. The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. :param captcha_footer: The captcha_footer of this AccessRule. :type: str NrR)r7r$r9r9r:r$_rAcCr<)a* Gets the captcha_submit_label of this AccessRule. The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `SHOW_CAPTCHA` and the request is challenged. :return: The captcha_submit_label of this AccessRule. :rtype: str r5r>r9r9r:r%kr?zAccessRule.captcha_submit_labelcCr@)a= Sets the captcha_submit_label of this AccessRule. The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `SHOW_CAPTCHA` and the request is challenged. :param captcha_submit_label: The captcha_submit_label of this AccessRule. :type: str NrS)r7r%r9r9r:r%wrAcCr<)af Gets the response_header_manipulation of this AccessRule. An object that represents an action to apply to an HTTP response headers if all rule criteria will be matched regardless of `action` value. :return: The response_header_manipulation of this AccessRule. :rtype: list[oci.waas.models.HeaderManipulationAction] r6r>r9r9r:r&r?z'AccessRule.response_header_manipulationcCr@)a Sets the response_header_manipulation of this AccessRule. An object that represents an action to apply to an HTTP response headers if all rule criteria will be matched regardless of `action` value. :param response_header_manipulation: The response_header_manipulation of this AccessRule. :type: list[oci.waas.models.HeaderManipulationAction] NrT)r7r&r9r9r:r&rAcCst|SN)rr>r9r9r:__repr__szAccessRule.__repr__cCs|durdS|j|jkS)NF)__dict__r7otherr9r9r:__eq__s zAccessRule.__eq__cCs ||k SrUr9rXr9r9r:__ne__s zAccessRule.__ne__N)(__name__ __module__ __qualname____doc__Z ACTION_ALLOWZ ACTION_DETECTZ ACTION_BLOCKZ ACTION_BYPASSZACTION_REDIRECTZACTION_SHOW_CAPTCHAZBLOCK_ACTION_SET_RESPONSE_CODEZBLOCK_ACTION_SHOW_ERROR_PAGEZBYPASS_CHALLENGES_JS_CHALLENGEZ.BYPASS_CHALLENGES_DEVICE_FINGERPRINT_CHALLENGEZ-BYPASS_CHALLENGES_HUMAN_INTERACTION_CHALLENGEZBYPASS_CHALLENGES_CAPTCHAZ(REDIRECT_RESPONSE_CODE_MOVED_PERMANENTLYZREDIRECT_RESPONSE_CODE_FOUNDr;propertyrsetterrrrrrrrrr r!r"r#r$r%r&rVrZr[r9r9r9r:r s                                  rN)Zoci.utilrrrZoci.decoratorsrobjectrr9r9r9r:s