com.datadog.api.client.v2.api

Class AnnotationsApi

java.lang.Object

com.datadog.api.client.v2.api.AnnotationsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationsApi.ListAnnotationsOptionalParameters Manage optional parameters to listAnnotations.

Constructor Summary

Constructors

Constructor and Description
AnnotationsApi()
AnnotationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
AnnotationResponse	createAnnotation(AnnotationCreateRequest body) Create an annotation.
CompletableFuture<AnnotationResponse>	createAnnotationAsync(AnnotationCreateRequest body) Create an annotation.
ApiResponse<AnnotationResponse>	createAnnotationWithHttpInfo(AnnotationCreateRequest body) Creates a new annotation on a dashboard or notebook page.
CompletableFuture<ApiResponse<AnnotationResponse>>	createAnnotationWithHttpInfoAsync(AnnotationCreateRequest body) Create an annotation.
void	deleteAnnotation(UUID annotationId) Delete an annotation.
CompletableFuture<Void>	deleteAnnotationAsync(UUID annotationId) Delete an annotation.
ApiResponse<Void>	deleteAnnotationWithHttpInfo(UUID annotationId) Deletes an existing annotation by ID.
CompletableFuture<ApiResponse<Void>>	deleteAnnotationWithHttpInfoAsync(UUID annotationId) Delete an annotation.
ApiClient	getApiClient() Get the API client.
PageAnnotationsResponse	getPageAnnotations(String pageId, Long startTime, Long endTime) Get annotations for a page.
CompletableFuture<PageAnnotationsResponse>	getPageAnnotationsAsync(String pageId, Long startTime, Long endTime) Get annotations for a page.
ApiResponse<PageAnnotationsResponse>	getPageAnnotationsWithHttpInfo(String pageId, Long startTime, Long endTime) Returns all annotations on a specific page for a given time window, grouped by widget.
CompletableFuture<ApiResponse<PageAnnotationsResponse>>	getPageAnnotationsWithHttpInfoAsync(String pageId, Long startTime, Long endTime) Get annotations for a page.
AnnotationsResponse	listAnnotations(String pageId, Long startTime, Long endTime) List annotations.
AnnotationsResponse	listAnnotations(String pageId, Long startTime, Long endTime, AnnotationsApi.ListAnnotationsOptionalParameters parameters) List annotations.
CompletableFuture<AnnotationsResponse>	listAnnotationsAsync(String pageId, Long startTime, Long endTime) List annotations.
CompletableFuture<AnnotationsResponse>	listAnnotationsAsync(String pageId, Long startTime, Long endTime, AnnotationsApi.ListAnnotationsOptionalParameters parameters) List annotations.
ApiResponse<AnnotationsResponse>	listAnnotationsWithHttpInfo(String pageId, Long startTime, Long endTime, AnnotationsApi.ListAnnotationsOptionalParameters parameters) Returns a flat list of annotations matching the given page, time window, and optional widget filter.
CompletableFuture<ApiResponse<AnnotationsResponse>>	listAnnotationsWithHttpInfoAsync(String pageId, Long startTime, Long endTime, AnnotationsApi.ListAnnotationsOptionalParameters parameters) List annotations.
void	setApiClient(ApiClient apiClient) Set the API client.
AnnotationResponse	updateAnnotation(UUID annotationId, AnnotationUpdateRequest body) Update an annotation.
CompletableFuture<AnnotationResponse>	updateAnnotationAsync(UUID annotationId, AnnotationUpdateRequest body) Update an annotation.
ApiResponse<AnnotationResponse>	updateAnnotationWithHttpInfo(UUID annotationId, AnnotationUpdateRequest body) Updates an existing annotation.
CompletableFuture<ApiResponse<AnnotationResponse>>	updateAnnotationWithHttpInfoAsync(UUID annotationId, AnnotationUpdateRequest body) Update an annotation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationsApi

public AnnotationsApi()

AnnotationsApi

