Package sh.ory.api

Class MetadataApi

java.lang.Object
sh.ory.api.MetadataApi
public class MetadataApi
extends Object

  • Constructor Details

    • MetadataApi

      public MetadataApi()

    • MetadataApi

      public MetadataApi​(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient​(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex​(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl​(String customBaseUrl)

    • getVersionCall

      public okhttp3.Call getVersionCall​(ApiCallback _callback) throws ApiException
      Build call for getVersion
      Parameters:
      _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 Returns the Ory Kratos version. -

    • getVersion

      public InlineResponse2001 getVersion() throws ApiException
      Return Running Software Version. This endpoint returns the version of Ory Kratos. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a single instance.
      Returns:
      InlineResponse2001
      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 Returns the Ory Kratos version. -

    • getVersionWithHttpInfo

      public ApiResponse<InlineResponse2001> getVersionWithHttpInfo() throws ApiException
      Return Running Software Version. This endpoint returns the version of Ory Kratos. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a single instance.
      Returns:
      ApiResponse<InlineResponse2001>
      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 Returns the Ory Kratos version. -

    • getVersionAsync

      public okhttp3.Call getVersionAsync​(ApiCallback<InlineResponse2001> _callback) throws ApiException
      Return Running Software Version. (asynchronously) This endpoint returns the version of Ory Kratos. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a single instance.
      Parameters:
      _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 Returns the Ory Kratos version. -

    • isAliveCall

      public okhttp3.Call isAliveCall​(ApiCallback _callback) throws ApiException
      Build call for isAlive
      Parameters:
      _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 Ory Kratos is ready to accept connections. -
      500 genericError -

    • isAlive

      public InlineResponse200 isAlive() throws ApiException
      Check HTTP Server Status This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
      Returns:
      InlineResponse200
      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 Ory Kratos is ready to accept connections. -
      500 genericError -

    • isAliveWithHttpInfo

      public ApiResponse<InlineResponse200> isAliveWithHttpInfo() throws ApiException
      Check HTTP Server Status This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
      Returns:
      ApiResponse<InlineResponse200>
      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 Ory Kratos is ready to accept connections. -
      500 genericError -

    • isAliveAsync

      public okhttp3.Call isAliveAsync​(ApiCallback<InlineResponse200> _callback) throws ApiException
      Check HTTP Server Status (asynchronously) This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
      Parameters:
      _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 Ory Kratos is ready to accept connections. -
      500 genericError -

    • isReadyCall

      public okhttp3.Call isReadyCall​(ApiCallback _callback) throws ApiException
      Build call for isReady
      Parameters:
      _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 Ory Kratos is ready to accept requests. -
      503 Ory Kratos is not yet ready to accept requests. -

    • isReady

      public InlineResponse200 isReady() throws ApiException
      Check HTTP Server and Database Status This endpoint returns a HTTP 200 status code when Ory Kratos is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of Ory Kratos, the health status will never refer to the cluster state, only to a single instance.
      Returns:
      InlineResponse200
      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 Ory Kratos is ready to accept requests. -
      503 Ory Kratos is not yet ready to accept requests. -

    • isReadyWithHttpInfo

      public ApiResponse<InlineResponse200> isReadyWithHttpInfo() throws ApiException
      Check HTTP Server and Database Status This endpoint returns a HTTP 200 status code when Ory Kratos is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of Ory Kratos, the health status will never refer to the cluster state, only to a single instance.
      Returns:
      ApiResponse<InlineResponse200>
      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 Ory Kratos is ready to accept requests. -
      503 Ory Kratos is not yet ready to accept requests. -

    • isReadyAsync

      public okhttp3.Call isReadyAsync​(ApiCallback<InlineResponse200> _callback) throws ApiException
      Check HTTP Server and Database Status (asynchronously) This endpoint returns a HTTP 200 status code when Ory Kratos is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of Ory Kratos, the health status will never refer to the cluster state, only to a single instance.
      Parameters:
      _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 Ory Kratos is ready to accept requests. -
      503 Ory Kratos is not yet ready to accept requests. -