Package dev.openfga.sdk.api.model

Class CheckRequest

java.lang.Object

dev.openfga.sdk.api.model.CheckRequest

public class CheckRequest
extends java.lang.Object

CheckRequest

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	JSON_PROPERTY_AUTHORIZATION_MODEL_ID
static java.lang.String	JSON_PROPERTY_CONSISTENCY
static java.lang.String	JSON_PROPERTY_CONTEXT
static java.lang.String	JSON_PROPERTY_CONTEXTUAL_TUPLES
static java.lang.String	JSON_PROPERTY_TRACE
static java.lang.String	JSON_PROPERTY_TUPLE_KEY

Constructor Summary

Constructors

Constructor	Description
CheckRequest()
CheckRequest(java.lang.Boolean trace)

Method Summary

Modifier and Type	Method	Description
CheckRequest	authorizationModelId(java.lang.String authorizationModelId)
CheckRequest	consistency(ConsistencyPreference consistency)
CheckRequest	context(java.lang.Object context)
CheckRequest	contextualTuples(ContextualTupleKeys contextualTuples)
boolean	equals(java.lang.Object o)	Return true if this Check_request object is equal to o.
java.lang.String	getAuthorizationModelId()	Get authorizationModelId
ConsistencyPreference	getConsistency()	Get consistency
java.lang.Object	getContext()	Additional request context that will be used to evaluate any ABAC conditions encountered in the query evaluation.
ContextualTupleKeys	getContextualTuples()	Get contextualTuples
java.lang.Boolean	getTrace()	Defaults to false.
CheckRequestTupleKey	getTupleKey()	Get tupleKey
int	hashCode()
void	setAuthorizationModelId(java.lang.String authorizationModelId)
void	setConsistency(ConsistencyPreference consistency)
void	setContext(java.lang.Object context)
void	setContextualTuples(ContextualTupleKeys contextualTuples)
void	setTupleKey(CheckRequestTupleKey tupleKey)
java.lang.String	toString()
java.lang.String	toUrlQueryString()	Convert the instance into URL query string.
java.lang.String	toUrlQueryString(java.lang.String prefix)	Convert the instance into URL query string.
CheckRequest	tupleKey(CheckRequestTupleKey tupleKey)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_TUPLE_KEY

public static final java.lang.String JSON_PROPERTY_TUPLE_KEY

See Also:

Constant Field Values

JSON_PROPERTY_CONTEXTUAL_TUPLES

public static final java.lang.String JSON_PROPERTY_CONTEXTUAL_TUPLES

See Also:

Constant Field Values

JSON_PROPERTY_AUTHORIZATION_MODEL_ID

public static final java.lang.String JSON_PROPERTY_AUTHORIZATION_MODEL_ID

See Also:

Constant Field Values

JSON_PROPERTY_TRACE

public static final java.lang.String JSON_PROPERTY_TRACE

See Also:

Constant Field Values

JSON_PROPERTY_CONTEXT

public static final java.lang.String JSON_PROPERTY_CONTEXT

See Also:

Constant Field Values

JSON_PROPERTY_CONSISTENCY

public static final java.lang.String JSON_PROPERTY_CONSISTENCY

See Also:

Constant Field Values

Constructor Detail

CheckRequest

public CheckRequest()

CheckRequest

public CheckRequest(java.lang.Boolean trace)

Method Detail

tupleKey

public CheckRequest tupleKey(CheckRequestTupleKey tupleKey)

getTupleKey

@Nonnull
public CheckRequestTupleKey getTupleKey()

Get tupleKey

Returns:

tupleKey

setTupleKey

public void setTupleKey(CheckRequestTupleKey tupleKey)

contextualTuples

public CheckRequest contextualTuples(ContextualTupleKeys contextualTuples)

getContextualTuples

@Nullable
public ContextualTupleKeys getContextualTuples()

Get contextualTuples

Returns:

contextualTuples

setContextualTuples

public void setContextualTuples(ContextualTupleKeys contextualTuples)

authorizationModelId

public CheckRequest authorizationModelId(java.lang.String authorizationModelId)

getAuthorizationModelId

@Nullable
public java.lang.String getAuthorizationModelId()

Get authorizationModelId

Returns:

authorizationModelId

setAuthorizationModelId

public void setAuthorizationModelId(java.lang.String authorizationModelId)

getTrace

@Nullable
public java.lang.Boolean getTrace()

Defaults to false. Making it true has performance implications.

Returns:

trace

context

public CheckRequest context(java.lang.Object context)

getContext

@Nullable
public java.lang.Object getContext()

Additional request context that will be used to evaluate any ABAC conditions encountered in the query evaluation.

Returns:

context

setContext

public void setContext(java.lang.Object context)

consistency

public CheckRequest consistency(ConsistencyPreference consistency)

getConsistency

@Nullable
public ConsistencyPreference getConsistency()

Get consistency

Returns:

consistency

setConsistency

public void setConsistency(ConsistencyPreference consistency)

equals

public boolean equals(java.lang.Object o)

Return true if this Check_request object is equal to 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

toUrlQueryString

public java.lang.String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public java.lang.String toUrlQueryString(java.lang.String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string