Package sh.ory.keto.api

Class ReadApi

java.lang.Object
sh.ory.keto.api.ReadApi
public class ReadApi
extends java.lang.Object

  • Constructor Summary

    Constructors
    Constructor Description
    ReadApi()  
    ReadApi​(ApiClient apiClient)  

  • Method Summary

    Modifier and Type Method Description
    ApiClient getApiClient()  
    GetCheckResponse getCheck​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject)
    Check a relation tuple To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
    okhttp3.Call getCheckAsync​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, ApiCallback<GetCheckResponse> _callback)
    Check a relation tuple (asynchronously) To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
    okhttp3.Call getCheckCall​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, ApiCallback _callback)
    Build call for getCheck
    ApiResponse<GetCheckResponse> getCheckWithHttpInfo​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject)
    Check a relation tuple To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
    ExpandTree getExpand​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.Long maxDepth)
    Expand a Relation Tuple Use this endpoint to expand a relation tuple.
    okhttp3.Call getExpandAsync​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.Long maxDepth, ApiCallback<ExpandTree> _callback)
    Expand a Relation Tuple (asynchronously) Use this endpoint to expand a relation tuple.
    okhttp3.Call getExpandCall​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.Long maxDepth, ApiCallback _callback)
    Build call for getExpand
    ApiResponse<ExpandTree> getExpandWithHttpInfo​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.Long maxDepth)
    Expand a Relation Tuple Use this endpoint to expand a relation tuple.
    GetRelationTuplesResponse getRelationTuples​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, java.lang.String pageToken, java.lang.Long pageSize)
    Query relation tuples Get all relation tuples that match the query.
    okhttp3.Call getRelationTuplesAsync​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, java.lang.String pageToken, java.lang.Long pageSize, ApiCallback<GetRelationTuplesResponse> _callback)
    Query relation tuples (asynchronously) Get all relation tuples that match the query.
    okhttp3.Call getRelationTuplesCall​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, java.lang.String pageToken, java.lang.Long pageSize, ApiCallback _callback)
    Build call for getRelationTuples
    ApiResponse<GetRelationTuplesResponse> getRelationTuplesWithHttpInfo​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, java.lang.String pageToken, java.lang.Long pageSize)
    Query relation tuples Get all relation tuples that match the query.
    GetCheckResponse postCheck​(InternalRelationTuple payload)
    Check a relation tuple To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
    okhttp3.Call postCheckAsync​(InternalRelationTuple payload, ApiCallback<GetCheckResponse> _callback)
    Check a relation tuple (asynchronously) To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
    okhttp3.Call postCheckCall​(InternalRelationTuple payload, ApiCallback _callback)
    Build call for postCheck
    ApiResponse<GetCheckResponse> postCheckWithHttpInfo​(InternalRelationTuple payload)
    Check a relation tuple To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
    void setApiClient​(ApiClient apiClient)  

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ReadApi

      public ReadApi()

    • ReadApi

      public ReadApi​(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient​(ApiClient apiClient)

    • getCheckCall

      public okhttp3.Call getCheckCall​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, ApiCallback _callback) throws ApiException
      Build call for getCheck
      Parameters:
      namespace - Namespace of the Relation Tuple (required)
      _object - Object of the Relation Tuple (required)
      relation - Relation of the Relation Tuple (required)
      subject - Subject of the Relation Tuple The subject follows the subject string encoding format. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 getCheckResponse -
      400 The standard error format -
      403 getCheckResponse -
      500 The standard error format -

    • getCheck

      public GetCheckResponse getCheck​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject) throws ApiException
      Check a relation tuple To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
      Parameters:
      namespace - Namespace of the Relation Tuple (required)
      _object - Object of the Relation Tuple (required)
      relation - Relation of the Relation Tuple (required)
      subject - Subject of the Relation Tuple The subject follows the subject string encoding format. (optional)
      Returns:
      GetCheckResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 getCheckResponse -
      400 The standard error format -
      403 getCheckResponse -
      500 The standard error format -

    • getCheckWithHttpInfo

      public ApiResponse<GetCheckResponse> getCheckWithHttpInfo​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject) throws ApiException
      Check a relation tuple To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
      Parameters:
      namespace - Namespace of the Relation Tuple (required)
      _object - Object of the Relation Tuple (required)
      relation - Relation of the Relation Tuple (required)
      subject - Subject of the Relation Tuple The subject follows the subject string encoding format. (optional)
      Returns:
      ApiResponse<GetCheckResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 getCheckResponse -
      400 The standard error format -
      403 getCheckResponse -
      500 The standard error format -

    • getCheckAsync

      public okhttp3.Call getCheckAsync​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, ApiCallback<GetCheckResponse> _callback) throws ApiException
      Check a relation tuple (asynchronously) To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
      Parameters:
      namespace - Namespace of the Relation Tuple (required)
      _object - Object of the Relation Tuple (required)
      relation - Relation of the Relation Tuple (required)
      subject - Subject of the Relation Tuple The subject follows the subject string encoding format. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 getCheckResponse -
      400 The standard error format -
      403 getCheckResponse -
      500 The standard error format -

    • getExpandCall

      public okhttp3.Call getExpandCall​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.Long maxDepth, ApiCallback _callback) throws ApiException
      Build call for getExpand
      Parameters:
      namespace - Namespace of the Relation Tuple (required)
      _object - Object of the Relation Tuple (required)
      relation - Relation of the Relation Tuple (required)
      maxDepth - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 expandTree -
      400 The standard error format -
      404 The standard error format -
      500 The standard error format -

    • getExpand

      public ExpandTree getExpand​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.Long maxDepth) throws ApiException
      Expand a Relation Tuple Use this endpoint to expand a relation tuple.
      Parameters:
      namespace - Namespace of the Relation Tuple (required)
      _object - Object of the Relation Tuple (required)
      relation - Relation of the Relation Tuple (required)
      maxDepth - (optional)
      Returns:
      ExpandTree
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 expandTree -
      400 The standard error format -
      404 The standard error format -
      500 The standard error format -

    • getExpandWithHttpInfo

      public ApiResponse<ExpandTree> getExpandWithHttpInfo​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.Long maxDepth) throws ApiException
      Expand a Relation Tuple Use this endpoint to expand a relation tuple.
      Parameters:
      namespace - Namespace of the Relation Tuple (required)
      _object - Object of the Relation Tuple (required)
      relation - Relation of the Relation Tuple (required)
      maxDepth - (optional)
      Returns:
      ApiResponse<ExpandTree>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 expandTree -
      400 The standard error format -
      404 The standard error format -
      500 The standard error format -

    • getExpandAsync

      public okhttp3.Call getExpandAsync​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.Long maxDepth, ApiCallback<ExpandTree> _callback) throws ApiException
      Expand a Relation Tuple (asynchronously) Use this endpoint to expand a relation tuple.
      Parameters:
      namespace - Namespace of the Relation Tuple (required)
      _object - Object of the Relation Tuple (required)
      relation - Relation of the Relation Tuple (required)
      maxDepth - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 expandTree -
      400 The standard error format -
      404 The standard error format -
      500 The standard error format -

    • getRelationTuplesCall

      public okhttp3.Call getRelationTuplesCall​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, java.lang.String pageToken, java.lang.Long pageSize, ApiCallback _callback) throws ApiException
      Build call for getRelationTuples
      Parameters:
      namespace - (required)
      _object - (optional)
      relation - (optional)
      subject - (optional)
      pageToken - (optional)
      pageSize - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 getRelationTuplesResponse -
      404 The standard error format -
      500 The standard error format -

    • getRelationTuples

      public GetRelationTuplesResponse getRelationTuples​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, java.lang.String pageToken, java.lang.Long pageSize) throws ApiException
      Query relation tuples Get all relation tuples that match the query. Only the namespace field is required.
      Parameters:
      namespace - (required)
      _object - (optional)
      relation - (optional)
      subject - (optional)
      pageToken - (optional)
      pageSize - (optional)
      Returns:
      GetRelationTuplesResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 getRelationTuplesResponse -
      404 The standard error format -
      500 The standard error format -

    • getRelationTuplesWithHttpInfo

      public ApiResponse<GetRelationTuplesResponse> getRelationTuplesWithHttpInfo​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, java.lang.String pageToken, java.lang.Long pageSize) throws ApiException
      Query relation tuples Get all relation tuples that match the query. Only the namespace field is required.
      Parameters:
      namespace - (required)
      _object - (optional)
      relation - (optional)
      subject - (optional)
      pageToken - (optional)
      pageSize - (optional)
      Returns:
      ApiResponse<GetRelationTuplesResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 getRelationTuplesResponse -
      404 The standard error format -
      500 The standard error format -

    • getRelationTuplesAsync

      public okhttp3.Call getRelationTuplesAsync​(java.lang.String namespace, java.lang.String _object, java.lang.String relation, java.lang.String subject, java.lang.String pageToken, java.lang.Long pageSize, ApiCallback<GetRelationTuplesResponse> _callback) throws ApiException
      Query relation tuples (asynchronously) Get all relation tuples that match the query. Only the namespace field is required.
      Parameters:
      namespace - (required)
      _object - (optional)
      relation - (optional)
      subject - (optional)
      pageToken - (optional)
      pageSize - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 getRelationTuplesResponse -
      404 The standard error format -
      500 The standard error format -

    • postCheckCall

      public okhttp3.Call postCheckCall​(InternalRelationTuple payload, ApiCallback _callback) throws ApiException
      Build call for postCheck
      Parameters:
      payload - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 getCheckResponse -
      400 The standard error format -
      403 getCheckResponse -
      500 The standard error format -

    • postCheck

      public GetCheckResponse postCheck​(InternalRelationTuple payload) throws ApiException
      Check a relation tuple To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
      Parameters:
      payload - (optional)
      Returns:
      GetCheckResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 getCheckResponse -
      400 The standard error format -
      403 getCheckResponse -
      500 The standard error format -

    • postCheckWithHttpInfo

      public ApiResponse<GetCheckResponse> postCheckWithHttpInfo​(InternalRelationTuple payload) throws ApiException
      Check a relation tuple To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
      Parameters:
      payload - (optional)
      Returns:
      ApiResponse<GetCheckResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 getCheckResponse -
      400 The standard error format -
      403 getCheckResponse -
      500 The standard error format -

    • postCheckAsync

      public okhttp3.Call postCheckAsync​(InternalRelationTuple payload, ApiCallback<GetCheckResponse> _callback) throws ApiException
      Check a relation tuple (asynchronously) To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
      Parameters:
      payload - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 getCheckResponse -
      400 The standard error format -
      403 getCheckResponse -
      500 The standard error format -