Class ExecutePolicyRequest

java.lang.Object
com.styra.opa.openapi.models.operations.ExecutePolicyRequest

public class ExecutePolicyRequest extends Object
  • Constructor Details

  • Method Details

    • path

      public 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 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 Optional<Boolean> pretty()
      If parameter is `true`, response will formatted for humans.
    • provenance

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

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

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

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

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

      public static final ExecutePolicyRequest.Builder builder()
    • withPath

      public ExecutePolicyRequest withPath(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(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(Optional<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(Optional<Boolean> provenance)
      If parameter is true, response will include build/version info in addition to the result.
    • withExplain

      public ExecutePolicyRequest withExplain(Explain explain)
      Return query explanation in addition to result.
    • withExplain

      public ExecutePolicyRequest withExplain(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(Optional<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(Optional<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(Optional<Boolean> strictBuiltinErrors)
      Treat built-in function call errors as fatal and return an error immediately.
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

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

      public String toString()
      Overrides:
      toString in class Object