Package com.datadog.api.client.v1.api

Class LogsApi

java.lang.Object

com.datadog.api.client.v1.api.LogsApi

@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class LogsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LogsApi.SubmitLogOptionalParameters	Manage optional parameters to submitLog.

Constructor Summary

Constructors

Constructor	Description
LogsApi()
LogsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	Get the API client.
LogsListResponse	listLogs(LogsListRequest body)	Search logs.
CompletableFuture<LogsListResponse>	listLogsAsync(LogsListRequest body)	Search logs.
ApiResponse<LogsListResponse>	listLogsWithHttpInfo(LogsListRequest body)	List endpoint returns logs that match a log search query.
CompletableFuture<ApiResponse<LogsListResponse>>	listLogsWithHttpInfoAsync(LogsListRequest body)	Search logs.
void	setApiClient(ApiClient apiClient)	Set the API client.
Object	submitLog(List<HTTPLogItem> body)	Deprecated.
Object	submitLog(List<HTTPLogItem> body, LogsApi.SubmitLogOptionalParameters parameters)	Deprecated.
CompletableFuture<Object>	submitLogAsync(List<HTTPLogItem> body)	Deprecated.
CompletableFuture<Object>	submitLogAsync(List<HTTPLogItem> body, LogsApi.SubmitLogOptionalParameters parameters)	Deprecated.
ApiResponse<Object>	submitLogWithHttpInfo(List<HTTPLogItem> body, LogsApi.SubmitLogOptionalParameters parameters)	Deprecated.
CompletableFuture<ApiResponse<Object>>	submitLogWithHttpInfoAsync(List<HTTPLogItem> body, LogsApi.SubmitLogOptionalParameters parameters)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

LogsApi

public LogsApi()

LogsApi

public LogsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

listLogs

public LogsListResponse listLogs(LogsListRequest body)
                          throws ApiException

Search logs.

See listLogsWithHttpInfo(com.datadog.api.client.v1.model.LogsListRequest).

Parameters:

body - Logs filter (required)

Returns:

LogsListResponse

Throws:

ApiException - if fails to make API call

listLogsAsync

public CompletableFuture<LogsListResponse> listLogsAsync(LogsListRequest body)

Search logs.

See listLogsWithHttpInfoAsync(com.datadog.api.client.v1.model.LogsListRequest).

Parameters:

body - Logs filter (required)

Returns:

CompletableFuture<LogsListResponse>

listLogsWithHttpInfo

public ApiResponse<LogsListResponse> listLogsWithHttpInfo(LogsListRequest body)
                                                   throws ApiException

List endpoint returns logs that match a log search query. Results are paginated.

If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation.

Note: This endpoint is enabled by default for logs customers. To disable it, contact Datadog support.

Parameters:

body - Logs filter (required)

Returns:

ApiResponse<LogsListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication error	-
429	Too many requests	-

listLogsWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsListResponse>> listLogsWithHttpInfoAsync(LogsListRequest body)

Search logs.

See listLogsWithHttpInfo(com.datadog.api.client.v1.model.LogsListRequest).

Parameters:

body - Logs filter (required)

Returns:

CompletableFuture<ApiResponse<LogsListResponse>>

submitLog

@Deprecated
public Object submitLog(List<HTTPLogItem> body)
                 throws ApiException

Deprecated.

Send logs.

See submitLogWithHttpInfo(java.util.List<com.datadog.api.client.v1.model.HTTPLogItem>, com.datadog.api.client.v1.api.LogsApi.SubmitLogOptionalParameters).

Parameters:

body - Log to send (JSON format). (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

submitLogAsync

@Deprecated
public CompletableFuture<Object> submitLogAsync(List<HTTPLogItem> body)

Deprecated.

Send logs.

See submitLogWithHttpInfoAsync(java.util.List<com.datadog.api.client.v1.model.HTTPLogItem>, com.datadog.api.client.v1.api.LogsApi.SubmitLogOptionalParameters).

Parameters:

body - Log to send (JSON format). (required)

Returns:

CompletableFuture<Object>

submitLog

@Deprecated
public Object submitLog(List<HTTPLogItem> body,
 LogsApi.SubmitLogOptionalParameters parameters)
                 throws ApiException

Deprecated.

Send logs.

See submitLogWithHttpInfo(java.util.List<com.datadog.api.client.v1.model.HTTPLogItem>, com.datadog.api.client.v1.api.LogsApi.SubmitLogOptionalParameters).

Parameters:

body - Log to send (JSON format). (required)

parameters - Optional parameters for the request.

Returns:

Object

Throws:

ApiException - if fails to make API call

submitLogAsync

@Deprecated
public CompletableFuture<Object> submitLogAsync(List<HTTPLogItem> body,
 LogsApi.SubmitLogOptionalParameters parameters)

Deprecated.

Send logs.

See submitLogWithHttpInfoAsync(java.util.List<com.datadog.api.client.v1.model.HTTPLogItem>, com.datadog.api.client.v1.api.LogsApi.SubmitLogOptionalParameters).

Parameters:

body - Log to send (JSON format). (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<Object>

submitLogWithHttpInfo

@Deprecated
public ApiResponse<Object> submitLogWithHttpInfo(List<HTTPLogItem> body,
 LogsApi.SubmitLogOptionalParameters parameters)
                                          throws ApiException

Deprecated.

Send your logs to your Datadog platform over HTTP. Limits per HTTP request are:

• Maximum content size per payload (uncompressed): 5MB
• Maximum size for a single log: 1MB
• Maximum array size if sending multiple logs in an array: 1000 entries

Any log exceeding 1MB is accepted and truncated by Datadog: - For a single log request, the API truncates the log at 1MB and returns a 2xx. - For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx.

Datadog recommends sending your logs compressed. Add the Content-Encoding: gzip header to the request when sending compressed logs.

The status codes answered by the HTTP API are: - 200: OK - 400: Bad request (likely an issue in the payload formatting) - 403: Permission issue (likely using an invalid API Key) - 413: Payload too large (batch is above 5MB uncompressed) - 5xx: Internal error, request should be retried after some time

Parameters:

body - Log to send (JSON format). (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<Object>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	Response from server (always 200 empty JSON).	-
400	unexpected error	-
429	Too many requests	-

submitLogWithHttpInfoAsync

@Deprecated
public CompletableFuture<ApiResponse<Object>> submitLogWithHttpInfoAsync(List<HTTPLogItem> body,
 LogsApi.SubmitLogOptionalParameters parameters)

Deprecated.

Send logs.

See submitLogWithHttpInfo(java.util.List<com.datadog.api.client.v1.model.HTTPLogItem>, com.datadog.api.client.v1.api.LogsApi.SubmitLogOptionalParameters).

Parameters:

body - Log to send (JSON format). (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<Object>>