Package com.mypurecloud.sdk.v2.api

Class LogCaptureApi

java.lang.Object

com.mypurecloud.sdk.v2.api.LogCaptureApi

public class LogCaptureApi
extends Object

Constructor Summary

Constructors

Constructor	Description
LogCaptureApi()
LogCaptureApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteDiagnosticsLogcaptureBrowserUser(DeleteDiagnosticsLogcaptureBrowserUserRequest request)	Disable browser log capture for the user
ApiResponse<Void>	deleteDiagnosticsLogcaptureBrowserUser(ApiRequest<Void> request)	Disable browser log capture for the user
void	deleteDiagnosticsLogcaptureBrowserUser(String userId)	Disable browser log capture for the user
ApiResponse<Void>	deleteDiagnosticsLogcaptureBrowserUserWithHttpInfo(String userId)	Disable browser log capture for the user
LogCaptureDownloadExecutionResponse	getDiagnosticsLogcaptureBrowserEntriesDownloadJob(GetDiagnosticsLogcaptureBrowserEntriesDownloadJobRequest request)	Gets status of async download execution
ApiResponse<LogCaptureDownloadExecutionResponse>	getDiagnosticsLogcaptureBrowserEntriesDownloadJob(ApiRequest<Void> request)	Gets status of async download execution
LogCaptureDownloadExecutionResponse	getDiagnosticsLogcaptureBrowserEntriesDownloadJob(String jobId)	Gets status of async download execution
ApiResponse<LogCaptureDownloadExecutionResponse>	getDiagnosticsLogcaptureBrowserEntriesDownloadJobWithHttpInfo(String jobId)	Gets status of async download execution
LogCaptureUserConfigurationResponse	getDiagnosticsLogcaptureBrowserUser(GetDiagnosticsLogcaptureBrowserUserRequest request)	Get log capture configuration for the user
ApiResponse<LogCaptureUserConfigurationResponse>	getDiagnosticsLogcaptureBrowserUser(ApiRequest<Void> request)	Get log capture configuration for the user
LogCaptureUserConfigurationResponse	getDiagnosticsLogcaptureBrowserUser(String userId)	Get log capture configuration for the user
LogCaptureUserConfigurationListing	getDiagnosticsLogcaptureBrowserUsers(GetDiagnosticsLogcaptureBrowserUsersRequest request)	Get all log capture enabled users for an org
ApiResponse<LogCaptureUserConfigurationListing>	getDiagnosticsLogcaptureBrowserUsers(ApiRequest<Void> request)	Get all log capture enabled users for an org
LogCaptureUserConfigurationListing	getDiagnosticsLogcaptureBrowserUsers(Boolean includeExpired)	Get all log capture enabled users for an org
ApiResponse<LogCaptureUserConfigurationListing>	getDiagnosticsLogcaptureBrowserUsersWithHttpInfo(Boolean includeExpired)	Get all log capture enabled users for an org
ApiResponse<LogCaptureUserConfigurationResponse>	getDiagnosticsLogcaptureBrowserUserWithHttpInfo(String userId)	Get log capture configuration for the user
LogCaptureDownloadExecutionResponse	postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(PostDiagnosticsLogcaptureBrowserEntriesDownloadJobsRequest request)	Creates an async download execution
ApiResponse<LogCaptureDownloadExecutionResponse>	postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(ApiRequest<LogCaptureQueryRequest> request)	Creates an async download execution
LogCaptureDownloadExecutionResponse	postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(LogCaptureQueryRequest body)	Creates an async download execution
ApiResponse<LogCaptureDownloadExecutionResponse>	postDiagnosticsLogcaptureBrowserEntriesDownloadJobsWithHttpInfo(LogCaptureQueryRequest body)	Creates an async download execution
LogCaptureQueryResponse	postDiagnosticsLogcaptureBrowserEntriesQuery(PostDiagnosticsLogcaptureBrowserEntriesQueryRequest request)	Query collected log entries.
ApiResponse<LogCaptureQueryResponse>	postDiagnosticsLogcaptureBrowserEntriesQuery(ApiRequest<LogCaptureQueryRequest> request)	Query collected log entries.
LogCaptureQueryResponse	postDiagnosticsLogcaptureBrowserEntriesQuery(String after, String pageSize, LogCaptureQueryRequest body)	Query collected log entries.
ApiResponse<LogCaptureQueryResponse>	postDiagnosticsLogcaptureBrowserEntriesQueryWithHttpInfo(String after, String pageSize, LogCaptureQueryRequest body)	Query collected log entries.
LogCaptureUserConfiguration	postDiagnosticsLogcaptureBrowserUser(PostDiagnosticsLogcaptureBrowserUserRequest request)	Enable log capture for a user or update expiration
ApiResponse<LogCaptureUserConfiguration>	postDiagnosticsLogcaptureBrowserUser(ApiRequest<LogCaptureUserConfiguration> request)	Enable log capture for a user or update expiration
LogCaptureUserConfiguration	postDiagnosticsLogcaptureBrowserUser(String userId, LogCaptureUserConfiguration body)	Enable log capture for a user or update expiration
ApiResponse<LogCaptureUserConfiguration>	postDiagnosticsLogcaptureBrowserUserWithHttpInfo(String userId, LogCaptureUserConfiguration body)	Enable log capture for a user or update expiration

