Package io.moov.sdk

Class Ping

java.lang.Object

io.moov.sdk.Ping

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallPing

public class Ping
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallPing

Method Summary

Modifier and Type	Method	Description
PingRequestBuilder	ping()	A simple endpoint to check auth.
PingResponse	ping(java.util.Optional<java.lang.String> xMoovVersion)	A simple endpoint to check auth.
PingResponse	pingDirect()	A simple endpoint to check auth.

Methods inherited from class java.lang.Object

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

Method Detail

ping

public PingRequestBuilder ping()

A simple endpoint to check auth.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/ping.read` scope.

Returns:

The call builder

pingDirect

public PingResponse pingDirect()
                        throws java.lang.Exception

A simple endpoint to check auth.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/ping.read` scope.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

ping

public PingResponse ping(java.util.Optional<java.lang.String> xMoovVersion)
                  throws java.lang.Exception

A simple endpoint to check auth.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/ping.read` scope.

Specified by:

ping in interface SDKMethodInterfaces.MethodCallPing

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails