com.datadog.api.client.v2.api

Class ReportSchedulesApi

java.lang.Object

com.datadog.api.client.v2.api.ReportSchedulesApi

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

Constructor Summary

Constructors

Constructor and Description
ReportSchedulesApi()
ReportSchedulesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ReportScheduleResponse	createReportSchedule(ReportScheduleCreateRequest body) Create a report schedule.
CompletableFuture<ReportScheduleResponse>	createReportScheduleAsync(ReportScheduleCreateRequest body) Create a report schedule.
ApiResponse<ReportScheduleResponse>	createReportScheduleWithHttpInfo(ReportScheduleCreateRequest body) Create a new scheduled report.
CompletableFuture<ApiResponse<ReportScheduleResponse>>	createReportScheduleWithHttpInfoAsync(ReportScheduleCreateRequest body) Create a report schedule.
ApiClient	getApiClient() Get the API client.
ReportScheduleResponse	patchReportSchedule(UUID scheduleUuid, ReportSchedulePatchRequest body) Update a report schedule.
CompletableFuture<ReportScheduleResponse>	patchReportScheduleAsync(UUID scheduleUuid, ReportSchedulePatchRequest body) Update a report schedule.
ApiResponse<ReportScheduleResponse>	patchReportScheduleWithHttpInfo(UUID scheduleUuid, ReportSchedulePatchRequest body) Update an existing scheduled report by its identifier.
CompletableFuture<ApiResponse<ReportScheduleResponse>>	patchReportScheduleWithHttpInfoAsync(UUID scheduleUuid, ReportSchedulePatchRequest body) Update a report schedule.
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 Detail

ReportSchedulesApi

public ReportSchedulesApi()

ReportSchedulesApi

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

createReportSchedule

public ReportScheduleResponse createReportSchedule(ReportScheduleCreateRequest body)
                                            throws ApiException

Create a report schedule.

See createReportScheduleWithHttpInfo(com.datadog.api.client.v2.model.ReportScheduleCreateRequest).

Parameters:

body - (required)

Returns:

ReportScheduleResponse

Throws:

ApiException - if fails to make API call

createReportScheduleAsync

public CompletableFuture<ReportScheduleResponse> createReportScheduleAsync(ReportScheduleCreateRequest body)

Create a report schedule.

See createReportScheduleWithHttpInfoAsync(com.datadog.api.client.v2.model.ReportScheduleCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ReportScheduleResponse>

createReportScheduleWithHttpInfo

public ApiResponse<ReportScheduleResponse> createReportScheduleWithHttpInfo(ReportScheduleCreateRequest body)
                                                                     throws ApiException

Create a new scheduled report. A schedule renders a dashboard or integration dashboard on a recurring cadence and delivers it to the configured recipients over email, Slack, or Microsoft Teams. Requires the generate_dashboard_reports permission.

Parameters:

body - (required)

Returns:

ApiResponse<ReportScheduleResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
201	CREATED	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

createReportScheduleWithHttpInfoAsync

public CompletableFuture<ApiResponse<ReportScheduleResponse>> createReportScheduleWithHttpInfoAsync(ReportScheduleCreateRequest body)

Create a report schedule.

See createReportScheduleWithHttpInfo(com.datadog.api.client.v2.model.ReportScheduleCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ReportScheduleResponse>>

patchReportSchedule

public ReportScheduleResponse patchReportSchedule(UUID scheduleUuid,
                                                  ReportSchedulePatchRequest body)
                                           throws ApiException

Update a report schedule.

See patchReportScheduleWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.ReportSchedulePatchRequest).

Parameters:

scheduleUuid - The unique identifier of the report schedule to update. (required)

body - (required)

Returns:

ReportScheduleResponse

Throws:

ApiException - if fails to make API call

patchReportScheduleAsync

public CompletableFuture<ReportScheduleResponse> patchReportScheduleAsync(UUID scheduleUuid,
                                                                          ReportSchedulePatchRequest body)

Update a report schedule.

See patchReportScheduleWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.model.ReportSchedulePatchRequest).

Parameters:

scheduleUuid - The unique identifier of the report schedule to update. (required)

body - (required)

Returns:

CompletableFuture<ReportScheduleResponse>

patchReportScheduleWithHttpInfo

public ApiResponse<ReportScheduleResponse> patchReportScheduleWithHttpInfo(UUID scheduleUuid,
                                                                           ReportSchedulePatchRequest body)
                                                                    throws ApiException

Update an existing scheduled report by its identifier. The editable attributes are replaced with the supplied values; the targeted resource (resource_id and resource_type) cannot be changed after creation. Requires the generate_dashboard_reports permission and schedule ownership.

Parameters:

scheduleUuid - The unique identifier of the report schedule to update. (required)

body - (required)

Returns:

ApiResponse<ReportScheduleResponse>

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	-

patchReportScheduleWithHttpInfoAsync

public CompletableFuture<ApiResponse<ReportScheduleResponse>> patchReportScheduleWithHttpInfoAsync(UUID scheduleUuid,
                                                                                                   ReportSchedulePatchRequest body)

Update a report schedule.

See patchReportScheduleWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.ReportSchedulePatchRequest).

Parameters:

scheduleUuid - The unique identifier of the report schedule to update. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<ReportScheduleResponse>>