@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2023-04-04T11:45:02.644Z[Etc/UTC]")
public class SystemApi
extends java.lang.Object
Constructor and Description |
---|
SystemApi(com.symphony.bdk.http.api.ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
com.symphony.bdk.http.api.ApiClient |
getApiClient()
Get the API cilent
|
void |
setApiClient(com.symphony.bdk.http.api.ApiClient apiClient)
Set the API cilent
|
V1HealthCheckResponse |
v1HealthCheckGet()
Deprecated.
|
com.symphony.bdk.http.api.ApiResponse<V1HealthCheckResponse> |
v1HealthCheckGetWithHttpInfo()
Deprecated.
|
V2HealthCheckResponse |
v2HealthCheckGet(java.lang.Boolean showFirehoseErrors,
java.lang.Boolean failOnPodConnectivity,
java.lang.Boolean failOnKeyManagerConnectivity,
java.lang.Boolean failOnAgentServiceUser,
java.lang.Boolean failOnCeServiceUser,
java.lang.Boolean failOnEncryptDecryptSuccess,
java.lang.Boolean failOnAny,
java.lang.Boolean failOnDatafeedConnectivity,
java.lang.String sessionToken,
java.lang.String keyManagerToken)
Deprecated.
|
com.symphony.bdk.http.api.ApiResponse<V2HealthCheckResponse> |
v2HealthCheckGetWithHttpInfo(java.lang.Boolean showFirehoseErrors,
java.lang.Boolean failOnPodConnectivity,
java.lang.Boolean failOnKeyManagerConnectivity,
java.lang.Boolean failOnAgentServiceUser,
java.lang.Boolean failOnCeServiceUser,
java.lang.Boolean failOnEncryptDecryptSuccess,
java.lang.Boolean failOnAny,
java.lang.Boolean failOnDatafeedConnectivity,
java.lang.String sessionToken,
java.lang.String keyManagerToken)
Deprecated.
|
V3Health |
v3ExtendedHealth()
Checks health status of services and users
_Available on Agent 2.57.0 and above._ Returns the connectivity status of the Agent services (**pod**, **key manager** and **datafeed**) as well as users connectivity (**agentservice** and **ceservice**).
|
com.symphony.bdk.http.api.ApiResponse<V3Health> |
v3ExtendedHealthWithHttpInfo()
Checks health status of services and users
_Available on Agent 2.57.0 and above._ Returns the connectivity status of the Agent services (**pod**, **key manager** and **datafeed**) as well as users connectivity (**agentservice** and **ceservice**).
|
V3Health |
v3Health()
Checks health status
_Available on Agent 2.57.0 and above._ Returns the connectivity status of your Agent server.
|
com.symphony.bdk.http.api.ApiResponse<V3Health> |
v3HealthWithHttpInfo()
Checks health status
_Available on Agent 2.57.0 and above._ Returns the connectivity status of your Agent server.
|
public com.symphony.bdk.http.api.ApiClient getApiClient()
public void setApiClient(com.symphony.bdk.http.api.ApiClient apiClient)
apiClient
- an instance of API client@Deprecated public V1HealthCheckResponse v1HealthCheckGet() throws com.symphony.bdk.http.api.ApiException
com.symphony.bdk.http.api.ApiException
- if fails to make API call@Deprecated public com.symphony.bdk.http.api.ApiResponse<V1HealthCheckResponse> v1HealthCheckGetWithHttpInfo() throws com.symphony.bdk.http.api.ApiException
com.symphony.bdk.http.api.ApiException
- if fails to make API call@Deprecated public V2HealthCheckResponse v2HealthCheckGet(java.lang.Boolean showFirehoseErrors, java.lang.Boolean failOnPodConnectivity, java.lang.Boolean failOnKeyManagerConnectivity, java.lang.Boolean failOnAgentServiceUser, java.lang.Boolean failOnCeServiceUser, java.lang.Boolean failOnEncryptDecryptSuccess, java.lang.Boolean failOnAny, java.lang.Boolean failOnDatafeedConnectivity, java.lang.String sessionToken, java.lang.String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
showFirehoseErrors
- [deprecated] Firehose Service has never been deployed. However, this request parameter has been kept here for specs backward compatibility. (optional)failOnPodConnectivity
- Defines the HealthCheck status code response whenever the Pod connectivity fails. When set to \"true\", in case of Pod connectivity failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)failOnKeyManagerConnectivity
- Defines the HealthCheck status code response whenever the Key Manager connectivity fails. When set to \"true\", in case of Key Manager connectivity failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)failOnAgentServiceUser
- Defines the HealthCheck status code response whenever the Agent Service User connectivity fails. When set to \"true\", in case of Agent Service connectivity failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)failOnCeServiceUser
- This query parameter is not used as the ceservice is deprecated and it is kept for backward compatibility. Default value is \"false\" but it will not change the response status code if set to true. (optional)failOnEncryptDecryptSuccess
- Defines the status code response whenever the Encrypt/Decrypt message check fails. When set to \"true\", in case of Encrypt or Decrypt failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)failOnAny
- Defines the status code response whenever at least one of the checks fails. When set to \"true\", in case of any failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)failOnDatafeedConnectivity
- Defines the HealthCheck status code response whenever the Datafeed2 connectivity fails. When set to \"true\", in case of Datafeed connectivity failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)sessionToken
- Session authentication token. (optional)keyManagerToken
- Key Manager authentication token. (optional)com.symphony.bdk.http.api.ApiException
- if fails to make API call@Deprecated public com.symphony.bdk.http.api.ApiResponse<V2HealthCheckResponse> v2HealthCheckGetWithHttpInfo(java.lang.Boolean showFirehoseErrors, java.lang.Boolean failOnPodConnectivity, java.lang.Boolean failOnKeyManagerConnectivity, java.lang.Boolean failOnAgentServiceUser, java.lang.Boolean failOnCeServiceUser, java.lang.Boolean failOnEncryptDecryptSuccess, java.lang.Boolean failOnAny, java.lang.Boolean failOnDatafeedConnectivity, java.lang.String sessionToken, java.lang.String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
showFirehoseErrors
- [deprecated] Firehose Service has never been deployed. However, this request parameter has been kept here for specs backward compatibility. (optional)failOnPodConnectivity
- Defines the HealthCheck status code response whenever the Pod connectivity fails. When set to \"true\", in case of Pod connectivity failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)failOnKeyManagerConnectivity
- Defines the HealthCheck status code response whenever the Key Manager connectivity fails. When set to \"true\", in case of Key Manager connectivity failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)failOnAgentServiceUser
- Defines the HealthCheck status code response whenever the Agent Service User connectivity fails. When set to \"true\", in case of Agent Service connectivity failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)failOnCeServiceUser
- This query parameter is not used as the ceservice is deprecated and it is kept for backward compatibility. Default value is \"false\" but it will not change the response status code if set to true. (optional)failOnEncryptDecryptSuccess
- Defines the status code response whenever the Encrypt/Decrypt message check fails. When set to \"true\", in case of Encrypt or Decrypt failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)failOnAny
- Defines the status code response whenever at least one of the checks fails. When set to \"true\", in case of any failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)failOnDatafeedConnectivity
- Defines the HealthCheck status code response whenever the Datafeed2 connectivity fails. When set to \"true\", in case of Datafeed connectivity failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (optional)sessionToken
- Session authentication token. (optional)keyManagerToken
- Key Manager authentication token. (optional)com.symphony.bdk.http.api.ApiException
- if fails to make API callpublic V3Health v3ExtendedHealth() throws com.symphony.bdk.http.api.ApiException
com.symphony.bdk.http.api.ApiException
- if fails to make API callpublic com.symphony.bdk.http.api.ApiResponse<V3Health> v3ExtendedHealthWithHttpInfo() throws com.symphony.bdk.http.api.ApiException
com.symphony.bdk.http.api.ApiException
- if fails to make API callpublic V3Health v3Health() throws com.symphony.bdk.http.api.ApiException
com.symphony.bdk.http.api.ApiException
- if fails to make API callpublic com.symphony.bdk.http.api.ApiResponse<V3Health> v3HealthWithHttpInfo() throws com.symphony.bdk.http.api.ApiException
com.symphony.bdk.http.api.ApiException
- if fails to make API call