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

Class SuccessfulPolicyResponseWithStatusCode

java.lang.Object

com.styra.opa.openapi.models.shared.SuccessfulPolicyResponseWithStatusCode

All Implemented Interfaces:

Responses

public class SuccessfulPolicyResponseWithStatusCode
extends Object
implements Responses

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SuccessfulPolicyResponseWithStatusCode.Builder

Constructor Summary

Constructors

Constructor	Description
SuccessfulPolicyResponseWithStatusCode(String httpStatusCode)
SuccessfulPolicyResponseWithStatusCode(String httpStatusCode, Optional<? extends Result> result, Optional<? extends Map<String,Object>> metrics, Optional<String> decisionId, Optional<? extends Provenance> provenance)

Method Summary

Modifier and Type	Method	Description
static final SuccessfulPolicyResponseWithStatusCode.Builder	builder()
Optional<String>	decisionId()	If decision logging is enabled, this field contains a string that uniquely identifies the decision.
boolean	equals(Object o)
int	hashCode()
String	httpStatusCode()
Optional<Map<String,Object>>	metrics()	If query metrics are enabled, this field contains query performance metrics collected during the parse, compile, and evaluation steps.
Optional<Provenance>	provenance()	Provenance information can be requested on individual API calls and are returned inline with the API response.
Optional<Result>	result()	The base or virtual document referred to by the URL path.
String	toString()
SuccessfulPolicyResponseWithStatusCode	withDecisionId(String decisionId)	If decision logging is enabled, this field contains a string that uniquely identifies the decision.
SuccessfulPolicyResponseWithStatusCode	withDecisionId(Optional<String> decisionId)	If decision logging is enabled, this field contains a string that uniquely identifies the decision.
SuccessfulPolicyResponseWithStatusCode	withHttpStatusCode(String httpStatusCode)
SuccessfulPolicyResponseWithStatusCode	withMetrics(Map<String,Object> metrics)	If query metrics are enabled, this field contains query performance metrics collected during the parse, compile, and evaluation steps.
SuccessfulPolicyResponseWithStatusCode	withMetrics(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.
SuccessfulPolicyResponseWithStatusCode	withProvenance(Provenance provenance)	Provenance information can be requested on individual API calls and are returned inline with the API response.
SuccessfulPolicyResponseWithStatusCode	withProvenance(Optional<? extends Provenance> provenance)	Provenance information can be requested on individual API calls and are returned inline with the API response.
SuccessfulPolicyResponseWithStatusCode	withResult(Result result)	The base or virtual document referred to by the URL path.
SuccessfulPolicyResponseWithStatusCode	withResult(Optional<? extends Result> result)	The base or virtual document referred to by the URL path.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SuccessfulPolicyResponseWithStatusCode

public SuccessfulPolicyResponseWithStatusCode(String httpStatusCode,
 Optional<? extends Result> result,
 Optional<? extends Map<String,Object>> metrics,
 Optional<String> decisionId,
 Optional<? extends Provenance> provenance)

SuccessfulPolicyResponseWithStatusCode

public SuccessfulPolicyResponseWithStatusCode(String httpStatusCode)

Method Details

httpStatusCode

public String httpStatusCode()

Specified by:

httpStatusCode in interface Responses

result

public Optional<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 Optional<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 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 Optional<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.

builder

public static final SuccessfulPolicyResponseWithStatusCode.Builder builder()

withHttpStatusCode

public SuccessfulPolicyResponseWithStatusCode withHttpStatusCode(String httpStatusCode)

withResult

public SuccessfulPolicyResponseWithStatusCode withResult(Result result)

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

withResult

public SuccessfulPolicyResponseWithStatusCode withResult(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.

withMetrics

public SuccessfulPolicyResponseWithStatusCode withMetrics(Map<String,Object> metrics)

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

withMetrics

public SuccessfulPolicyResponseWithStatusCode withMetrics(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.

withDecisionId

public SuccessfulPolicyResponseWithStatusCode withDecisionId(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.

withDecisionId

public SuccessfulPolicyResponseWithStatusCode withDecisionId(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.

withProvenance

public SuccessfulPolicyResponseWithStatusCode withProvenance(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.

withProvenance

public SuccessfulPolicyResponseWithStatusCode withProvenance(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.

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