com.datadog.api.client.v2.api

Class DowntimesApi

java.lang.Object

com.datadog.api.client.v2.api.DowntimesApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DowntimesApi.GetDowntimeOptionalParameters Manage optional parameters to getDowntime.
static class	DowntimesApi.ListDowntimesOptionalParameters Manage optional parameters to listDowntimes.
static class	DowntimesApi.ListMonitorDowntimesOptionalParameters Manage optional parameters to listMonitorDowntimes.

Constructor Summary

Constructors

Constructor and Description
DowntimesApi()
DowntimesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	cancelDowntime(String downtimeId) Cancel a downtime.
CompletableFuture<Void>	cancelDowntimeAsync(String downtimeId) Cancel a downtime.
ApiResponse<Void>	cancelDowntimeWithHttpInfo(String downtimeId) Cancel a downtime.
CompletableFuture<ApiResponse<Void>>	cancelDowntimeWithHttpInfoAsync(String downtimeId) Cancel a downtime.
DowntimeResponse	createDowntime(DowntimeCreateRequest body) Schedule a downtime.
CompletableFuture<DowntimeResponse>	createDowntimeAsync(DowntimeCreateRequest body) Schedule a downtime.
ApiResponse<DowntimeResponse>	createDowntimeWithHttpInfo(DowntimeCreateRequest body) Schedule a downtime.
CompletableFuture<ApiResponse<DowntimeResponse>>	createDowntimeWithHttpInfoAsync(DowntimeCreateRequest body) Schedule a downtime.
ApiClient	getApiClient() Get the API client.
DowntimeResponse	getDowntime(String downtimeId) Get a downtime.
DowntimeResponse	getDowntime(String downtimeId, DowntimesApi.GetDowntimeOptionalParameters parameters) Get a downtime.
CompletableFuture<DowntimeResponse>	getDowntimeAsync(String downtimeId) Get a downtime.
CompletableFuture<DowntimeResponse>	getDowntimeAsync(String downtimeId, DowntimesApi.GetDowntimeOptionalParameters parameters) Get a downtime.
ApiResponse<DowntimeResponse>	getDowntimeWithHttpInfo(String downtimeId, DowntimesApi.GetDowntimeOptionalParameters parameters) Get downtime detail by downtime_id.
CompletableFuture<ApiResponse<DowntimeResponse>>	getDowntimeWithHttpInfoAsync(String downtimeId, DowntimesApi.GetDowntimeOptionalParameters parameters) Get a downtime.
ListDowntimesResponse	listDowntimes() Get all downtimes.
ListDowntimesResponse	listDowntimes(DowntimesApi.ListDowntimesOptionalParameters parameters) Get all downtimes.
CompletableFuture<ListDowntimesResponse>	listDowntimesAsync() Get all downtimes.
CompletableFuture<ListDowntimesResponse>	listDowntimesAsync(DowntimesApi.ListDowntimesOptionalParameters parameters) Get all downtimes.
ApiResponse<ListDowntimesResponse>	listDowntimesWithHttpInfo(DowntimesApi.ListDowntimesOptionalParameters parameters) Get all scheduled downtimes.
CompletableFuture<ApiResponse<ListDowntimesResponse>>	listDowntimesWithHttpInfoAsync(DowntimesApi.ListDowntimesOptionalParameters parameters) Get all downtimes.
PaginationIterable<DowntimeResponseData>	listDowntimesWithPagination() Get all downtimes.
PaginationIterable<DowntimeResponseData>	listDowntimesWithPagination(DowntimesApi.ListDowntimesOptionalParameters parameters) Get all downtimes.
MonitorDowntimeMatchResponse	listMonitorDowntimes(Long monitorId) Get active downtimes for a monitor.
MonitorDowntimeMatchResponse	listMonitorDowntimes(Long monitorId, DowntimesApi.ListMonitorDowntimesOptionalParameters parameters) Get active downtimes for a monitor.
CompletableFuture<MonitorDowntimeMatchResponse>	listMonitorDowntimesAsync(Long monitorId) Get active downtimes for a monitor.
CompletableFuture<MonitorDowntimeMatchResponse>	listMonitorDowntimesAsync(Long monitorId, DowntimesApi.ListMonitorDowntimesOptionalParameters parameters) Get active downtimes for a monitor.
ApiResponse<MonitorDowntimeMatchResponse>	listMonitorDowntimesWithHttpInfo(Long monitorId, DowntimesApi.ListMonitorDowntimesOptionalParameters parameters) Get all active downtimes for the specified monitor.
CompletableFuture<ApiResponse<MonitorDowntimeMatchResponse>>	listMonitorDowntimesWithHttpInfoAsync(Long monitorId, DowntimesApi.ListMonitorDowntimesOptionalParameters parameters) Get active downtimes for a monitor.
PaginationIterable<MonitorDowntimeMatchResponseData>	listMonitorDowntimesWithPagination(Long monitorId) Get active downtimes for a monitor.
PaginationIterable<MonitorDowntimeMatchResponseData>	listMonitorDowntimesWithPagination(Long monitorId, DowntimesApi.ListMonitorDowntimesOptionalParameters parameters) Get active downtimes for a monitor.
void	setApiClient(ApiClient apiClient) Set the API client.
DowntimeResponse	updateDowntime(String downtimeId, DowntimeUpdateRequest body) Update a downtime.
CompletableFuture<DowntimeResponse>	updateDowntimeAsync(String downtimeId, DowntimeUpdateRequest body) Update a downtime.
ApiResponse<DowntimeResponse>	updateDowntimeWithHttpInfo(String downtimeId, DowntimeUpdateRequest body) Update a downtime by downtime_id.
CompletableFuture<ApiResponse<DowntimeResponse>>	updateDowntimeWithHttpInfoAsync(String downtimeId, DowntimeUpdateRequest body) Update a downtime.