public AnnotationsApi(ApiClient apiClient)

Method Detail

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

createAnnotation

public AnnotationResponse createAnnotation(AnnotationCreateRequest body)
                                    throws ApiException

Create an annotation.

See createAnnotationWithHttpInfo(com.datadog.api.client.v2.model.AnnotationCreateRequest).

Parameters:

body - Annotation to create. (required)

Returns:

AnnotationResponse

Throws:

ApiException - if fails to make API call

createAnnotationAsync

public CompletableFuture<AnnotationResponse> createAnnotationAsync(AnnotationCreateRequest body)

Create an annotation.

See createAnnotationWithHttpInfoAsync(com.datadog.api.client.v2.model.AnnotationCreateRequest).

Parameters:

body - Annotation to create. (required)

Returns:

CompletableFuture<AnnotationResponse>

createAnnotationWithHttpInfo

public ApiResponse<AnnotationResponse> createAnnotationWithHttpInfo(AnnotationCreateRequest body)
                                                             throws ApiException

Creates a new annotation on a dashboard or notebook page. Valid color values: gray, blue, purple, green, yellow , red. Valid type values: pointInTime (marks a single moment) or timeRegion (spans a range and requires end_time).

Parameters:

body - Annotation to create. (required)

Returns:

ApiResponse<AnnotationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-
500	Internal Server Error	-

createAnnotationWithHttpInfoAsync

public CompletableFuture<ApiResponse<AnnotationResponse>> createAnnotationWithHttpInfoAsync(AnnotationCreateRequest body)

Create an annotation.

See createAnnotationWithHttpInfo(com.datadog.api.client.v2.model.AnnotationCreateRequest).

Parameters:

body - Annotation to create. (required)

Returns:

CompletableFuture<ApiResponse<AnnotationResponse>>

deleteAnnotation

public void deleteAnnotation(UUID annotationId)
                      throws ApiException

Delete an annotation.

See deleteAnnotationWithHttpInfo(java.util.UUID).

Parameters:

annotationId - The ID of the annotation. (required)

Throws:

ApiException - if fails to make API call

deleteAnnotationAsync

public CompletableFuture<Void> deleteAnnotationAsync(UUID annotationId)

Delete an annotation.

See deleteAnnotationWithHttpInfoAsync(java.util.UUID).

Parameters:

annotationId - The ID of the annotation. (required)

Returns:

CompletableFuture

deleteAnnotationWithHttpInfo

public ApiResponse<Void> deleteAnnotationWithHttpInfo(UUID annotationId)
                                               throws ApiException

Deletes an existing annotation by ID. Returns 204 No Content if the annotation does not exist (idempotent).

Parameters:

annotationId - The ID of the annotation. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	No Content	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-
500	Internal Server Error	-

deleteAnnotationWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteAnnotationWithHttpInfoAsync(UUID annotationId)

Delete an annotation.

See deleteAnnotationWithHttpInfo(java.util.UUID).

Parameters:

annotationId - The ID of the annotation. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getPageAnnotations

public PageAnnotationsResponse getPageAnnotations(String pageId,
                                                  Long startTime,
                                                  Long endTime)
                                           throws ApiException

Get annotations for a page.

See getPageAnnotationsWithHttpInfo(java.lang.String, java.lang.Long, java.lang.Long).

Parameters:

pageId - The ID of the page, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890). (required)

startTime - Start of the time window in milliseconds since the Unix epoch. (required)

endTime - End of the time window in milliseconds since the Unix epoch. (required)

Returns:

PageAnnotationsResponse

Throws:

ApiException - if fails to make API call

getPageAnnotationsAsync

public CompletableFuture<PageAnnotationsResponse> getPageAnnotationsAsync(String pageId,
                                                                          Long startTime,
                                                                          Long endTime)

Get annotations for a page.

See getPageAnnotationsWithHttpInfoAsync(java.lang.String, java.lang.Long, java.lang.Long).

