Package com.datadog.api.client.v2.api
Class ServiceLevelObjectivesApi
java.lang.Object
com.datadog.api.client.v2.api.ServiceLevelObjectivesApi
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class ServiceLevelObjectivesApi
extends Object
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classManage optional parameters to getSloStatus. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Deprecated.Deprecated.Deprecated.Get the API client.getSLOReport(String reportId) Deprecated.getSLOReportAsync(String reportId) Deprecated.getSLOReportJobStatus(String reportId) Deprecated.getSLOReportJobStatusAsync(String reportId) Deprecated.getSLOReportJobStatusWithHttpInfo(String reportId) Deprecated.getSLOReportJobStatusWithHttpInfoAsync(String reportId) Deprecated.getSLOReportWithHttpInfo(String reportId) Deprecated.getSLOReportWithHttpInfoAsync(String reportId) Deprecated.getSloStatus(String sloId, Long fromTs, Long toTs) Get SLO status.getSloStatus(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSloStatusOptionalParameters parameters) Get SLO status.getSloStatusAsync(String sloId, Long fromTs, Long toTs) Get SLO status.getSloStatusAsync(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSloStatusOptionalParameters parameters) Get SLO status.getSloStatusWithHttpInfo(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSloStatusOptionalParameters parameters) Get the status of a Service Level Objective (SLO) for a given time period.getSloStatusWithHttpInfoAsync(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSloStatusOptionalParameters parameters) Get SLO status.voidsetApiClient(ApiClient apiClient) Set the API client.
-
Constructor Details
-
ServiceLevelObjectivesApi
public ServiceLevelObjectivesApi() -
ServiceLevelObjectivesApi
-
-
Method Details
-
getApiClient
Get the API client.- Returns:
- API client
-
setApiClient
Set the API client.- Parameters:
apiClient- an instance of API client
-
createSLOReportJob
@Deprecated public SLOReportPostResponse createSLOReportJob(SloReportCreateRequest body) throws ApiException Deprecated.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
@Deprecated public CompletableFuture<SLOReportPostResponse> createSLOReportJobAsync(SloReportCreateRequest body) Deprecated.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
@Deprecated public ApiResponse<SLOReportPostResponse> createSLOReportJobWithHttpInfo(SloReportCreateRequest body) throws ApiException Deprecated.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
@Deprecated public CompletableFuture<ApiResponse<SLOReportPostResponse>> createSLOReportJobWithHttpInfoAsync(SloReportCreateRequest body) Deprecated.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
Deprecated.Get SLO report.- Parameters:
reportId- The ID of the report job. (required)- Returns:
- String
- Throws:
ApiException- if fails to make API call
-
getSLOReportAsync
Deprecated.Get SLO report.- Parameters:
reportId- The ID of the report job. (required)- Returns:
- CompletableFuture<String>
-
getSLOReportWithHttpInfo
@Deprecated public ApiResponse<String> getSLOReportWithHttpInfo(String reportId) throws ApiException Deprecated.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
@Deprecated public CompletableFuture<ApiResponse<String>> getSLOReportWithHttpInfoAsync(String reportId) Deprecated.Get SLO report.- Parameters:
reportId- The ID of the report job. (required)- Returns:
- CompletableFuture<ApiResponse<String>>
-
getSLOReportJobStatus
@Deprecated public SLOReportStatusGetResponse getSLOReportJobStatus(String reportId) throws ApiException Deprecated.Get SLO report status.- Parameters:
reportId- The ID of the report job. (required)- Returns:
- SLOReportStatusGetResponse
- Throws:
ApiException- if fails to make API call
-
getSLOReportJobStatusAsync
@Deprecated public CompletableFuture<SLOReportStatusGetResponse> getSLOReportJobStatusAsync(String reportId) Deprecated.Get SLO report status.See
getSLOReportJobStatusWithHttpInfoAsync(java.lang.String).- Parameters:
reportId- The ID of the report job. (required)- Returns:
- CompletableFuture<SLOReportStatusGetResponse>
-
getSLOReportJobStatusWithHttpInfo
@Deprecated public ApiResponse<SLOReportStatusGetResponse> getSLOReportJobStatusWithHttpInfo(String reportId) throws ApiException Deprecated.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
@Deprecated public CompletableFuture<ApiResponse<SLOReportStatusGetResponse>> getSLOReportJobStatusWithHttpInfoAsync(String reportId) Deprecated.Get SLO report status.- Parameters:
reportId- The ID of the report job. (required)- Returns:
- CompletableFuture<ApiResponse<SLOReportStatusGetResponse>>
-
getSloStatus
Get SLO status.- Parameters:
sloId- The ID of the SLO. (required)fromTs- The starting timestamp for the SLO status query in epoch seconds. (required)toTs- The ending timestamp for the SLO status query in epoch seconds. (required)- Returns:
- SloStatusResponse
- Throws:
ApiException- if fails to make API call
-
getSloStatusAsync
Get SLO status.- Parameters:
sloId- The ID of the SLO. (required)fromTs- The starting timestamp for the SLO status query in epoch seconds. (required)toTs- The ending timestamp for the SLO status query in epoch seconds. (required)- Returns:
- CompletableFuture<SloStatusResponse>
-
getSloStatus
public SloStatusResponse getSloStatus(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSloStatusOptionalParameters parameters) throws ApiException Get SLO status.- Parameters:
sloId- The ID of the SLO. (required)fromTs- The starting timestamp for the SLO status query in epoch seconds. (required)toTs- The ending timestamp for the SLO status query in epoch seconds. (required)parameters- Optional parameters for the request.- Returns:
- SloStatusResponse
- Throws:
ApiException- if fails to make API call
-
getSloStatusAsync
public CompletableFuture<SloStatusResponse> getSloStatusAsync(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSloStatusOptionalParameters parameters) Get SLO status.- Parameters:
sloId- The ID of the SLO. (required)fromTs- The starting timestamp for the SLO status query in epoch seconds. (required)toTs- The ending timestamp for the SLO status query in epoch seconds. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<SloStatusResponse>
-
getSloStatusWithHttpInfo
public ApiResponse<SloStatusResponse> getSloStatusWithHttpInfo(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSloStatusOptionalParameters parameters) throws ApiException Get the status of a Service Level Objective (SLO) for a given time period.This endpoint returns the current SLI value, error budget remaining, and other status information for the specified SLO.
- Parameters:
sloId- The ID of the SLO. (required)fromTs- The starting timestamp for the SLO status query in epoch seconds. (required)toTs- The ending timestamp for the SLO status query in epoch seconds. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<SloStatusResponse>
- 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 -
-
getSloStatusWithHttpInfoAsync
public CompletableFuture<ApiResponse<SloStatusResponse>> getSloStatusWithHttpInfoAsync(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSloStatusOptionalParameters parameters) Get SLO status.- Parameters:
sloId- The ID of the SLO. (required)fromTs- The starting timestamp for the SLO status query in epoch seconds. (required)toTs- The ending timestamp for the SLO status query in epoch seconds. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<SloStatusResponse>>
-