dev.openfga.sdk.api.model.CheckRequest Maven / Gradle / Ivy
/*
* OpenFGA
* A high performance and flexible authorization/permission engine built for developers and inspired by Google Zanzibar.
*
* The version of the OpenAPI document: 1.x
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package dev.openfga.sdk.api.model;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Objects;
import java.util.StringJoiner;
/**
* CheckRequest
*/
@JsonPropertyOrder({
CheckRequest.JSON_PROPERTY_TUPLE_KEY,
CheckRequest.JSON_PROPERTY_CONTEXTUAL_TUPLES,
CheckRequest.JSON_PROPERTY_AUTHORIZATION_MODEL_ID,
CheckRequest.JSON_PROPERTY_TRACE,
CheckRequest.JSON_PROPERTY_CONTEXT,
CheckRequest.JSON_PROPERTY_CONSISTENCY
})
public class CheckRequest {
public static final String JSON_PROPERTY_TUPLE_KEY = "tuple_key";
private CheckRequestTupleKey tupleKey;
public static final String JSON_PROPERTY_CONTEXTUAL_TUPLES = "contextual_tuples";
private ContextualTupleKeys contextualTuples;
public static final String JSON_PROPERTY_AUTHORIZATION_MODEL_ID = "authorization_model_id";
private String authorizationModelId;
public static final String JSON_PROPERTY_TRACE = "trace";
private Boolean trace;
public static final String JSON_PROPERTY_CONTEXT = "context";
private Object context;
public static final String JSON_PROPERTY_CONSISTENCY = "consistency";
private ConsistencyPreference consistency = ConsistencyPreference.UNSPECIFIED;
public CheckRequest() {}
@JsonCreator
public CheckRequest(@JsonProperty(JSON_PROPERTY_TRACE) Boolean trace) {
this();
this.trace = trace;
}
public CheckRequest tupleKey(CheckRequestTupleKey tupleKey) {
this.tupleKey = tupleKey;
return this;
}
/**
* Get tupleKey
* @return tupleKey
**/
@javax.annotation.Nonnull
@JsonProperty(JSON_PROPERTY_TUPLE_KEY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public CheckRequestTupleKey getTupleKey() {
return tupleKey;
}
@JsonProperty(JSON_PROPERTY_TUPLE_KEY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setTupleKey(CheckRequestTupleKey tupleKey) {
this.tupleKey = tupleKey;
}
public CheckRequest contextualTuples(ContextualTupleKeys contextualTuples) {
this.contextualTuples = contextualTuples;
return this;
}
/**
* Get contextualTuples
* @return contextualTuples
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CONTEXTUAL_TUPLES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public ContextualTupleKeys getContextualTuples() {
return contextualTuples;
}
@JsonProperty(JSON_PROPERTY_CONTEXTUAL_TUPLES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setContextualTuples(ContextualTupleKeys contextualTuples) {
this.contextualTuples = contextualTuples;
}
public CheckRequest authorizationModelId(String authorizationModelId) {
this.authorizationModelId = authorizationModelId;
return this;
}
/**
* Get authorizationModelId
* @return authorizationModelId
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_AUTHORIZATION_MODEL_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getAuthorizationModelId() {
return authorizationModelId;
}
@JsonProperty(JSON_PROPERTY_AUTHORIZATION_MODEL_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAuthorizationModelId(String authorizationModelId) {
this.authorizationModelId = authorizationModelId;
}
/**
* Defaults to false. Making it true has performance implications.
* @return trace
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_TRACE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getTrace() {
return trace;
}
public CheckRequest context(Object context) {
this.context = context;
return this;
}
/**
* Additional request context that will be used to evaluate any ABAC conditions encountered in the query evaluation.
* @return context
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CONTEXT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Object getContext() {
return context;
}
@JsonProperty(JSON_PROPERTY_CONTEXT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setContext(Object context) {
this.context = context;
}
public CheckRequest consistency(ConsistencyPreference consistency) {
this.consistency = consistency;
return this;
}
/**
* Get consistency
* @return consistency
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CONSISTENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public ConsistencyPreference getConsistency() {
return consistency;
}
@JsonProperty(JSON_PROPERTY_CONSISTENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setConsistency(ConsistencyPreference consistency) {
this.consistency = consistency;
}
/**
* Return true if this Check_request object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CheckRequest checkRequest = (CheckRequest) o;
return Objects.equals(this.tupleKey, checkRequest.tupleKey)
&& Objects.equals(this.contextualTuples, checkRequest.contextualTuples)
&& Objects.equals(this.authorizationModelId, checkRequest.authorizationModelId)
&& Objects.equals(this.trace, checkRequest.trace)
&& Objects.equals(this.context, checkRequest.context)
&& Objects.equals(this.consistency, checkRequest.consistency);
}
@Override
public int hashCode() {
return Objects.hash(tupleKey, contextualTuples, authorizationModelId, trace, context, consistency);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CheckRequest {\n");
sb.append(" tupleKey: ").append(toIndentedString(tupleKey)).append("\n");
sb.append(" contextualTuples: ")
.append(toIndentedString(contextualTuples))
.append("\n");
sb.append(" authorizationModelId: ")
.append(toIndentedString(authorizationModelId))
.append("\n");
sb.append(" trace: ").append(toIndentedString(trace)).append("\n");
sb.append(" context: ").append(toIndentedString(context)).append("\n");
sb.append(" consistency: ").append(toIndentedString(consistency)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
/**
* Convert the instance into URL query string.
*
* @return URL query string
*/
public String toUrlQueryString() {
return toUrlQueryString(null);
}
/**
* Convert the instance into URL query string.
*
* @param prefix prefix of the query string
* @return URL query string
*/
public String toUrlQueryString(String prefix) {
String suffix = "";
String containerSuffix = "";
String containerPrefix = "";
if (prefix == null) {
// style=form, explode=true, e.g. /pet?name=cat&type=manx
prefix = "";
} else {
// deepObject style e.g. /pet?id[name]=cat&id[type]=manx
prefix = prefix + "[";
suffix = "]";
containerSuffix = "]";
containerPrefix = "[";
}
StringJoiner joiner = new StringJoiner("&");
// add `tuple_key` to the URL query string
if (getTupleKey() != null) {
joiner.add(getTupleKey().toUrlQueryString(prefix + "tuple_key" + suffix));
}
// add `contextual_tuples` to the URL query string
if (getContextualTuples() != null) {
joiner.add(getContextualTuples().toUrlQueryString(prefix + "contextual_tuples" + suffix));
}
// add `authorization_model_id` to the URL query string
if (getAuthorizationModelId() != null) {
joiner.add(String.format(
"%sauthorization_model_id%s=%s",
prefix,
suffix,
URLEncoder.encode(String.valueOf(getAuthorizationModelId()), StandardCharsets.UTF_8)
.replaceAll("\\+", "%20")));
}
// add `trace` to the URL query string
if (getTrace() != null) {
joiner.add(String.format(
"%strace%s=%s",
prefix,
suffix,
URLEncoder.encode(String.valueOf(getTrace()), StandardCharsets.UTF_8)
.replaceAll("\\+", "%20")));
}
// add `context` to the URL query string
if (getContext() != null) {
joiner.add(String.format(
"%scontext%s=%s",
prefix,
suffix,
URLEncoder.encode(String.valueOf(getContext()), StandardCharsets.UTF_8)
.replaceAll("\\+", "%20")));
}
// add `consistency` to the URL query string
if (getConsistency() != null) {
joiner.add(String.format(
"%sconsistency%s=%s",
prefix,
suffix,
URLEncoder.encode(String.valueOf(getConsistency()), StandardCharsets.UTF_8)
.replaceAll("\\+", "%20")));
}
return joiner.toString();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy