Class GetRulesetsRulesetRuleActionParameters


  • public final class GetRulesetsRulesetRuleActionParameters
    extends java.lang.Object
    • Method Detail

      • additionalCacheablePorts

        public java.util.List<java.lang.Integer> additionalCacheablePorts()
        Returns:
        Allows for the ability to support caching on non-standard ports.
      • automaticHttpsRewrites

        public java.util.Optional<java.lang.Boolean> automaticHttpsRewrites()
        Returns:
        Turn on or off Cloudflare Automatic HTTPS rewrites.
      • bic

        public java.util.Optional<java.lang.Boolean> bic()
        Returns:
        Inspect the visitor's browser for headers commonly associated with spammers and certain bots.
      • cache

        public java.util.Optional<java.lang.Boolean> cache()
        Returns:
        Whether to cache if expression matches.
      • content

        public java.util.Optional<java.lang.String> content()
        Returns:
        Content of the custom error response
      • contentType

        public java.util.Optional<java.lang.String> contentType()
        Returns:
        Content-Type of the custom error response
      • cookieFields

        public java.util.List<java.lang.String> cookieFields()
        Returns:
        List of cookie values to include as part of custom fields logging.
      • disableApps

        public java.util.Optional<java.lang.Boolean> disableApps()
        Returns:
        Turn off all active Cloudflare Apps.
      • disableRailgun

        public java.util.Optional<java.lang.Boolean> disableRailgun()
        Returns:
        Turn off railgun feature of the Cloudflare Speed app.
      • disableZaraz

        public java.util.Optional<java.lang.Boolean> disableZaraz()
        Returns:
        Turn off zaraz feature.
      • emailObfuscation

        public java.util.Optional<java.lang.Boolean> emailObfuscation()
        Returns:
        Turn on or off the Cloudflare Email Obfuscation feature of the Cloudflare Scrape Shield app.
      • hostHeader

        public java.util.Optional<java.lang.String> hostHeader()
        Returns:
        Host Header that request origin receives.
      • hotlinkProtection

        public java.util.Optional<java.lang.Boolean> hotlinkProtection()
        Returns:
        Turn on or off the hotlink protection feature.
      • id

        public java.util.Optional<java.lang.String> id()
        Returns:
        The ID of the Ruleset to target.
      • increment

        public java.util.Optional<java.lang.Integer> increment()
      • mirage

        public java.util.Optional<java.lang.Boolean> mirage()
        Returns:
        Turn on or off Cloudflare Mirage of the Cloudflare Speed app.
      • opportunisticEncryption

        public java.util.Optional<java.lang.Boolean> opportunisticEncryption()
        Returns:
        Turn on or off the Cloudflare Opportunistic Encryption feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
      • originCacheControl

        public java.util.Optional<java.lang.Boolean> originCacheControl()
        Returns:
        Sets a more compliant mode for parsing Cache Control headers
      • originErrorPagePassthru

        public java.util.Optional<java.lang.Boolean> originErrorPagePassthru()
        Returns:
        Pass-through error page for origin.
      • phases

        public java.util.List<java.lang.String> phases()
        Returns:
        Point in the request/response lifecycle where the ruleset will be created. Available values: `ddos_l4`, `ddos_l7`, `http_config_settings`, `http_custom_errors`, `http_log_custom_fields`, `http_ratelimit`, `http_request_cache_settings`, `http_request_dynamic_redirect`, `http_request_firewall_custom`, `http_request_firewall_managed`, `http_request_late_transform`, `http_request_origin`, `http_request_redirect`, `http_request_sanitize`, `http_request_sbfm`, `http_request_transform`, `http_response_compression`, `http_response_firewall_managed`, `http_response_headers_transform`, `magic_transit`
      • polish

        public java.util.Optional<java.lang.String> polish()
        Returns:
        Apply options from the Polish feature of the Cloudflare Speed app.
      • products

        public java.util.List<java.lang.String> products()
        Returns:
        Products to target with the actions. Available values: `bic`, `hot`, `ratelimit`, `securityLevel`, `uablock`, `waf`, `zonelockdown`
      • readTimeout

        public java.util.Optional<java.lang.Integer> readTimeout()
        Returns:
        Sets the timeout value for reading content from an origin server.
      • requestFields

        public java.util.List<java.lang.String> requestFields()
        Returns:
        List of request headers to include as part of custom fields logging, in lowercase.
      • respectStrongEtags

        public java.util.Optional<java.lang.Boolean> respectStrongEtags()
        Returns:
        Respect strong ETags.
      • responseFields

        public java.util.List<java.lang.String> responseFields()
        Returns:
        List of response headers to include as part of custom fields logging, in lowercase.
      • rocketLoader

        public java.util.Optional<java.lang.Boolean> rocketLoader()
        Returns:
        Turn on or off Cloudflare Rocket Loader in the Cloudflare Speed app.
      • rules

        public java.util.Map<java.lang.String,​java.lang.String> rules()
        Returns:
        Map of managed WAF rule ID to comma-delimited string of ruleset rule IDs. Example: `rules = { "efb7b8c949ac4650a09736fc376e9aee" = "5de7edfa648c4d6891dc3e7f84534ffa,e3a567afc347477d9702d9047e97d760" }`
      • ruleset

        public java.util.Optional<java.lang.String> ruleset()
        Returns:
        Which ruleset ID to target.
      • rulesets

        public java.util.List<java.lang.String> rulesets()
        Returns:
        List of managed WAF rule IDs to target. Only valid when the `"action"` is set to skip
      • securityLevel

        public java.util.Optional<java.lang.String> securityLevel()
        Returns:
        Control options for the Security Level feature from the Security app.
      • serverSideExcludes

        public java.util.Optional<java.lang.Boolean> serverSideExcludes()
        Returns:
        Turn on or off the Server Side Excludes feature of the Cloudflare Scrape Shield app.
      • ssl

        public java.util.Optional<java.lang.String> ssl()
        Returns:
        Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
      • statusCode

        public java.util.Optional<java.lang.Integer> statusCode()
        Returns:
        HTTP status code of the custom error response
      • sxg

        public java.util.Optional<java.lang.Boolean> sxg()
        Returns:
        Turn on or off the SXG feature.
      • version

        public java.lang.String version()
        Returns:
        Version of the ruleset to filter on.