ai.whylabs.service.api

Class LogApi

java.lang.Object

ai.whylabs.service.api.LogApi

public class LogApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
LogApi()
LogApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
LogResponse	log(java.lang.String orgId, java.lang.String modelId, java.lang.Long datasetTimestamp, java.util.List<SegmentTag> segmentTags, java.lang.String segmentTagsJson, java.io.File file) Log a dataset profile entry to the backend This method returns a [LogResponse] object if it succeeds
AsyncLogResponse	logAsync(java.lang.String orgId, java.lang.String modelId, java.lang.Long datasetTimestamp, java.util.List<SegmentTag> segmentTags, java.lang.String segmentTagsJson) Like /log, except this api doesn't take the actual profile content.
okhttp3.Call	logAsync(java.lang.String orgId, java.lang.String modelId, java.lang.Long datasetTimestamp, java.util.List<SegmentTag> segmentTags, java.lang.String segmentTagsJson, java.io.File file, ApiCallback<LogResponse> _callback) Log a dataset profile entry to the backend (asynchronously) This method returns a [LogResponse] object if it succeeds
okhttp3.Call	logAsyncAsync(java.lang.String orgId, java.lang.String modelId, java.lang.Long datasetTimestamp, java.util.List<SegmentTag> segmentTags, java.lang.String segmentTagsJson, ApiCallback<AsyncLogResponse> _callback) Like /log, except this api doesn't take the actual profile content.
okhttp3.Call	logAsyncCall(java.lang.String orgId, java.lang.String modelId, java.lang.Long datasetTimestamp, java.util.List<SegmentTag> segmentTags, java.lang.String segmentTagsJson, ApiCallback _callback) Build call for logAsync
ApiResponse<AsyncLogResponse>	logAsyncWithHttpInfo(java.lang.String orgId, java.lang.String modelId, java.lang.Long datasetTimestamp, java.util.List<SegmentTag> segmentTags, java.lang.String segmentTagsJson) Like /log, except this api doesn't take the actual profile content.
okhttp3.Call	logCall(java.lang.String orgId, java.lang.String modelId, java.lang.Long datasetTimestamp, java.util.List<SegmentTag> segmentTags, java.lang.String segmentTagsJson, java.io.File file, ApiCallback _callback) Build call for log
ApiResponse<LogResponse>	logWithHttpInfo(java.lang.String orgId, java.lang.String modelId, java.lang.Long datasetTimestamp, java.util.List<SegmentTag> segmentTags, java.lang.String segmentTagsJson, java.io.File file) Log a dataset profile entry to the backend This method returns a [LogResponse] object if it succeeds
LogResponse	removeStagedLogEntry(java.lang.String orgId, java.lang.String logEntryId) Remove a log entry from 'staging' - effectively remove it from being included in [CreateMergeJob] API calls This method returns a [LogResponse] object if it succeeds
okhttp3.Call	removeStagedLogEntryAsync(java.lang.String orgId, java.lang.String logEntryId, ApiCallback<LogResponse> _callback) Remove a log entry from 'staging' - effectively remove it from being included in [CreateMergeJob] API calls (asynchronously) This method returns a [LogResponse] object if it succeeds
okhttp3.Call	removeStagedLogEntryCall(java.lang.String orgId, java.lang.String logEntryId, ApiCallback _callback) Build call for removeStagedLogEntry
ApiResponse<LogResponse>	removeStagedLogEntryWithHttpInfo(java.lang.String orgId, java.lang.String logEntryId) Remove a log entry from 'staging' - effectively remove it from being included in [CreateMergeJob] API calls This method returns a [LogResponse] object if it succeeds
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

LogApi

public LogApi()

LogApi

public LogApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

logCall

public okhttp3.Call logCall(java.lang.String orgId,
                            java.lang.String modelId,
                            java.lang.Long datasetTimestamp,
                            java.util.List<SegmentTag> segmentTags,
                            java.lang.String segmentTagsJson,
                            java.io.File file,
                            ApiCallback _callback)
                     throws ApiException

Build call for log

Parameters:

orgId - Your company's unique organization ID (required)

modelId - The unique model ID in your company. (required)

datasetTimestamp - The dataset timestamp associated with the entry. Not required. However, this will override the whylogs dataset timestamp if specified (optional)

