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

Class SnapshotsApi

java.lang.Object

com.datadog.api.client.v1.api.SnapshotsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotsApi.GetGraphSnapshotOptionalParameters	Manage optional parameters to getGraphSnapshot.

Constructor Summary

Constructors

Constructor	Description
SnapshotsApi()
SnapshotsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	Get the API client.
GraphSnapshot	getGraphSnapshot(Long start, Long end)	Take graph snapshots.
GraphSnapshot	getGraphSnapshot(Long start, Long end, SnapshotsApi.GetGraphSnapshotOptionalParameters parameters)	Take graph snapshots.
CompletableFuture<GraphSnapshot>	getGraphSnapshotAsync(Long start, Long end)	Take graph snapshots.
CompletableFuture<GraphSnapshot>	getGraphSnapshotAsync(Long start, Long end, SnapshotsApi.GetGraphSnapshotOptionalParameters parameters)	Take graph snapshots.
ApiResponse<GraphSnapshot>	getGraphSnapshotWithHttpInfo(Long start, Long end, SnapshotsApi.GetGraphSnapshotOptionalParameters parameters)	Take graph snapshots.
CompletableFuture<ApiResponse<GraphSnapshot>>	getGraphSnapshotWithHttpInfoAsync(Long start, Long end, SnapshotsApi.GetGraphSnapshotOptionalParameters parameters)	Take graph snapshots.
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

SnapshotsApi

public SnapshotsApi()

SnapshotsApi

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

getGraphSnapshot

public GraphSnapshot getGraphSnapshot(Long start,
 Long end)
                               throws ApiException

Take graph snapshots.

See getGraphSnapshotWithHttpInfo(java.lang.Long, java.lang.Long, com.datadog.api.client.v1.api.SnapshotsApi.GetGraphSnapshotOptionalParameters).

Parameters:

start - The POSIX timestamp of the start of the query in seconds. (required)

end - The POSIX timestamp of the end of the query in seconds. (required)

Returns:

GraphSnapshot

Throws:

ApiException - if fails to make API call

getGraphSnapshotAsync

public CompletableFuture<GraphSnapshot> getGraphSnapshotAsync(Long start,
 Long end)

Take graph snapshots.

See getGraphSnapshotWithHttpInfoAsync(java.lang.Long, java.lang.Long, com.datadog.api.client.v1.api.SnapshotsApi.GetGraphSnapshotOptionalParameters).

Parameters:

start - The POSIX timestamp of the start of the query in seconds. (required)

end - The POSIX timestamp of the end of the query in seconds. (required)

Returns:

CompletableFuture<GraphSnapshot>

getGraphSnapshot

public GraphSnapshot getGraphSnapshot(Long start,
 Long end,
 SnapshotsApi.GetGraphSnapshotOptionalParameters parameters)
                               throws ApiException

Take graph snapshots.

See getGraphSnapshotWithHttpInfo(java.lang.Long, java.lang.Long, com.datadog.api.client.v1.api.SnapshotsApi.GetGraphSnapshotOptionalParameters).

Parameters:

start - The POSIX timestamp of the start of the query in seconds. (required)

end - The POSIX timestamp of the end of the query in seconds. (required)

parameters - Optional parameters for the request.

Returns:

GraphSnapshot

Throws:

ApiException - if fails to make API call

getGraphSnapshotAsync

public CompletableFuture<GraphSnapshot> getGraphSnapshotAsync(Long start,
 Long end,
 SnapshotsApi.GetGraphSnapshotOptionalParameters parameters)

Take graph snapshots.

See getGraphSnapshotWithHttpInfoAsync(java.lang.Long, java.lang.Long, com.datadog.api.client.v1.api.SnapshotsApi.GetGraphSnapshotOptionalParameters).

Parameters:

start - The POSIX timestamp of the start of the query in seconds. (required)

end - The POSIX timestamp of the end of the query in seconds. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<GraphSnapshot>

getGraphSnapshotWithHttpInfo

public ApiResponse<GraphSnapshot> getGraphSnapshotWithHttpInfo(Long start,
 Long end,
 SnapshotsApi.GetGraphSnapshotOptionalParameters parameters)
                                                        throws ApiException

Take graph snapshots. Snapshots are PNG images generated by rendering a specified widget in a web page and capturing it once the data is available. The image is then uploaded to cloud storage.

Note: When a snapshot is created, there is some delay before it is available.

Parameters:

start - The POSIX timestamp of the start of the query in seconds. (required)

end - The POSIX timestamp of the end of the query in seconds. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<GraphSnapshot>

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	-

getGraphSnapshotWithHttpInfoAsync

public CompletableFuture<ApiResponse<GraphSnapshot>> getGraphSnapshotWithHttpInfoAsync(Long start,
 Long end,
 SnapshotsApi.GetGraphSnapshotOptionalParameters parameters)

Take graph snapshots.

See getGraphSnapshotWithHttpInfo(java.lang.Long, java.lang.Long, com.datadog.api.client.v1.api.SnapshotsApi.GetGraphSnapshotOptionalParameters).

Parameters:

start - The POSIX timestamp of the start of the query in seconds. (required)

end - The POSIX timestamp of the end of the query in seconds. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<GraphSnapshot>>