Package com.symphony.bdk.gen.api

Class SystemApi

java.lang.Object
com.symphony.bdk.gen.api.SystemApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-26T16:14:53.869723549Z[Etc/UTC]") public class SystemApi extends Object

  • Constructor Details

    • SystemApi

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

  • Method Details

    • getApiClient

      public com.symphony.bdk.http.api.ApiClient getApiClient()
      Get the API cilent
      Returns:
      API client

    • setApiClient

      public void setApiClient(com.symphony.bdk.http.api.ApiClient apiClient)
      Set the API cilent
      Parameters:
      apiClient - an instance of API client

    • v1HealthCheckGet

      @Deprecated public V1HealthCheckResponse v1HealthCheckGet() throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      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.
      Returns:
      V1HealthCheckResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1HealthCheckGetWithHttpInfo

      @Deprecated public com.symphony.bdk.http.api.ApiResponse<V1HealthCheckResponse> v1HealthCheckGetWithHttpInfo() throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      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.
      Returns:
      ApiResponse<V1HealthCheckResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2HealthCheckGet

      @Deprecated public V2HealthCheckResponse v2HealthCheckGet(Boolean showFirehoseErrors, Boolean failOnPodConnectivity, Boolean failOnKeyManagerConnectivity, Boolean failOnAgentServiceUser, Boolean failOnCeServiceUser, Boolean failOnEncryptDecryptSuccess, Boolean failOnAny, Boolean failOnDatafeedConnectivity, String sessionToken, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      Checks the health of the Agent. [deprecated] : This endpoint is deprecated. The health check endpoint to be used instead is '/v3/health/extended'. Unlike this deprecated endpoint, the extended health check endpoint provides status on external component such as pod, key manager, ceservice, agentservice...
      Parameters:
      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)
      Returns:
      V2HealthCheckResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2HealthCheckGetWithHttpInfo

      @Deprecated public com.symphony.bdk.http.api.ApiResponse<V2HealthCheckResponse> v2HealthCheckGetWithHttpInfo(Boolean showFirehoseErrors, Boolean failOnPodConnectivity, Boolean failOnKeyManagerConnectivity, Boolean failOnAgentServiceUser, Boolean failOnCeServiceUser, Boolean failOnEncryptDecryptSuccess, Boolean failOnAny, Boolean failOnDatafeedConnectivity, String sessionToken, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      Checks the health of the Agent. [deprecated] : This endpoint is deprecated. The health check endpoint to be used instead is '/v3/health/extended'. Unlike this deprecated endpoint, the extended health check endpoint provides status on external component such as pod, key manager, ceservice, agentservice...
      Parameters:
      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)
      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