segmentTags - The segment associated with the log entry. Not required if segment tags are specified in whylogs (optional)

segmentTagsJson - (optional)

file - The Dataset Profile log entry (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	a LogResponse object if succeeds	-

log

public LogResponse log(java.lang.String orgId,
                       java.lang.String modelId,
                       java.lang.Long datasetTimestamp,
                       java.util.List<SegmentTag> segmentTags,
                       java.lang.String segmentTagsJson,
                       java.io.File file)
                throws ApiException

Log a dataset profile entry to the backend This method returns a [LogResponse] object if it succeeds

Parameters:

orgId - Your company's unique organization ID (required)

modelId - The unique model ID in your company. (required)

datasetTimestamp - The dataset timestamp associated with the entry. Not required. However, this will override the whylogs dataset timestamp if specified (optional)

segmentTags - The segment associated with the log entry. Not required if segment tags are specified in whylogs (optional)

segmentTagsJson - (optional)

file - The Dataset Profile log entry (optional)

Returns:

LogResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	a LogResponse object if succeeds	-

logWithHttpInfo

public ApiResponse<LogResponse> logWithHttpInfo(java.lang.String orgId,
                                                java.lang.String modelId,
                                                java.lang.Long datasetTimestamp,
                                                java.util.List<SegmentTag> segmentTags,
                                                java.lang.String segmentTagsJson,
                                                java.io.File file)
                                         throws ApiException

Log a dataset profile entry to the backend This method returns a [LogResponse] object if it succeeds

Parameters:

orgId - Your company's unique organization ID (required)

modelId - The unique model ID in your company. (required)

datasetTimestamp - The dataset timestamp associated with the entry. Not required. However, this will override the whylogs dataset timestamp if specified (optional)

segmentTags - The segment associated with the log entry. Not required if segment tags are specified in whylogs (optional)

segmentTagsJson - (optional)

file - The Dataset Profile log entry (optional)

Returns:

ApiResponse<LogResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	a LogResponse object if succeeds	-

logAsync

public okhttp3.Call logAsync(java.lang.String orgId,
                             java.lang.String modelId,
                             java.lang.Long datasetTimestamp,
                             java.util.List<SegmentTag> segmentTags,
                             java.lang.String segmentTagsJson,
                             java.io.File file,
                             ApiCallback<LogResponse> _callback)
                      throws ApiException

Log a dataset profile entry to the backend (asynchronously) This method returns a [LogResponse] object if it succeeds

Parameters:

orgId - Your company's unique organization ID (required)

modelId - The unique model ID in your company. (required)

datasetTimestamp - The dataset timestamp associated with the entry. Not required. However, this will override the whylogs dataset timestamp if specified (optional)

segmentTags - The segment associated with the log entry. Not required if segment tags are specified in whylogs (optional)

segmentTagsJson - (optional)

file - The Dataset Profile log entry (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	a LogResponse object if succeeds	-

logAsyncCall

public okhttp3.Call logAsyncCall(java.lang.String orgId,
                                 java.lang.String modelId,
                                 java.lang.Long datasetTimestamp,
                                 java.util.List<SegmentTag> segmentTags,
                                 java.lang.String segmentTagsJson,
                                 ApiCallback _callback)
                          throws ApiException

Build call for logAsync

Parameters:

orgId - Your company's unique organization ID (required)

modelId - The unique model ID in your company. (required)

datasetTimestamp - The dataset timestamp associated with the entry. (required)

segmentTags - The segment associated with the log entry. Omitting this is the same as saying the upload isn't for a segment. (optional)

segmentTagsJson - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	a LogResponse object if succeeds	-

logAsync

public AsyncLogResponse logAsync(java.lang.String orgId,
                                 java.lang.String modelId,
                                 java.lang.Long datasetTimestamp,
                                 java.util.List<SegmentTag> segmentTags,
                                 java.lang.String segmentTagsJson)
                          throws ApiException

Like /log, except this api doesn't take the actual profile content. It returns an upload link that can be used to upload the profile to. Like /log, except this api doesn't take the actual profile content. It returns an upload link that can be used to upload the profile to.

Parameters:

orgId - Your company's unique organization ID (required)

modelId - The unique model ID in your company. (required)

datasetTimestamp - The dataset timestamp associated with the entry. (required)

segmentTags - The segment associated with the log entry. Omitting this is the same as saying the upload isn't for a segment. (optional)

segmentTagsJson - (optional)

Returns:

AsyncLogResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	a LogResponse object if succeeds	-

logAsyncWithHttpInfo

public ApiResponse<AsyncLogResponse> logAsyncWithHttpInfo(java.lang.String orgId,
                                                          java.lang.String modelId,
                                                          java.lang.Long datasetTimestamp,
                                                          java.util.List<SegmentTag> segmentTags,
                                                          java.lang.String segmentTagsJson)
                                                   throws ApiException

Like /log, except this api doesn't take the actual profile content. It returns an upload link that can be used to upload the profile to. Like /log, except this api doesn't take the actual profile content. It returns an upload link that can be used to upload the profile to.

Parameters:

orgId - Your company's unique organization ID (required)

modelId - The unique model ID in your company. (required)

datasetTimestamp - The dataset timestamp associated with the entry. (required)

segmentTags - The segment associated with the log entry. Omitting this is the same as saying the upload isn't for a segment. (optional)

segmentTagsJson - (optional)

Returns:

ApiResponse<AsyncLogResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	a LogResponse object if succeeds	-

logAsyncAsync

public okhttp3.Call logAsyncAsync(java.lang.String orgId,
                                  java.lang.String modelId,
                                  java.lang.Long datasetTimestamp,
                                  java.util.List<SegmentTag> segmentTags,
                                  java.lang.String segmentTagsJson,
                                  ApiCallback<AsyncLogResponse> _callback)
                           throws ApiException

Like /log, except this api doesn't take the actual profile content. It returns an upload link that can be used to upload the profile to. (asynchronously) Like /log, except this api doesn't take the actual profile content. It returns an upload link that can be used to upload the profile to.

Parameters:

orgId - Your company's unique organization ID (required)

modelId - The unique model ID in your company. (required)

datasetTimestamp - The dataset timestamp associated with the entry. (required)

segmentTags - The segment associated with the log entry. Omitting this is the same as saying the upload isn't for a segment. (optional)

segmentTagsJson - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	a LogResponse object if succeeds	-

removeStagedLogEntryCall

public okhttp3.Call removeStagedLogEntryCall(java.lang.String orgId,
                                             java.lang.String logEntryId,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for removeStagedLogEntry

Parameters:

orgId - Your company's unique organization ID (required)

logEntryId - The unique ID for the log entry (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	A [LogResponse] object with summary information about the log entry	-

removeStagedLogEntry

public LogResponse removeStagedLogEntry(java.lang.String orgId,
                                        java.lang.String logEntryId)
                                 throws ApiException

Remove a log entry from 'staging' - effectively remove it from being included in [CreateMergeJob] API calls This method returns a [LogResponse] object if it succeeds

Parameters:

orgId - Your company's unique organization ID (required)

logEntryId - The unique ID for the log entry (required)

Returns:

LogResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A [LogResponse] object with summary information about the log entry	-

removeStagedLogEntryWithHttpInfo

public ApiResponse<LogResponse> removeStagedLogEntryWithHttpInfo(java.lang.String orgId,
                                                                 java.lang.String logEntryId)
                                                          throws ApiException

Remove a log entry from 'staging' - effectively remove it from being included in [CreateMergeJob] API calls This method returns a [LogResponse] object if it succeeds

Parameters:

orgId - Your company's unique organization ID (required)

logEntryId - The unique ID for the log entry (required)

Returns:

ApiResponse<LogResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A [LogResponse] object with summary information about the log entry	-

removeStagedLogEntryAsync

public okhttp3.Call removeStagedLogEntryAsync(java.lang.String orgId,
                                              java.lang.String logEntryId,
                                              ApiCallback<LogResponse> _callback)
                                       throws ApiException

Remove a log entry from 'staging' - effectively remove it from being included in [CreateMergeJob] API calls (asynchronously) This method returns a [LogResponse] object if it succeeds

Parameters:

orgId - Your company's unique organization ID (required)

logEntryId - The unique ID for the log entry (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	A [LogResponse] object with summary information about the log entry	-