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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportSchedulesApi.ListReportSchedulesOptionalParameters Manage optional parameters to listReportSchedules.

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.
ReportScheduleResponse	deleteReportSchedule(UUID scheduleUuid) Delete a report schedule.
CompletableFuture<ReportScheduleResponse>	deleteReportScheduleAsync(UUID scheduleUuid) Delete a report schedule.
ApiResponse<ReportScheduleResponse>	deleteReportScheduleWithHttpInfo(UUID scheduleUuid) Delete a report schedule by its unique identifier.
CompletableFuture<ApiResponse<ReportScheduleResponse>>	deleteReportScheduleWithHttpInfoAsync(UUID scheduleUuid) Delete a report schedule.
ApiClient	getApiClient() Get the API client.
ReportScheduleResponse	getReportSchedule(UUID scheduleUuid) Get a report schedule.
CompletableFuture<ReportScheduleResponse>	getReportScheduleAsync(UUID scheduleUuid) Get a report schedule.
ReportScheduleListResponse	getReportSchedulesForResource(ReportScheduleResourceType resourceType, String resourceId) Get report schedules for a resource.
CompletableFuture<ReportScheduleListResponse>	getReportSchedulesForResourceAsync(ReportScheduleResourceType resourceType, String resourceId) Get report schedules for a resource.
ApiResponse<ReportScheduleListResponse>	getReportSchedulesForResourceWithHttpInfo(ReportScheduleResourceType resourceType, String resourceId) Get all report schedules that target a dashboard or integration dashboard resource.
CompletableFuture<ApiResponse<ReportScheduleListResponse>>	getReportSchedulesForResourceWithHttpInfoAsync(ReportScheduleResourceType resourceType, String resourceId) Get report schedules for a resource.
ApiResponse<ReportScheduleResponse>	getReportScheduleWithHttpInfo(UUID scheduleUuid) Get a report schedule by its unique identifier.
CompletableFuture<ApiResponse<ReportScheduleResponse>>	getReportScheduleWithHttpInfoAsync(UUID scheduleUuid) Get a report schedule.
DatasetReportScheduleListResponse	listDatasetReportSchedules(String datasetId) List dataset report schedules.
CompletableFuture<DatasetReportScheduleListResponse>	listDatasetReportSchedulesAsync(String datasetId) List dataset report schedules.
ApiResponse<DatasetReportScheduleListResponse>	listDatasetReportSchedulesWithHttpInfo(String datasetId) Retrieve all report schedules for a given published dataset.
CompletableFuture<ApiResponse<DatasetReportScheduleListResponse>>	listDatasetReportSchedulesWithHttpInfoAsync(String datasetId) List dataset report schedules.
ReportScheduleListResponse	listReportSchedules() List report schedules.
ReportScheduleListResponse	listReportSchedules(ReportSchedulesApi.ListReportSchedulesOptionalParameters parameters) List report schedules.
CompletableFuture<ReportScheduleListResponse>	listReportSchedulesAsync() List report schedules.
CompletableFuture<ReportScheduleListResponse>	listReportSchedulesAsync(ReportSchedulesApi.ListReportSchedulesOptionalParameters parameters) List report schedules.
ApiResponse<ReportScheduleListResponse>	listReportSchedulesWithHttpInfo(ReportSchedulesApi.ListReportSchedulesOptionalParameters parameters) List dashboard and integration dashboard report schedules for the organization.
CompletableFuture<ApiResponse<ReportScheduleListResponse>>	listReportSchedulesWithHttpInfoAsync(ReportSchedulesApi.ListReportSchedulesOptionalParameters parameters) List report schedules.
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.
PrintReportResponse	printReport(PrintReportRequest body) Print a report.
CompletableFuture<PrintReportResponse>	printReportAsync(PrintReportRequest body) Print a report.
ApiResponse<PrintReportResponse>	printReportWithHttpInfo(PrintReportRequest body) Initiate a one-off, print-only report for a dashboard or integration dashboard.
CompletableFuture<ApiResponse<PrintReportResponse>>	printReportWithHttpInfoAsync(PrintReportRequest body) Print a report.
void	setApiClient(ApiClient apiClient) Set the API client.
ReportScheduleResponse	toggleReportSchedule(UUID scheduleUuid, ReportScheduleToggleRequest body) Toggle a report schedule.
CompletableFuture<ReportScheduleResponse>	toggleReportScheduleAsync(UUID scheduleUuid, ReportScheduleToggleRequest body) Toggle a report schedule.
ApiResponse<ReportScheduleResponse>	toggleReportScheduleWithHttpInfo(UUID scheduleUuid, ReportScheduleToggleRequest body) Activate or pause a report schedule by setting its status to active or inactive.
CompletableFuture<ApiResponse<ReportScheduleResponse>>	toggleReportScheduleWithHttpInfoAsync(UUID scheduleUuid, ReportScheduleToggleRequest body) Toggle a report schedule.

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>>

