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

Class EventsApi

java.lang.Object

com.datadog.api.client.v1.api.EventsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventsApi.ListEventsOptionalParameters	Manage optional parameters to listEvents.

Constructor Summary

Constructors

Constructor	Description
EventsApi()
EventsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
EventCreateResponse	createEvent(EventCreateRequest body)	Post an event.
CompletableFuture<EventCreateResponse>	createEventAsync(EventCreateRequest body)	Post an event.
ApiResponse<EventCreateResponse>	createEventWithHttpInfo(EventCreateRequest body)	This endpoint allows you to post events to the stream.
CompletableFuture<ApiResponse<EventCreateResponse>>	createEventWithHttpInfoAsync(EventCreateRequest body)	Post an event.
ApiClient	getApiClient()	Get the API client.
EventResponse	getEvent(Long eventId)	Get an event.
CompletableFuture<EventResponse>	getEventAsync(Long eventId)	Get an event.
ApiResponse<EventResponse>	getEventWithHttpInfo(Long eventId)	This endpoint allows you to query for event details.
CompletableFuture<ApiResponse<EventResponse>>	getEventWithHttpInfoAsync(Long eventId)	Get an event.
EventListResponse	listEvents(Long start, Long end)	Get a list of events.
EventListResponse	listEvents(Long start, Long end, EventsApi.ListEventsOptionalParameters parameters)	Get a list of events.
CompletableFuture<EventListResponse>	listEventsAsync(Long start, Long end)	Get a list of events.
CompletableFuture<EventListResponse>	listEventsAsync(Long start, Long end, EventsApi.ListEventsOptionalParameters parameters)	Get a list of events.
ApiResponse<EventListResponse>	listEventsWithHttpInfo(Long start, Long end, EventsApi.ListEventsOptionalParameters parameters)	The event stream can be queried and filtered by time, priority, sources and tags.
CompletableFuture<ApiResponse<EventListResponse>>	listEventsWithHttpInfoAsync(Long start, Long end, EventsApi.ListEventsOptionalParameters parameters)	Get a list of events.
void	setApiClient(ApiClient apiClient)	Set the API client.

Methods inherited from class java.lang.Object

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

Constructor Details

EventsApi

public EventsApi()

EventsApi

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

createEvent

public EventCreateResponse createEvent(EventCreateRequest body)
                                throws ApiException

Post an event.

See createEventWithHttpInfo(com.datadog.api.client.v1.model.EventCreateRequest).

Parameters:

body - Event request object (required)

Returns:

EventCreateResponse

Throws:

ApiException - if fails to make API call

createEventAsync

public CompletableFuture<EventCreateResponse> createEventAsync(EventCreateRequest body)

Post an event.

See createEventWithHttpInfoAsync(com.datadog.api.client.v1.model.EventCreateRequest).

Parameters:

body - Event request object (required)

Returns:

CompletableFuture<EventCreateResponse>

createEventWithHttpInfo

public ApiResponse<EventCreateResponse> createEventWithHttpInfo(EventCreateRequest body)
                                                         throws ApiException

This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events.

Parameters:

body - Event request object (required)

Returns:

ApiResponse<EventCreateResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	OK	-
400	Bad Request	-
429	Too many requests	-

createEventWithHttpInfoAsync

public CompletableFuture<ApiResponse<EventCreateResponse>> createEventWithHttpInfoAsync(EventCreateRequest body)

Post an event.

See createEventWithHttpInfo(com.datadog.api.client.v1.model.EventCreateRequest).

Parameters:

body - Event request object (required)

Returns:

CompletableFuture<ApiResponse<EventCreateResponse>>

getEvent

public EventResponse getEvent(Long eventId)
                       throws ApiException

Get an event.

See getEventWithHttpInfo(java.lang.Long).

Parameters:

eventId - The ID of the event. (required)

Returns:

EventResponse

Throws:

ApiException - if fails to make API call

getEventAsync

public CompletableFuture<EventResponse> getEventAsync(Long eventId)

Get an event.

See getEventWithHttpInfoAsync(java.lang.Long).

