com.symphony.bdk.gen.api

Class SystemApi

java.lang.Object

com.symphony.bdk.gen.api.SystemApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-02-19T08:46:05.492+01:00[Europe/Paris]")
public class SystemApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SystemApi(com.symphony.bdk.http.api.ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
com.symphony.bdk.http.api.ApiClient	getApiClient() Get the API cilent
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) Checks the health of the Agent.
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) Checks the health of the Agent.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemApi

public SystemApi(com.symphony.bdk.http.api.ApiClient apiClient)

Method Detail

getApiClient

public com.symphony.bdk.http.api.ApiClient getApiClient()

Get the API cilent

Returns:

API client

v2HealthCheckGet

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

Checks the health of the Agent. Used to validate the configuration of the agent. Makes a request to the HealthCheck on the Symphony cloud. Makes a request to the HealthCheck on the Key Manager service. Encryts and decrypts a message inside either agent or user SbeSession with wall thread id.

Parameters:

showFirehoseErrors - Flag to set if Firehose Service connectivity errors will show on Agent's healthcheck or not. Default is \"false\", so no errors will show up if connectivity check isn't successful. (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 - Defines the HealthCheck status code response whenever the Content Export Service User connectivity fails. When set to \"true\", in case of Content Export Service User connectivity failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (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)

Returns:

V2HealthCheckResponse

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v2HealthCheckGetWithHttpInfo

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

Checks the health of the Agent. Used to validate the configuration of the agent. Makes a request to the HealthCheck on the Symphony cloud. Makes a request to the HealthCheck on the Key Manager service. Encryts and decrypts a message inside either agent or user SbeSession with wall thread id.

Parameters:

showFirehoseErrors - Flag to set if Firehose Service connectivity errors will show on Agent's healthcheck or not. Default is \"false\", so no errors will show up if connectivity check isn't successful. (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 - Defines the HealthCheck status code response whenever the Content Export Service User connectivity fails. When set to \"true\", in case of Content Export Service User connectivity failure, the response status code will be 503; otherwise, it will be 200. Default value is \"false\". (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)

Returns:

ApiResponse<V2HealthCheckResponse>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v3ExtendedHealth

public V3Health v3ExtendedHealth()
                          throws com.symphony.bdk.http.api.ApiException

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**). The global status will be set to `DOWN` if at least one of the sub-status is also `DOWN`.

Returns:

V3Health

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v3ExtendedHealthWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V3Health> v3ExtendedHealthWithHttpInfo()
                                                                             throws com.symphony.bdk.http.api.ApiException

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**). The global status will be set to `DOWN` if at least one of the sub-status is also `DOWN`.

Returns:

ApiResponse<V3Health>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v3Health

public V3Health v3Health()
                  throws com.symphony.bdk.http.api.ApiException

Checks health status _Available on Agent 2.57.0 and above._ Returns the connectivity status of your Agent server. If your Agent server is started and running, the status value will be `UP`

Returns:

V3Health

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v3HealthWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<V3Health> v3HealthWithHttpInfo()
                                                                     throws com.symphony.bdk.http.api.ApiException

Checks health status _Available on Agent 2.57.0 and above._ Returns the connectivity status of your Agent server. If your Agent server is started and running, the status value will be `UP`

Returns:

ApiResponse<V3Health>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call