deleteReportSchedule

public ReportScheduleResponse deleteReportSchedule(UUID scheduleUuid)
                                            throws ApiException

Delete a report schedule.

See deleteReportScheduleWithHttpInfo(java.util.UUID).

Parameters:

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

Returns:

ReportScheduleResponse

Throws:

ApiException - if fails to make API call

deleteReportScheduleAsync

public CompletableFuture<ReportScheduleResponse> deleteReportScheduleAsync(UUID scheduleUuid)

Delete a report schedule.

See deleteReportScheduleWithHttpInfoAsync(java.util.UUID).

Parameters:

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

Returns:

CompletableFuture<ReportScheduleResponse>

deleteReportScheduleWithHttpInfo

public ApiResponse<ReportScheduleResponse> deleteReportScheduleWithHttpInfo(UUID scheduleUuid)
                                                                     throws ApiException

Delete a report schedule by its unique identifier. The response returns the deleted schedule. Requires a reporting write permission appropriate to the targeted resource type and schedule ownership.

Parameters:

scheduleUuid - The unique identifier of the report schedule to delete. (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	-

deleteReportScheduleWithHttpInfoAsync

public CompletableFuture<ApiResponse<ReportScheduleResponse>> deleteReportScheduleWithHttpInfoAsync(UUID scheduleUuid)

Delete a report schedule.

See deleteReportScheduleWithHttpInfo(java.util.UUID).

Parameters:

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

Returns:

CompletableFuture<ApiResponse<ReportScheduleResponse>>

getReportSchedule

public ReportScheduleResponse getReportSchedule(UUID scheduleUuid)
                                         throws ApiException

Get a report schedule.

See getReportScheduleWithHttpInfo(java.util.UUID).

Parameters:

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

Returns:

ReportScheduleResponse

Throws:

ApiException - if fails to make API call

getReportScheduleAsync

public CompletableFuture<ReportScheduleResponse> getReportScheduleAsync(UUID scheduleUuid)

Get a report schedule.

See getReportScheduleWithHttpInfoAsync(java.util.UUID).

Parameters:

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

Returns:

CompletableFuture<ReportScheduleResponse>

getReportScheduleWithHttpInfo

public ApiResponse<ReportScheduleResponse> getReportScheduleWithHttpInfo(UUID scheduleUuid)
                                                                  throws ApiException

Get a report schedule by its unique identifier. Requires a reporting read permission appropriate to the targeted resource type.

Parameters:

scheduleUuid - The unique identifier of the report schedule to fetch. (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	-

getReportScheduleWithHttpInfoAsync

public CompletableFuture<ApiResponse<ReportScheduleResponse>> getReportScheduleWithHttpInfoAsync(UUID scheduleUuid)

Get a report schedule.

See getReportScheduleWithHttpInfo(java.util.UUID).

Parameters:

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

Returns:

CompletableFuture<ApiResponse<ReportScheduleResponse>>

getReportSchedulesForResource

public ReportScheduleListResponse getReportSchedulesForResource(ReportScheduleResourceType resourceType,
                                                                String resourceId)
                                                         throws ApiException

Get report schedules for a resource.

See getReportSchedulesForResourceWithHttpInfo(com.datadog.api.client.v2.model.ReportScheduleResourceType, java.lang.String).

Parameters:

resourceType - The type of resource to fetch report schedules for. (required)

resourceId - The identifier of the resource to fetch report schedules for. (required)

Returns:

ReportScheduleListResponse

Throws:

ApiException - if fails to make API call

getReportSchedulesForResourceAsync

public CompletableFuture<ReportScheduleListResponse> getReportSchedulesForResourceAsync(ReportScheduleResourceType resourceType,
                                                                                        String resourceId)

Get report schedules for a resource.

See getReportSchedulesForResourceWithHttpInfoAsync(com.datadog.api.client.v2.model.ReportScheduleResourceType, java.lang.String).

Parameters:

resourceType - The type of resource to fetch report schedules for. (required)

resourceId - The identifier of the resource to fetch report schedules for. (required)

Returns:

CompletableFuture<ReportScheduleListResponse>

getReportSchedulesForResourceWithHttpInfo

public ApiResponse<ReportScheduleListResponse> getReportSchedulesForResourceWithHttpInfo(ReportScheduleResourceType resourceType,
                                                                                         String resourceId)
                                                                                  throws ApiException

Get all report schedules that target a dashboard or integration dashboard resource. Requires a reporting read permission appropriate to the targeted resource type.

Parameters:

resourceType - The type of resource to fetch report schedules for. (required)

resourceId - The identifier of the resource to fetch report schedules for. (required)

Returns:

ApiResponse<ReportScheduleListResponse>

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	-

getReportSchedulesForResourceWithHttpInfoAsync

public CompletableFuture<ApiResponse<ReportScheduleListResponse>> getReportSchedulesForResourceWithHttpInfoAsync(ReportScheduleResourceType resourceType,
                                                                                                                 String resourceId)

Get report schedules for a resource.

See getReportSchedulesForResourceWithHttpInfo(com.datadog.api.client.v2.model.ReportScheduleResourceType, java.lang.String).

Parameters:

resourceType - The type of resource to fetch report schedules for. (required)

resourceId - The identifier of the resource to fetch report schedules for. (required)

Returns:

CompletableFuture<ApiResponse<ReportScheduleListResponse>>

listDatasetReportSchedules

public DatasetReportScheduleListResponse listDatasetReportSchedules(String datasetId)
                                                             throws ApiException

List dataset report schedules.

See listDatasetReportSchedulesWithHttpInfo(java.lang.String).

Parameters:

datasetId - The identifier of the published dataset to retrieve report schedules for. (required)

Returns:

DatasetReportScheduleListResponse

Throws:

ApiException - if fails to make API call

listDatasetReportSchedulesAsync

public CompletableFuture<DatasetReportScheduleListResponse> listDatasetReportSchedulesAsync(String datasetId)

List dataset report schedules.

See listDatasetReportSchedulesWithHttpInfoAsync(java.lang.String).

Parameters:

datasetId - The identifier of the published dataset to retrieve report schedules for. (required)

Returns:

CompletableFuture<DatasetReportScheduleListResponse>

listDatasetReportSchedulesWithHttpInfo

public ApiResponse<DatasetReportScheduleListResponse> listDatasetReportSchedulesWithHttpInfo(String datasetId)
                                                                                      throws ApiException

Retrieve all report schedules for a given published dataset. Returns report schedules belonging to the authenticated user's organization that target the specified dataset. Requires the generate_log_reports or manage_log_reports permission.

Parameters:

datasetId - The identifier of the published dataset to retrieve report schedules for. (required)

Returns:

ApiResponse<DatasetReportScheduleListResponse>

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	-

listDatasetReportSchedulesWithHttpInfoAsync

public CompletableFuture<ApiResponse<DatasetReportScheduleListResponse>> listDatasetReportSchedulesWithHttpInfoAsync(String datasetId)

List dataset report schedules.

See listDatasetReportSchedulesWithHttpInfo(java.lang.String).

Parameters:

datasetId - The identifier of the published dataset to retrieve report schedules for. (required)

Returns:

CompletableFuture<ApiResponse<DatasetReportScheduleListResponse>>

listReportSchedules

public ReportScheduleListResponse listReportSchedules()
                                               throws ApiException

List report schedules.

See listReportSchedulesWithHttpInfo(com.datadog.api.client.v2.api.ReportSchedulesApi.ListReportSchedulesOptionalParameters).

Returns:

ReportScheduleListResponse

Throws:

ApiException - if fails to make API call

listReportSchedulesAsync

public CompletableFuture<ReportScheduleListResponse> listReportSchedulesAsync()

List report schedules.

See listReportSchedulesWithHttpInfoAsync(com.datadog.api.client.v2.api.ReportSchedulesApi.ListReportSchedulesOptionalParameters).

Returns:

CompletableFuture<ReportScheduleListResponse>

listReportSchedules

public ReportScheduleListResponse listReportSchedules(ReportSchedulesApi.ListReportSchedulesOptionalParameters parameters)
                                               throws ApiException

List report schedules.

See listReportSchedulesWithHttpInfo(com.datadog.api.client.v2.api.ReportSchedulesApi.ListReportSchedulesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

ReportScheduleListResponse

Throws:

ApiException - if fails to make API call

listReportSchedulesAsync

public CompletableFuture<ReportScheduleListResponse> listReportSchedulesAsync(ReportSchedulesApi.ListReportSchedulesOptionalParameters parameters)

List report schedules.

See listReportSchedulesWithHttpInfoAsync(com.datadog.api.client.v2.api.ReportSchedulesApi.ListReportSchedulesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ReportScheduleListResponse>

listReportSchedulesWithHttpInfo

public ApiResponse<ReportScheduleListResponse> listReportSchedulesWithHttpInfo(ReportSchedulesApi.ListReportSchedulesOptionalParameters parameters)
                                                                        throws ApiException

List dashboard and integration dashboard report schedules for the organization. The response is paginated and can be filtered by title, author UUID, or recipients. Requires the generate_dashboard_reports permission.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<ReportScheduleListResponse>

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	-

listReportSchedulesWithHttpInfoAsync

public CompletableFuture<ApiResponse<ReportScheduleListResponse>> listReportSchedulesWithHttpInfoAsync(ReportSchedulesApi.ListReportSchedulesOptionalParameters parameters)

List report schedules.

See listReportSchedulesWithHttpInfo(com.datadog.api.client.v2.api.ReportSchedulesApi.ListReportSchedulesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ReportScheduleListResponse>>

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>>

printReport

public PrintReportResponse printReport(PrintReportRequest body)
                                throws ApiException

Print a report.

See printReportWithHttpInfo(com.datadog.api.client.v2.model.PrintReportRequest).

Parameters:

body - (required)

Returns:

PrintReportResponse

Throws:

ApiException - if fails to make API call

printReportAsync

public CompletableFuture<PrintReportResponse> printReportAsync(PrintReportRequest body)

Print a report.

See printReportWithHttpInfoAsync(com.datadog.api.client.v2.model.PrintReportRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<PrintReportResponse>

printReportWithHttpInfo

public ApiResponse<PrintReportResponse> printReportWithHttpInfo(PrintReportRequest body)
                                                         throws ApiException

Initiate a one-off, print-only report for a dashboard or integration dashboard. The report is rendered as a PDF and made available for download through the URL returned in the response. Requires a reporting permission appropriate to the targeted resource type.

Parameters:

body - (required)

Returns:

ApiResponse<PrintReportResponse>

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	-
422	Unprocessable Entity	-
429	Too many requests	-

printReportWithHttpInfoAsync

public CompletableFuture<ApiResponse<PrintReportResponse>> printReportWithHttpInfoAsync(PrintReportRequest body)

Print a report.

See printReportWithHttpInfo(com.datadog.api.client.v2.model.PrintReportRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<PrintReportResponse>>

toggleReportSchedule

public ReportScheduleResponse toggleReportSchedule(UUID scheduleUuid,
                                                   ReportScheduleToggleRequest body)
                                            throws ApiException

Toggle a report schedule.

See toggleReportScheduleWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.ReportScheduleToggleRequest).

Parameters:

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

body - (required)

Returns:

ReportScheduleResponse

Throws:

ApiException - if fails to make API call

toggleReportScheduleAsync

public CompletableFuture<ReportScheduleResponse> toggleReportScheduleAsync(UUID scheduleUuid,
                                                                           ReportScheduleToggleRequest body)

Toggle a report schedule.

See toggleReportScheduleWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.model.ReportScheduleToggleRequest).

Parameters:

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

body - (required)

Returns:

CompletableFuture<ReportScheduleResponse>

toggleReportScheduleWithHttpInfo

public ApiResponse<ReportScheduleResponse> toggleReportScheduleWithHttpInfo(UUID scheduleUuid,
                                                                            ReportScheduleToggleRequest body)
                                                                     throws ApiException

Activate or pause a report schedule by setting its status to active or inactive. Requires a reporting write permission appropriate to the targeted resource type and schedule ownership.

Parameters:

scheduleUuid - The unique identifier of the report schedule to toggle. (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	-

toggleReportScheduleWithHttpInfoAsync

public CompletableFuture<ApiResponse<ReportScheduleResponse>> toggleReportScheduleWithHttpInfoAsync(UUID scheduleUuid,
                                                                                                    ReportScheduleToggleRequest body)

Toggle a report schedule.

See toggleReportScheduleWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.ReportScheduleToggleRequest).

Parameters:

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

body - (required)

Returns:

CompletableFuture<ApiResponse<ReportScheduleResponse>>