Parameters:

pageId - The ID of the page, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890). (required)

startTime - Start of the time window in milliseconds since the Unix epoch. (required)

endTime - End of the time window in milliseconds since the Unix epoch. (required)

Returns:

CompletableFuture<PageAnnotationsResponse>

getPageAnnotationsWithHttpInfo

public ApiResponse<PageAnnotationsResponse> getPageAnnotationsWithHttpInfo(String pageId,
                                                                           Long startTime,
                                                                           Long endTime)
                                                                    throws ApiException

Returns all annotations on a specific page for a given time window, grouped by widget. Unlike ListAnnotations, this endpoint returns a single structured object with annotations indexed by their ID and a widget-to-annotation mapping for easy UI rendering.

Parameters:

pageId - The ID of the page, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890). (required)

startTime - Start of the time window in milliseconds since the Unix epoch. (required)

endTime - End of the time window in milliseconds since the Unix epoch. (required)

Returns:

ApiResponse<PageAnnotationsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-
500	Internal Server Error	-

getPageAnnotationsWithHttpInfoAsync

public CompletableFuture<ApiResponse<PageAnnotationsResponse>> getPageAnnotationsWithHttpInfoAsync(String pageId,
                                                                                                   Long startTime,
                                                                                                   Long endTime)

Get annotations for a page.

See getPageAnnotationsWithHttpInfo(java.lang.String, java.lang.Long, java.lang.Long).

Parameters:

pageId - The ID of the page, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890). (required)

startTime - Start of the time window in milliseconds since the Unix epoch. (required)

endTime - End of the time window in milliseconds since the Unix epoch. (required)

Returns:

CompletableFuture<ApiResponse<PageAnnotationsResponse>>

listAnnotations

public AnnotationsResponse listAnnotations(String pageId,
                                           Long startTime,
                                           Long endTime)
                                    throws ApiException

List annotations.

See listAnnotationsWithHttpInfo(java.lang.String, java.lang.Long, java.lang.Long, com.datadog.api.client.v2.api.AnnotationsApi.ListAnnotationsOptionalParameters).

Parameters:

pageId - ID of the page to list annotations for, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890 ). (required)

startTime - Start of the time window in milliseconds since the Unix epoch. (required)

endTime - End of the time window in milliseconds since the Unix epoch. (required)

Returns:

AnnotationsResponse

Throws:

ApiException - if fails to make API call

listAnnotationsAsync

public CompletableFuture<AnnotationsResponse> listAnnotationsAsync(String pageId,
                                                                   Long startTime,
                                                                   Long endTime)

List annotations.

See listAnnotationsWithHttpInfoAsync(java.lang.String, java.lang.Long, java.lang.Long, com.datadog.api.client.v2.api.AnnotationsApi.ListAnnotationsOptionalParameters).

Parameters:

pageId - ID of the page to list annotations for, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890 ). (required)

startTime - Start of the time window in milliseconds since the Unix epoch. (required)

endTime - End of the time window in milliseconds since the Unix epoch. (required)

Returns:

CompletableFuture<AnnotationsResponse>

listAnnotations

public AnnotationsResponse listAnnotations(String pageId,
                                           Long startTime,
                                           Long endTime,
                                           AnnotationsApi.ListAnnotationsOptionalParameters parameters)
                                    throws ApiException

List annotations.

See listAnnotationsWithHttpInfo(java.lang.String, java.lang.Long, java.lang.Long, com.datadog.api.client.v2.api.AnnotationsApi.ListAnnotationsOptionalParameters).

Parameters:

pageId - ID of the page to list annotations for, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890 ). (required)

startTime - Start of the time window in milliseconds since the Unix epoch. (required)

endTime - End of the time window in milliseconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

AnnotationsResponse

Throws:

ApiException - if fails to make API call

listAnnotationsAsync

