Package dev.openfga.sdk.api.model

Class RelationReference

java.lang.Object

dev.openfga.sdk.api.model.RelationReference

public class RelationReference
extends java.lang.Object

RelationReference represents a relation of a particular object type (e.g. 'document#viewer').

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	JSON_PROPERTY_CONDITION
static java.lang.String	JSON_PROPERTY_RELATION
static java.lang.String	JSON_PROPERTY_TYPE
static java.lang.String	JSON_PROPERTY_WILDCARD

Constructor Summary

Constructors

Constructor	Description
RelationReference()

Method Summary

Modifier and Type	Method	Description
RelationReference	condition(java.lang.String condition)
boolean	equals(java.lang.Object o)	Return true if this RelationReference object is equal to o.
java.lang.String	getCondition()	The name of a condition that is enforced over the allowed relation.
java.lang.String	getRelation()	Get relation
java.lang.String	getType()	Get type
java.lang.Object	getWildcard()	Get wildcard
int	hashCode()
RelationReference	relation(java.lang.String relation)
void	setCondition(java.lang.String condition)
void	setRelation(java.lang.String relation)
void	setType(java.lang.String type)
void	setWildcard(java.lang.Object wildcard)
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.
RelationReference	type(java.lang.String type)
RelationReference	wildcard(java.lang.Object wildcard)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_TYPE

public static final java.lang.String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_RELATION

public static final java.lang.String JSON_PROPERTY_RELATION

See Also:

Constant Field Values

JSON_PROPERTY_WILDCARD

public static final java.lang.String JSON_PROPERTY_WILDCARD

See Also:

Constant Field Values

JSON_PROPERTY_CONDITION

public static final java.lang.String JSON_PROPERTY_CONDITION

See Also:

Constant Field Values

Constructor Detail

RelationReference

public RelationReference()

Method Detail

type

public RelationReference type(java.lang.String type)

getType

@Nonnull
public java.lang.String getType()

Get type

Returns:

type

setType

public void setType(java.lang.String type)

relation

public RelationReference relation(java.lang.String relation)

getRelation

@Nullable
public java.lang.String getRelation()

Get relation

Returns:

relation

setRelation

public void setRelation(java.lang.String relation)

wildcard

public RelationReference wildcard(java.lang.Object wildcard)

getWildcard

@Nullable
public java.lang.Object getWildcard()

Get wildcard

Returns:

wildcard

setWildcard

public void setWildcard(java.lang.Object wildcard)

condition

public RelationReference condition(java.lang.String condition)

getCondition

@Nullable
public java.lang.String getCondition()

The name of a condition that is enforced over the allowed relation.

Returns:

condition

setCondition

public void setCondition(java.lang.String condition)

equals

public boolean equals(java.lang.Object o)

Return true if this RelationReference 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