Class ExecutePolicyRequest


  • public class ExecutePolicyRequest
    extends java.lang.Object
    • Constructor Detail

      • ExecutePolicyRequest

        public ExecutePolicyRequest​(java.lang.String path,
                                    java.util.Optional<? extends GzipAcceptEncoding> acceptEncoding,
                                    java.util.Optional<java.lang.Boolean> pretty,
                                    java.util.Optional<java.lang.Boolean> provenance,
                                    java.util.Optional<? extends Explain> explain,
                                    java.util.Optional<java.lang.Boolean> metrics,
                                    java.util.Optional<java.lang.Boolean> instrument,
                                    java.util.Optional<java.lang.Boolean> strictBuiltinErrors)
      • ExecutePolicyRequest

        public ExecutePolicyRequest​(java.lang.String path)
    • Method Detail

      • path

        public java.lang.String path()
        The path separator is used to access values inside object and array documents. If the path indexes into an array, the server will attempt to convert the array index to an integer. If the path element cannot be converted to an integer, the server will respond with 404.
      • acceptEncoding

        public java.util.Optional<GzipAcceptEncoding> acceptEncoding()
        Indicates the server should respond with a gzip encoded body. The server will send the compressed response only if its length is above `server.encoding.gzip.min_length` value. See the configuration section
      • pretty

        public java.util.Optional<java.lang.Boolean> pretty()
        If parameter is `true`, response will formatted for humans.
      • provenance

        public java.util.Optional<java.lang.Boolean> provenance()
        If parameter is true, response will include build/version info in addition to the result.
      • explain

        public java.util.Optional<Explain> explain()
        Return query explanation in addition to result.
      • metrics

        public java.util.Optional<java.lang.Boolean> metrics()
        Return query performance metrics in addition to result.
      • instrument

        public java.util.Optional<java.lang.Boolean> instrument()
        Instrument query evaluation and return a superset of performance metrics in addition to result.
      • strictBuiltinErrors

        public java.util.Optional<java.lang.Boolean> strictBuiltinErrors()
        Treat built-in function call errors as fatal and return an error immediately.
      • withPath

        public ExecutePolicyRequest withPath​(java.lang.String path)
        The path separator is used to access values inside object and array documents. If the path indexes into an array, the server will attempt to convert the array index to an integer. If the path element cannot be converted to an integer, the server will respond with 404.
      • withAcceptEncoding

        public ExecutePolicyRequest withAcceptEncoding​(GzipAcceptEncoding acceptEncoding)
        Indicates the server should respond with a gzip encoded body. The server will send the compressed response only if its length is above `server.encoding.gzip.min_length` value. See the configuration section
      • withAcceptEncoding

        public ExecutePolicyRequest withAcceptEncoding​(java.util.Optional<? extends GzipAcceptEncoding> acceptEncoding)
        Indicates the server should respond with a gzip encoded body. The server will send the compressed response only if its length is above `server.encoding.gzip.min_length` value. See the configuration section
      • withPretty

        public ExecutePolicyRequest withPretty​(boolean pretty)
        If parameter is `true`, response will formatted for humans.
      • withPretty

        public ExecutePolicyRequest withPretty​(java.util.Optional<java.lang.Boolean> pretty)
        If parameter is `true`, response will formatted for humans.
      • withProvenance

        public ExecutePolicyRequest withProvenance​(boolean provenance)
        If parameter is true, response will include build/version info in addition to the result.
      • withProvenance

        public ExecutePolicyRequest withProvenance​(java.util.Optional<java.lang.Boolean> provenance)
        If parameter is true, response will include build/version info in addition to the result.
      • withExplain

        public ExecutePolicyRequest withExplain​(java.util.Optional<? extends Explain> explain)
        Return query explanation in addition to result.
      • withMetrics

        public ExecutePolicyRequest withMetrics​(boolean metrics)
        Return query performance metrics in addition to result.
      • withMetrics

        public ExecutePolicyRequest withMetrics​(java.util.Optional<java.lang.Boolean> metrics)
        Return query performance metrics in addition to result.
      • withInstrument

        public ExecutePolicyRequest withInstrument​(boolean instrument)
        Instrument query evaluation and return a superset of performance metrics in addition to result.
      • withInstrument

        public ExecutePolicyRequest withInstrument​(java.util.Optional<java.lang.Boolean> instrument)
        Instrument query evaluation and return a superset of performance metrics in addition to result.
      • withStrictBuiltinErrors

        public ExecutePolicyRequest withStrictBuiltinErrors​(boolean strictBuiltinErrors)
        Treat built-in function call errors as fatal and return an error immediately.
      • withStrictBuiltinErrors

        public ExecutePolicyRequest withStrictBuiltinErrors​(java.util.Optional<java.lang.Boolean> strictBuiltinErrors)
        Treat built-in function call errors as fatal and return an error immediately.
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object