Methods inherited from class java.lang.Object

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

Constructor Detail

DowntimesApi

public DowntimesApi()

DowntimesApi

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

cancelDowntime

public void cancelDowntime(String downtimeId)
                    throws ApiException

Cancel a downtime.

See cancelDowntimeWithHttpInfo(java.lang.String).

Parameters:

downtimeId - ID of the downtime to cancel. (required)

Throws:

ApiException - if fails to make API call

cancelDowntimeAsync

public CompletableFuture<Void> cancelDowntimeAsync(String downtimeId)

Cancel a downtime.

See cancelDowntimeWithHttpInfoAsync(java.lang.String).

Parameters:

downtimeId - ID of the downtime to cancel. (required)

Returns:

CompletableFuture

cancelDowntimeWithHttpInfo

public ApiResponse<Void> cancelDowntimeWithHttpInfo(String downtimeId)
                                             throws ApiException

Cancel a downtime.

Note: Downtimes canceled through the API are no longer active, but are retained for approximately two days before being permanently removed. The downtime may still appear in search results until it is permanently removed.

Parameters:

downtimeId - ID of the downtime to cancel. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	OK	-
403	Forbidden	-
404	Downtime not found	-
429	Too many requests	-

cancelDowntimeWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> cancelDowntimeWithHttpInfoAsync(String downtimeId)

Cancel a downtime.

See cancelDowntimeWithHttpInfo(java.lang.String).

Parameters:

downtimeId - ID of the downtime to cancel. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

createDowntime

public DowntimeResponse createDowntime(DowntimeCreateRequest body)
                                throws ApiException

Schedule a downtime.

See createDowntimeWithHttpInfo(com.datadog.api.client.v2.model.DowntimeCreateRequest).

Parameters:

body - Schedule a downtime request body. (required)

Returns:

DowntimeResponse

Throws:

ApiException - if fails to make API call

createDowntimeAsync

public CompletableFuture<DowntimeResponse> createDowntimeAsync(DowntimeCreateRequest body)

Schedule a downtime.

See createDowntimeWithHttpInfoAsync(com.datadog.api.client.v2.model.DowntimeCreateRequest).

Parameters:

body - Schedule a downtime request body. (required)

Returns:

CompletableFuture<DowntimeResponse>

createDowntimeWithHttpInfo

public ApiResponse<DowntimeResponse> createDowntimeWithHttpInfo(DowntimeCreateRequest body)
                                                         throws ApiException

Schedule a downtime.

Parameters:

body - Schedule a downtime request body. (required)

Returns:

ApiResponse<DowntimeResponse>

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	-

createDowntimeWithHttpInfoAsync

public CompletableFuture<ApiResponse<DowntimeResponse>> createDowntimeWithHttpInfoAsync(DowntimeCreateRequest body)

Schedule a downtime.

See createDowntimeWithHttpInfo(com.datadog.api.client.v2.model.DowntimeCreateRequest).

Parameters:

body - Schedule a downtime request body. (required)

Returns:

CompletableFuture<ApiResponse<DowntimeResponse>>

getDowntime

public DowntimeResponse getDowntime(String downtimeId)
                             throws ApiException

Get a downtime.

See getDowntimeWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.DowntimesApi.GetDowntimeOptionalParameters).

Parameters:

downtimeId - ID of the downtime to fetch. (required)

Returns:

DowntimeResponse

Throws:

ApiException - if fails to make API call

getDowntimeAsync

public CompletableFuture<DowntimeResponse> getDowntimeAsync(String downtimeId)

Get a downtime.

See getDowntimeWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.DowntimesApi.GetDowntimeOptionalParameters).

Parameters:

downtimeId - ID of the downtime to fetch. (required)

Returns:

CompletableFuture<DowntimeResponse>

getDowntime

public DowntimeResponse getDowntime(String downtimeId,
                                    DowntimesApi.GetDowntimeOptionalParameters parameters)
                             throws ApiException

Get a downtime.

See getDowntimeWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.DowntimesApi.GetDowntimeOptionalParameters).

Parameters:

downtimeId - ID of the downtime to fetch. (required)

parameters - Optional parameters for the request.

Returns:

DowntimeResponse

Throws:

ApiException - if fails to make API call

getDowntimeAsync

public CompletableFuture<DowntimeResponse> getDowntimeAsync(String downtimeId,
                                                            DowntimesApi.GetDowntimeOptionalParameters parameters)

Get a downtime.

See getDowntimeWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.DowntimesApi.GetDowntimeOptionalParameters).

Parameters:

downtimeId - ID of the downtime to fetch. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<DowntimeResponse>

getDowntimeWithHttpInfo

public ApiResponse<DowntimeResponse> getDowntimeWithHttpInfo(String downtimeId,
                                                             DowntimesApi.GetDowntimeOptionalParameters parameters)
                                                      throws ApiException

Get downtime detail by downtime_id.

Parameters:

downtimeId - ID of the downtime to fetch. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<DowntimeResponse>

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	-

getDowntimeWithHttpInfoAsync

public CompletableFuture<ApiResponse<DowntimeResponse>> getDowntimeWithHttpInfoAsync(String downtimeId,
                                                                                     DowntimesApi.GetDowntimeOptionalParameters parameters)

Get a downtime.

See getDowntimeWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.DowntimesApi.GetDowntimeOptionalParameters).

Parameters:

downtimeId - ID of the downtime to fetch. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<DowntimeResponse>>

listDowntimes

public ListDowntimesResponse listDowntimes()
                                    throws ApiException

Get all downtimes.

See listDowntimesWithHttpInfo(com.datadog.api.client.v2.api.DowntimesApi.ListDowntimesOptionalParameters).

Returns:

ListDowntimesResponse

Throws:

ApiException - if fails to make API call

listDowntimesAsync

public CompletableFuture<ListDowntimesResponse> listDowntimesAsync()

Get all downtimes.

See listDowntimesWithHttpInfoAsync(com.datadog.api.client.v2.api.DowntimesApi.ListDowntimesOptionalParameters).