Methods inherited from class java.lang.Object

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

Constructor Details

LogCaptureApi

public LogCaptureApi()

LogCaptureApi

public LogCaptureApi(ApiClient apiClient)

Method Details

deleteDiagnosticsLogcaptureBrowserUser

public void deleteDiagnosticsLogcaptureBrowserUser(String userId)
                                            throws IOException,
ApiException

Disable browser log capture for the user

Parameters:

userId - The id of the user to disable browser log capture (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteDiagnosticsLogcaptureBrowserUserWithHttpInfo

public ApiResponse<Void> deleteDiagnosticsLogcaptureBrowserUserWithHttpInfo(String userId)
                                                                     throws IOException

Disable browser log capture for the user

Parameters:

userId - The id of the user to disable browser log capture (required)

Throws:

IOException - if the request fails to be processed

deleteDiagnosticsLogcaptureBrowserUser

public void deleteDiagnosticsLogcaptureBrowserUser(DeleteDiagnosticsLogcaptureBrowserUserRequest request)
                                            throws IOException,
ApiException

Disable browser log capture for the user

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteDiagnosticsLogcaptureBrowserUser

public ApiResponse<Void> deleteDiagnosticsLogcaptureBrowserUser(ApiRequest<Void> request)
                                                         throws IOException

Disable browser log capture for the user

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserEntriesDownloadJob

public LogCaptureDownloadExecutionResponse getDiagnosticsLogcaptureBrowserEntriesDownloadJob(String jobId)
                                                                                      throws IOException,
ApiException

Gets status of async download execution

Parameters:

jobId - Job ID (required)

Returns:

LogCaptureDownloadExecutionResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserEntriesDownloadJobWithHttpInfo

public ApiResponse<LogCaptureDownloadExecutionResponse> getDiagnosticsLogcaptureBrowserEntriesDownloadJobWithHttpInfo(String jobId)
                                                                                                               throws IOException

Gets status of async download execution

Parameters:

jobId - Job ID (required)

Returns:

LogCaptureDownloadExecutionResponse

Throws:

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserEntriesDownloadJob

public LogCaptureDownloadExecutionResponse getDiagnosticsLogcaptureBrowserEntriesDownloadJob(GetDiagnosticsLogcaptureBrowserEntriesDownloadJobRequest request)
                                                                                      throws IOException,
ApiException

Gets status of async download execution

Parameters:

request - The request object

Returns:

LogCaptureDownloadExecutionResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserEntriesDownloadJob

public ApiResponse<LogCaptureDownloadExecutionResponse> getDiagnosticsLogcaptureBrowserEntriesDownloadJob(ApiRequest<Void> request)
                                                                                                   throws IOException

Gets status of async download execution

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserUser

public LogCaptureUserConfigurationResponse getDiagnosticsLogcaptureBrowserUser(String userId)
                                                                        throws IOException,
ApiException

Get log capture configuration for the user

Parameters:

userId - The id of the user to get browser log capture configuration (required)

Returns:

LogCaptureUserConfigurationResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserUserWithHttpInfo

public ApiResponse<LogCaptureUserConfigurationResponse> getDiagnosticsLogcaptureBrowserUserWithHttpInfo(String userId)
                                                                                                 throws IOException

Get log capture configuration for the user

Parameters:

userId - The id of the user to get browser log capture configuration (required)

Returns:

LogCaptureUserConfigurationResponse

Throws:

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserUser

public LogCaptureUserConfigurationResponse getDiagnosticsLogcaptureBrowserUser(GetDiagnosticsLogcaptureBrowserUserRequest request)
                                                                        throws IOException,
ApiException

Get log capture configuration for the user

Parameters:

request - The request object

Returns:

LogCaptureUserConfigurationResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserUser

public ApiResponse<LogCaptureUserConfigurationResponse> getDiagnosticsLogcaptureBrowserUser(ApiRequest<Void> request)
                                                                                     throws IOException

Get log capture configuration for the user

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserUsers

public LogCaptureUserConfigurationListing getDiagnosticsLogcaptureBrowserUsers(Boolean includeExpired)
                                                                        throws IOException,
ApiException

Get all log capture enabled users for an org

Parameters:

includeExpired - Include expired users with log captures still available for search or download (optional, default to false)

Returns:

LogCaptureUserConfigurationListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserUsersWithHttpInfo

public ApiResponse<LogCaptureUserConfigurationListing> getDiagnosticsLogcaptureBrowserUsersWithHttpInfo(Boolean includeExpired)
                                                                                                 throws IOException

Get all log capture enabled users for an org

Parameters:

includeExpired - Include expired users with log captures still available for search or download (optional, default to false)

Returns:

LogCaptureUserConfigurationListing

Throws:

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserUsers

public LogCaptureUserConfigurationListing getDiagnosticsLogcaptureBrowserUsers(GetDiagnosticsLogcaptureBrowserUsersRequest request)
                                                                        throws IOException,
ApiException

Get all log capture enabled users for an org

Parameters:

request - The request object

Returns:

LogCaptureUserConfigurationListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDiagnosticsLogcaptureBrowserUsers

public ApiResponse<LogCaptureUserConfigurationListing> getDiagnosticsLogcaptureBrowserUsers(ApiRequest<Void> request)
                                                                                     throws IOException

Get all log capture enabled users for an org

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserEntriesDownloadJobs

public LogCaptureDownloadExecutionResponse postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(LogCaptureQueryRequest body)
                                                                                        throws IOException,
ApiException

Creates an async download execution

Parameters:

body - (optional)

Returns:

LogCaptureDownloadExecutionResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserEntriesDownloadJobsWithHttpInfo

public ApiResponse<LogCaptureDownloadExecutionResponse> postDiagnosticsLogcaptureBrowserEntriesDownloadJobsWithHttpInfo(LogCaptureQueryRequest body)
                                                                                                                 throws IOException

Creates an async download execution

Parameters:

body - (optional)

Returns:

LogCaptureDownloadExecutionResponse

Throws:

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserEntriesDownloadJobs

public LogCaptureDownloadExecutionResponse postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(PostDiagnosticsLogcaptureBrowserEntriesDownloadJobsRequest request)
                                                                                        throws IOException,
ApiException

Creates an async download execution

Parameters:

request - The request object

Returns:

LogCaptureDownloadExecutionResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserEntriesDownloadJobs

public ApiResponse<LogCaptureDownloadExecutionResponse> postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(ApiRequest<LogCaptureQueryRequest> request)
                                                                                                     throws IOException

Creates an async download execution

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserEntriesQuery

public LogCaptureQueryResponse postDiagnosticsLogcaptureBrowserEntriesQuery(String after,
 String pageSize,
 LogCaptureQueryRequest body)
                                                                     throws IOException,
ApiException

Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.

Parameters:

after - The cursor that points to the end of the set of entities that has been returned. (optional)

pageSize - Number of entities to return. Maximum of 200. (optional)

body - (optional)

Returns:

LogCaptureQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserEntriesQueryWithHttpInfo

public ApiResponse<LogCaptureQueryResponse> postDiagnosticsLogcaptureBrowserEntriesQueryWithHttpInfo(String after,
 String pageSize,
 LogCaptureQueryRequest body)
                                                                                              throws IOException

Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.

Parameters:

after - The cursor that points to the end of the set of entities that has been returned. (optional)

pageSize - Number of entities to return. Maximum of 200. (optional)

body - (optional)

Returns:

LogCaptureQueryResponse

Throws:

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserEntriesQuery

public LogCaptureQueryResponse postDiagnosticsLogcaptureBrowserEntriesQuery(PostDiagnosticsLogcaptureBrowserEntriesQueryRequest request)
                                                                     throws IOException,
ApiException

Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.

Parameters:

request - The request object

Returns:

LogCaptureQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserEntriesQuery

public ApiResponse<LogCaptureQueryResponse> postDiagnosticsLogcaptureBrowserEntriesQuery(ApiRequest<LogCaptureQueryRequest> request)
                                                                                  throws IOException

Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserUser

public LogCaptureUserConfiguration postDiagnosticsLogcaptureBrowserUser(String userId,
 LogCaptureUserConfiguration body)
                                                                 throws IOException,
ApiException

Enable log capture for a user or update expiration

Parameters:

userId - The id of the user to enable browser log capture (required)

body - (optional)

Returns:

LogCaptureUserConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserUserWithHttpInfo

public ApiResponse<LogCaptureUserConfiguration> postDiagnosticsLogcaptureBrowserUserWithHttpInfo(String userId,
 LogCaptureUserConfiguration body)
                                                                                          throws IOException

Enable log capture for a user or update expiration

Parameters:

userId - The id of the user to enable browser log capture (required)

body - (optional)

Returns:

LogCaptureUserConfiguration

Throws:

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserUser

public LogCaptureUserConfiguration postDiagnosticsLogcaptureBrowserUser(PostDiagnosticsLogcaptureBrowserUserRequest request)
                                                                 throws IOException,
ApiException

Enable log capture for a user or update expiration

Parameters:

request - The request object

Returns:

LogCaptureUserConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postDiagnosticsLogcaptureBrowserUser

public ApiResponse<LogCaptureUserConfiguration> postDiagnosticsLogcaptureBrowserUser(ApiRequest<LogCaptureUserConfiguration> request)
                                                                              throws IOException

Enable log capture for a user or update expiration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed