Package com.symphony.bdk.gen.api

Class ViolationsApi

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

  • Constructor Details

    • ViolationsApi

      public ViolationsApi(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

    • v1DlpViolationsMessageGet

      public V1DLPViolationMessageResponse v1DlpViolationsMessageGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on messages.
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      V1DLPViolationMessageResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1DlpViolationsMessageGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<V1DLPViolationMessageResponse> v1DlpViolationsMessageGetWithHttpInfo(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on messages.
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      ApiResponse<V1DLPViolationMessageResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1DlpViolationsSignalGet

      public V1DLPViolationSignalResponse v1DlpViolationsSignalGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on signals.
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      V1DLPViolationSignalResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1DlpViolationsSignalGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<V1DLPViolationSignalResponse> v1DlpViolationsSignalGetWithHttpInfo(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on signals.
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      ApiResponse<V1DLPViolationSignalResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1DlpViolationsStreamGet

      public V1DLPViolationStreamResponse v1DlpViolationsStreamGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on streams.
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      V1DLPViolationStreamResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1DlpViolationsStreamGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<V1DLPViolationStreamResponse> v1DlpViolationsStreamGetWithHttpInfo(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on streams.
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      ApiResponse<V1DLPViolationStreamResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3DlpViolationAttachmentGet

      public byte[] v3DlpViolationAttachmentGet(String fileId, String violationId, String sessionToken, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Get attachments that were sent as part of messages that were flagged by the DLP System. Retrieves attachments from related message violations as a base64 encoded String.
      Parameters:
      fileId - ID of attachment that will be downloaded. (required)
      violationId - ID of violation that corresponds to the flagged message that contains the attachment (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      Returns:
      byte[]
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3DlpViolationAttachmentGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<byte[]> v3DlpViolationAttachmentGetWithHttpInfo(String fileId, String violationId, String sessionToken, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Get attachments that were sent as part of messages that were flagged by the DLP System. Retrieves attachments from related message violations as a base64 encoded String.
      Parameters:
      fileId - ID of attachment that will be downloaded. (required)
      violationId - ID of violation that corresponds to the flagged message that contains the attachment (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      Returns:
      ApiResponse<byte[]>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3DlpViolationsMessageGet

      public V3DLPViolationMessageResponse v3DlpViolationsMessageGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on messages. Retrieves DLP v3 message related violations for a given time range
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      V3DLPViolationMessageResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3DlpViolationsMessageGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<V3DLPViolationMessageResponse> v3DlpViolationsMessageGetWithHttpInfo(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on messages. Retrieves DLP v3 message related violations for a given time range
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      ApiResponse<V3DLPViolationMessageResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3DlpViolationsSignalGet

      public V3DLPViolationSignalResponse v3DlpViolationsSignalGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on signals. Retrieves DLP v3 signal related violations for a given time range
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      V3DLPViolationSignalResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3DlpViolationsSignalGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<V3DLPViolationSignalResponse> v3DlpViolationsSignalGetWithHttpInfo(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on signals. Retrieves DLP v3 signal related violations for a given time range
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      ApiResponse<V3DLPViolationSignalResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3DlpViolationsStreamGet

      public V3DLPViolationStreamResponse v3DlpViolationsStreamGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on streams. Retrieves DLP v3 signal related violations for a given time range
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      V3DLPViolationStreamResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3DlpViolationsStreamGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<V3DLPViolationStreamResponse> v3DlpViolationsStreamGetWithHttpInfo(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get violations as a result of policy enforcement on streams. Retrieves DLP v3 signal related violations for a given time range
      Parameters:
      startTime - Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 (required)
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (required)
      endTime - Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request. (optional)
      next - Offset of the next chunk of violations. Value is null for the first request. (optional)
      limit - Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      ApiResponse<V3DLPViolationStreamResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call