Returns:

CompletableFuture<ListDowntimesResponse>

listDowntimes

public ListDowntimesResponse listDowntimes(DowntimesApi.ListDowntimesOptionalParameters parameters)
                                    throws ApiException

Get all downtimes.

See listDowntimesWithHttpInfo(com.datadog.api.client.v2.api.DowntimesApi.ListDowntimesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

ListDowntimesResponse

Throws:

ApiException - if fails to make API call

listDowntimesAsync

public CompletableFuture<ListDowntimesResponse> listDowntimesAsync(DowntimesApi.ListDowntimesOptionalParameters parameters)

Get all downtimes.

See listDowntimesWithHttpInfoAsync(com.datadog.api.client.v2.api.DowntimesApi.ListDowntimesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ListDowntimesResponse>

listDowntimesWithPagination

public PaginationIterable<DowntimeResponseData> listDowntimesWithPagination()

Get all downtimes.

See listDowntimesWithHttpInfo(com.datadog.api.client.v2.api.DowntimesApi.ListDowntimesOptionalParameters).

Returns:

PaginationIterable<DowntimeResponseData>

listDowntimesWithPagination

public PaginationIterable<DowntimeResponseData> listDowntimesWithPagination(DowntimesApi.ListDowntimesOptionalParameters parameters)

Get all downtimes.

See listDowntimesWithHttpInfo(com.datadog.api.client.v2.api.DowntimesApi.ListDowntimesOptionalParameters).

Returns:

ListDowntimesResponse

listDowntimesWithHttpInfo

public ApiResponse<ListDowntimesResponse> listDowntimesWithHttpInfo(DowntimesApi.ListDowntimesOptionalParameters parameters)
                                                             throws ApiException

Get all scheduled downtimes.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<ListDowntimesResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
429	Too many requests	-

listDowntimesWithHttpInfoAsync

public CompletableFuture<ApiResponse<ListDowntimesResponse>> listDowntimesWithHttpInfoAsync(DowntimesApi.ListDowntimesOptionalParameters parameters)

Get all downtimes.

See listDowntimesWithHttpInfo(com.datadog.api.client.v2.api.DowntimesApi.ListDowntimesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListDowntimesResponse>>

listMonitorDowntimes

public MonitorDowntimeMatchResponse listMonitorDowntimes(Long monitorId)
                                                  throws ApiException

Get active downtimes for a monitor.

See listMonitorDowntimesWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.api.DowntimesApi.ListMonitorDowntimesOptionalParameters).

Parameters:

monitorId - The id of the monitor. (required)

Returns:

MonitorDowntimeMatchResponse

Throws:

ApiException - if fails to make API call

listMonitorDowntimesAsync

public CompletableFuture<MonitorDowntimeMatchResponse> listMonitorDowntimesAsync(Long monitorId)

Get active downtimes for a monitor.

See listMonitorDowntimesWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v2.api.DowntimesApi.ListMonitorDowntimesOptionalParameters).

Parameters:

monitorId - The id of the monitor. (required)

Returns:

CompletableFuture<MonitorDowntimeMatchResponse>

listMonitorDowntimes

public MonitorDowntimeMatchResponse listMonitorDowntimes(Long monitorId,
                                                         DowntimesApi.ListMonitorDowntimesOptionalParameters parameters)
                                                  throws ApiException

Get active downtimes for a monitor.

See listMonitorDowntimesWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.api.DowntimesApi.ListMonitorDowntimesOptionalParameters).

Parameters:

monitorId - The id of the monitor. (required)

parameters - Optional parameters for the request.

Returns:

MonitorDowntimeMatchResponse

Throws:

ApiException - if fails to make API call

listMonitorDowntimesAsync

public CompletableFuture<MonitorDowntimeMatchResponse> listMonitorDowntimesAsync(Long monitorId,
                                                                                 DowntimesApi.ListMonitorDowntimesOptionalParameters parameters)

Get active downtimes for a monitor.

See listMonitorDowntimesWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v2.api.DowntimesApi.ListMonitorDowntimesOptionalParameters).

Parameters:

monitorId - The id of the monitor. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<MonitorDowntimeMatchResponse>

listMonitorDowntimesWithPagination

public PaginationIterable<MonitorDowntimeMatchResponseData> listMonitorDowntimesWithPagination(Long monitorId)

Get active downtimes for a monitor.

See listMonitorDowntimesWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.api.DowntimesApi.ListMonitorDowntimesOptionalParameters).

Parameters:

monitorId - The id of the monitor. (required)

Returns:

PaginationIterable<MonitorDowntimeMatchResponseData>

listMonitorDowntimesWithPagination

public PaginationIterable<MonitorDowntimeMatchResponseData> listMonitorDowntimesWithPagination(Long monitorId,
                                                                                               DowntimesApi.ListMonitorDowntimesOptionalParameters parameters)

Get active downtimes for a monitor.

See listMonitorDowntimesWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.api.DowntimesApi.ListMonitorDowntimesOptionalParameters).

Parameters:

monitorId - The id of the monitor. (required)

Returns:

MonitorDowntimeMatchResponse

listMonitorDowntimesWithHttpInfo

public ApiResponse<MonitorDowntimeMatchResponse> listMonitorDowntimesWithHttpInfo(Long monitorId,
                                                                                  DowntimesApi.ListMonitorDowntimesOptionalParameters parameters)
                                                                           throws ApiException

Get all active downtimes for the specified monitor.

Parameters:

monitorId - The id of the monitor. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<MonitorDowntimeMatchResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
404	Monitor Not Found error	-
429	Too many requests	-

listMonitorDowntimesWithHttpInfoAsync

public CompletableFuture<ApiResponse<MonitorDowntimeMatchResponse>> listMonitorDowntimesWithHttpInfoAsync(Long monitorId,
                                                                                                          DowntimesApi.ListMonitorDowntimesOptionalParameters parameters)

Get active downtimes for a monitor.

See listMonitorDowntimesWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.api.DowntimesApi.ListMonitorDowntimesOptionalParameters).

Parameters:

monitorId - The id of the monitor. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<MonitorDowntimeMatchResponse>>

updateDowntime

public DowntimeResponse updateDowntime(String downtimeId,
                                       DowntimeUpdateRequest body)
                                throws ApiException

Update a downtime.

See updateDowntimeWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.DowntimeUpdateRequest).

Parameters:

downtimeId - ID of the downtime to update. (required)

body - Update a downtime request body. (required)

Returns:

DowntimeResponse

Throws:

ApiException - if fails to make API call

updateDowntimeAsync

public CompletableFuture<DowntimeResponse> updateDowntimeAsync(String downtimeId,
                                                               DowntimeUpdateRequest body)

Update a downtime.

See updateDowntimeWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.DowntimeUpdateRequest).

Parameters:

downtimeId - ID of the downtime to update. (required)

body - Update a downtime request body. (required)

Returns:

CompletableFuture<DowntimeResponse>

updateDowntimeWithHttpInfo

public ApiResponse<DowntimeResponse> updateDowntimeWithHttpInfo(String downtimeId,
                                                                DowntimeUpdateRequest body)
                                                         throws ApiException

Update a downtime by downtime_id.

Parameters:

downtimeId - ID of the downtime to update. (required)

body - Update a downtime request body. (required)

Returns:

ApiResponse<DowntimeResponse>

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	Downtime not found	-
429	Too many requests	-

updateDowntimeWithHttpInfoAsync

public CompletableFuture<ApiResponse<DowntimeResponse>> updateDowntimeWithHttpInfoAsync(String downtimeId,
                                                                                        DowntimeUpdateRequest body)

Update a downtime.

See updateDowntimeWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.DowntimeUpdateRequest).

Parameters:

downtimeId - ID of the downtime to update. (required)

body - Update a downtime request body. (required)

Returns:

CompletableFuture<ApiResponse<DowntimeResponse>>