com.datadog.api.client.v2.api

Class ServiceLevelObjectivesApi

java.lang.Object

com.datadog.api.client.v2.api.ServiceLevelObjectivesApi

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

Constructor Summary

Constructors

Constructor and Description
ServiceLevelObjectivesApi()
ServiceLevelObjectivesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
SLOReportPostResponse	createSLOReportJob(SloReportCreateRequest body) Create a new SLO report.
CompletableFuture<SLOReportPostResponse>	createSLOReportJobAsync(SloReportCreateRequest body) Create a new SLO report.
ApiResponse<SLOReportPostResponse>	createSLOReportJobWithHttpInfo(SloReportCreateRequest body) Create a job to generate an SLO report.
CompletableFuture<ApiResponse<SLOReportPostResponse>>	createSLOReportJobWithHttpInfoAsync(SloReportCreateRequest body) Create a new SLO report.
ApiClient	getApiClient() Get the API client.
String	getSLOReport(String reportId) Get SLO report.
CompletableFuture<String>	getSLOReportAsync(String reportId) Get SLO report.
SLOReportStatusGetResponse	getSLOReportJobStatus(String reportId) Get SLO report status.
CompletableFuture<SLOReportStatusGetResponse>	getSLOReportJobStatusAsync(String reportId) Get SLO report status.
ApiResponse<SLOReportStatusGetResponse>	getSLOReportJobStatusWithHttpInfo(String reportId) Get the status of the SLO report job.
CompletableFuture<ApiResponse<SLOReportStatusGetResponse>>	getSLOReportJobStatusWithHttpInfoAsync(String reportId) Get SLO report status.
ApiResponse<String>	getSLOReportWithHttpInfo(String reportId) Download an SLO report.
CompletableFuture<ApiResponse<String>>	getSLOReportWithHttpInfoAsync(String reportId) Get SLO report.
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

ServiceLevelObjectivesApi

public ServiceLevelObjectivesApi()

ServiceLevelObjectivesApi

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

createSLOReportJob

public SLOReportPostResponse createSLOReportJob(SloReportCreateRequest body)
                                         throws ApiException

Create a new SLO report.

See createSLOReportJobWithHttpInfo(com.datadog.api.client.v2.model.SloReportCreateRequest).

Parameters:

body - Create SLO report job request body. (required)

Returns:

SLOReportPostResponse

Throws:

ApiException - if fails to make API call

createSLOReportJobAsync

public CompletableFuture<SLOReportPostResponse> createSLOReportJobAsync(SloReportCreateRequest body)

Create a new SLO report.

See createSLOReportJobWithHttpInfoAsync(com.datadog.api.client.v2.model.SloReportCreateRequest).

Parameters:

body - Create SLO report job request body. (required)

Returns:

CompletableFuture<SLOReportPostResponse>

createSLOReportJobWithHttpInfo

public ApiResponse<SLOReportPostResponse> createSLOReportJobWithHttpInfo(SloReportCreateRequest body)
                                                                  throws ApiException

Create a job to generate an SLO report. The report job is processed asynchronously and eventually results in a CSV report being available for download.

Check the status of the job and download the CSV report using the returned report_id .

Parameters:

body - Create SLO report job request body. (required)

Returns:

ApiResponse<SLOReportPostResponse>

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	-

createSLOReportJobWithHttpInfoAsync

public CompletableFuture<ApiResponse<SLOReportPostResponse>> createSLOReportJobWithHttpInfoAsync(SloReportCreateRequest body)

Create a new SLO report.

See createSLOReportJobWithHttpInfo(com.datadog.api.client.v2.model.SloReportCreateRequest).

Parameters:

body - Create SLO report job request body. (required)

Returns:

CompletableFuture<ApiResponse<SLOReportPostResponse>>

getSLOReport

public String getSLOReport(String reportId)
                    throws ApiException

Get SLO report.

See getSLOReportWithHttpInfo(java.lang.String).

Parameters:

reportId - The ID of the report job. (required)

Returns:

String

Throws:

ApiException - if fails to make API call

getSLOReportAsync

public CompletableFuture<String> getSLOReportAsync(String reportId)

Get SLO report.

See getSLOReportWithHttpInfoAsync(java.lang.String).

Parameters:

reportId - The ID of the report job. (required)

Returns:

CompletableFuture<String>

getSLOReportWithHttpInfo

public ApiResponse<String> getSLOReportWithHttpInfo(String reportId)
                                             throws ApiException

Download an SLO report. This can only be performed after the report job has completed.

Reports are not guaranteed to exist indefinitely. Datadog recommends that you download the report as soon as it is available.

Parameters:

reportId - The ID of the report job. (required)

Returns:

ApiResponse<String>

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	-

getSLOReportWithHttpInfoAsync

public CompletableFuture<ApiResponse<String>> getSLOReportWithHttpInfoAsync(String reportId)

Get SLO report.

See getSLOReportWithHttpInfo(java.lang.String).

Parameters:

reportId - The ID of the report job. (required)

Returns:

CompletableFuture<ApiResponse<String>>

getSLOReportJobStatus

public SLOReportStatusGetResponse getSLOReportJobStatus(String reportId)
                                                 throws ApiException

Get SLO report status.

See getSLOReportJobStatusWithHttpInfo(java.lang.String).

Parameters:

reportId - The ID of the report job. (required)

Returns:

SLOReportStatusGetResponse

Throws:

ApiException - if fails to make API call

getSLOReportJobStatusAsync

public CompletableFuture<SLOReportStatusGetResponse> getSLOReportJobStatusAsync(String reportId)

Get SLO report status.

See getSLOReportJobStatusWithHttpInfoAsync(java.lang.String).

Parameters:

reportId - The ID of the report job. (required)

Returns:

CompletableFuture<SLOReportStatusGetResponse>

getSLOReportJobStatusWithHttpInfo

public ApiResponse<SLOReportStatusGetResponse> getSLOReportJobStatusWithHttpInfo(String reportId)
                                                                          throws ApiException

Get the status of the SLO report job.

Parameters:

reportId - The ID of the report job. (required)

Returns:

ApiResponse<SLOReportStatusGetResponse>

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	-

getSLOReportJobStatusWithHttpInfoAsync

public CompletableFuture<ApiResponse<SLOReportStatusGetResponse>> getSLOReportJobStatusWithHttpInfoAsync(String reportId)

Get SLO report status.

See getSLOReportJobStatusWithHttpInfo(java.lang.String).

Parameters:

reportId - The ID of the report job. (required)

Returns:

CompletableFuture<ApiResponse<SLOReportStatusGetResponse>>