Package com.styra.opa.openapi.models.shared

Class SuccessfulPolicyResponse.Builder

java.lang.Object

com.styra.opa.openapi.models.shared.SuccessfulPolicyResponse.Builder

Enclosing class:

SuccessfulPolicyResponse

public static final class SuccessfulPolicyResponse.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
SuccessfulPolicyResponse	build()
SuccessfulPolicyResponse.Builder	decisionId(String decisionId)	If decision logging is enabled, this field contains a string that uniquely identifies the decision.
SuccessfulPolicyResponse.Builder	decisionId(Optional<String> decisionId)	If decision logging is enabled, this field contains a string that uniquely identifies the decision.
SuccessfulPolicyResponse.Builder	metrics(Map<String,Object> metrics)	If query metrics are enabled, this field contains query performance metrics collected during the parse, compile, and evaluation steps.
SuccessfulPolicyResponse.Builder	metrics(Optional<? extends Map<String,Object>> metrics)	If query metrics are enabled, this field contains query performance metrics collected during the parse, compile, and evaluation steps.
SuccessfulPolicyResponse.Builder	provenance(Provenance provenance)	Provenance information can be requested on individual API calls and are returned inline with the API response.
SuccessfulPolicyResponse.Builder	provenance(Optional<? extends Provenance> provenance)	Provenance information can be requested on individual API calls and are returned inline with the API response.
SuccessfulPolicyResponse.Builder	result(Result result)	The base or virtual document referred to by the URL path.
SuccessfulPolicyResponse.Builder	result(Optional<? extends Result> result)	The base or virtual document referred to by the URL path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

result

public SuccessfulPolicyResponse.Builder result(Result result)

The base or virtual document referred to by the URL path. If the path is undefined, this key will be omitted.

result

public SuccessfulPolicyResponse.Builder result(Optional<? extends Result> result)

The base or virtual document referred to by the URL path. If the path is undefined, this key will be omitted.

metrics

public SuccessfulPolicyResponse.Builder metrics(Map<String,Object> metrics)

If query metrics are enabled, this field contains query performance metrics collected during the parse, compile, and evaluation steps.

metrics

public SuccessfulPolicyResponse.Builder metrics(Optional<? extends Map<String,Object>> metrics)

If query metrics are enabled, this field contains query performance metrics collected during the parse, compile, and evaluation steps.

decisionId

public SuccessfulPolicyResponse.Builder decisionId(String decisionId)

If decision logging is enabled, this field contains a string that uniquely identifies the decision. The identifier will be included in the decision log event for this decision. Callers can use the identifier for correlation purposes.

decisionId

public SuccessfulPolicyResponse.Builder decisionId(Optional<String> decisionId)

If decision logging is enabled, this field contains a string that uniquely identifies the decision. The identifier will be included in the decision log event for this decision. Callers can use the identifier for correlation purposes.

provenance

public SuccessfulPolicyResponse.Builder provenance(Provenance provenance)

Provenance information can be requested on individual API calls and are returned inline with the API response. To obtain provenance information on an API call, specify the `provenance=true` query parameter when executing the API call.

provenance

public SuccessfulPolicyResponse.Builder provenance(Optional<? extends Provenance> provenance)

Provenance information can be requested on individual API calls and are returned inline with the API response. To obtain provenance information on an API call, specify the `provenance=true` query parameter when executing the API call.

build

public SuccessfulPolicyResponse build()