Parameters:

eventId - The ID of the event. (required)

Returns:

CompletableFuture<EventResponse>

getEventWithHttpInfo

public ApiResponse<EventResponse> getEventWithHttpInfo(Long eventId)
                                                throws ApiException

This endpoint allows you to query for event details.

Note: If the event you’re querying contains markdown formatting of any kind, you may see characters such as %,\,n in your output.

Parameters:

eventId - The ID of the event. (required)

Returns:

ApiResponse<EventResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Authentication Error	-
404	Item Not Found	-
429	Too many requests	-

getEventWithHttpInfoAsync

public CompletableFuture<ApiResponse<EventResponse>> getEventWithHttpInfoAsync(Long eventId)

Get an event.

See getEventWithHttpInfo(java.lang.Long).

Parameters:

eventId - The ID of the event. (required)

Returns:

CompletableFuture<ApiResponse<EventResponse>>

listEvents

public EventListResponse listEvents(Long start,
 Long end)
                             throws ApiException

Get a list of events.

See listEventsWithHttpInfo(java.lang.Long, java.lang.Long, com.datadog.api.client.v1.api.EventsApi.ListEventsOptionalParameters).

Parameters:

start - POSIX timestamp. (required)

end - POSIX timestamp. (required)

Returns:

EventListResponse

Throws:

ApiException - if fails to make API call

listEventsAsync

public CompletableFuture<EventListResponse> listEventsAsync(Long start,
 Long end)

Get a list of events.

See listEventsWithHttpInfoAsync(java.lang.Long, java.lang.Long, com.datadog.api.client.v1.api.EventsApi.ListEventsOptionalParameters).

Parameters:

start - POSIX timestamp. (required)

end - POSIX timestamp. (required)

Returns:

CompletableFuture<EventListResponse>

listEvents

public EventListResponse listEvents(Long start,
 Long end,
 EventsApi.ListEventsOptionalParameters parameters)
                             throws ApiException

Get a list of events.

See listEventsWithHttpInfo(java.lang.Long, java.lang.Long, com.datadog.api.client.v1.api.EventsApi.ListEventsOptionalParameters).

Parameters:

start - POSIX timestamp. (required)

end - POSIX timestamp. (required)

parameters - Optional parameters for the request.

Returns:

EventListResponse

Throws:

ApiException - if fails to make API call

listEventsAsync

public CompletableFuture<EventListResponse> listEventsAsync(Long start,
 Long end,
 EventsApi.ListEventsOptionalParameters parameters)

Get a list of events.

See listEventsWithHttpInfoAsync(java.lang.Long, java.lang.Long, com.datadog.api.client.v1.api.EventsApi.ListEventsOptionalParameters).

Parameters:

start - POSIX timestamp. (required)

end - POSIX timestamp. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<EventListResponse>

listEventsWithHttpInfo

public ApiResponse<EventListResponse> listEventsWithHttpInfo(Long start,
 Long end,
 EventsApi.ListEventsOptionalParameters parameters)
                                                      throws ApiException

The event stream can be queried and filtered by time, priority, sources and tags.

Notes: - If the event you’re querying contains markdown formatting of any kind, you may see characters such as %,\,n in your output.

• This endpoint returns a maximum of 1000 most recent results. To return additional results, identify the last timestamp of the last result and set that as the end query time to paginate the results. You can also use the page parameter to specify which set of 1000 results to return.

Parameters:

start - POSIX timestamp. (required)

end - POSIX timestamp. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<EventListResponse>

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	-

listEventsWithHttpInfoAsync

public CompletableFuture<ApiResponse<EventListResponse>> listEventsWithHttpInfoAsync(Long start,
 Long end,
 EventsApi.ListEventsOptionalParameters parameters)

Get a list of events.

See listEventsWithHttpInfo(java.lang.Long, java.lang.Long, com.datadog.api.client.v1.api.EventsApi.ListEventsOptionalParameters).

Parameters:

start - POSIX timestamp. (required)

end - POSIX timestamp. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<EventListResponse>>