public CompletableFuture<AnnotationsResponse> listAnnotationsAsync(String pageId,
                                                                   Long startTime,
                                                                   Long endTime,
                                                                   AnnotationsApi.ListAnnotationsOptionalParameters parameters)

List annotations.

See listAnnotationsWithHttpInfoAsync(java.lang.String, java.lang.Long, java.lang.Long, com.datadog.api.client.v2.api.AnnotationsApi.ListAnnotationsOptionalParameters).

Parameters:

pageId - ID of the page to list annotations for, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890 ). (required)

startTime - Start of the time window in milliseconds since the Unix epoch. (required)

endTime - End of the time window in milliseconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<AnnotationsResponse>

listAnnotationsWithHttpInfo

public ApiResponse<AnnotationsResponse> listAnnotationsWithHttpInfo(String pageId,
                                                                    Long startTime,
                                                                    Long endTime,
                                                                    AnnotationsApi.ListAnnotationsOptionalParameters parameters)
                                                             throws ApiException

Returns a flat list of annotations matching the given page, time window, and optional widget filter.

Parameters:

pageId - ID of the page to list annotations for, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890 ). (required)

startTime - Start of the time window in milliseconds since the Unix epoch. (required)

endTime - End of the time window in milliseconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<AnnotationsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-
500	Internal Server Error	-

listAnnotationsWithHttpInfoAsync

public CompletableFuture<ApiResponse<AnnotationsResponse>> listAnnotationsWithHttpInfoAsync(String pageId,
                                                                                            Long startTime,
                                                                                            Long endTime,
                                                                                            AnnotationsApi.ListAnnotationsOptionalParameters parameters)

List annotations.

See listAnnotationsWithHttpInfo(java.lang.String, java.lang.Long, java.lang.Long, com.datadog.api.client.v2.api.AnnotationsApi.ListAnnotationsOptionalParameters).

Parameters:

pageId - ID of the page to list annotations for, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890 ). (required)

startTime - Start of the time window in milliseconds since the Unix epoch. (required)

endTime - End of the time window in milliseconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<AnnotationsResponse>>

updateAnnotation

public AnnotationResponse updateAnnotation(UUID annotationId,
                                           AnnotationUpdateRequest body)
                                    throws ApiException

Update an annotation.

See updateAnnotationWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.AnnotationUpdateRequest).

Parameters:

annotationId - The ID of the annotation. (required)

body - Updated annotation payload. (required)

Returns:

AnnotationResponse

Throws:

ApiException - if fails to make API call

updateAnnotationAsync

public CompletableFuture<AnnotationResponse> updateAnnotationAsync(UUID annotationId,
                                                                   AnnotationUpdateRequest body)

Update an annotation.

See updateAnnotationWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.model.AnnotationUpdateRequest).

Parameters:

annotationId - The ID of the annotation. (required)

body - Updated annotation payload. (required)

Returns:

CompletableFuture<AnnotationResponse>

updateAnnotationWithHttpInfo

public ApiResponse<AnnotationResponse> updateAnnotationWithHttpInfo(UUID annotationId,
                                                                    AnnotationUpdateRequest body)
                                                             throws ApiException

Updates an existing annotation. Valid color values: gray, blue , purple, green, yellow, red. Valid type values: pointInTime (marks a single moment) or timeRegion (spans a range and requires end_time).

Parameters:

annotationId - The ID of the annotation. (required)

body - Updated annotation payload. (required)

Returns:

ApiResponse<AnnotationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-
500	Internal Server Error	-

updateAnnotationWithHttpInfoAsync

public CompletableFuture<ApiResponse<AnnotationResponse>> updateAnnotationWithHttpInfoAsync(UUID annotationId,
                                                                                            AnnotationUpdateRequest body)

Update an annotation.

See updateAnnotationWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.AnnotationUpdateRequest).

Parameters:

annotationId - The ID of the annotation. (required)

body - Updated annotation payload. (required)

Returns:

CompletableFuture<ApiResponse<AnnotationResponse>>