Class ServiceLevelObjectivesApi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classManage optional parameters to deleteSLO.static classManage optional parameters to getSLOHistory.static classManage optional parameters to getSLO.static classManage optional parameters to listSLOs.static classManage optional parameters to searchSLO. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncheckCanDeleteSLO(String ids) Check if SLOs can be safely deleted.Check if SLOs can be safely deleted.Check if an SLO can be safely deleted.Check if SLOs can be safely deleted.Create an SLO object.Create an SLO object.Create a service level objective object.Create an SLO object.Delete an SLO.deleteSLO(String sloId, ServiceLevelObjectivesApi.DeleteSLOOptionalParameters parameters) Delete an SLO.deleteSLOAsync(String sloId) Delete an SLO.deleteSLOAsync(String sloId, ServiceLevelObjectivesApi.DeleteSLOOptionalParameters parameters) Delete an SLO.Bulk Delete SLO Timeframes.Bulk Delete SLO Timeframes.Delete (or partially delete) multiple service level objective objects.Bulk Delete SLO Timeframes.deleteSLOWithHttpInfo(String sloId, ServiceLevelObjectivesApi.DeleteSLOOptionalParameters parameters) Permanently delete the specified service level objective object.deleteSLOWithHttpInfoAsync(String sloId, ServiceLevelObjectivesApi.DeleteSLOOptionalParameters parameters) Delete an SLO.Get the API client.Get an SLO's details.getSLO(String sloId, ServiceLevelObjectivesApi.GetSLOOptionalParameters parameters) Get an SLO's details.getSLOAsync(String sloId) Get an SLO's details.getSLOAsync(String sloId, ServiceLevelObjectivesApi.GetSLOOptionalParameters parameters) Get an SLO's details.getSLOCorrections(String sloId) Get Corrections For an SLO.getSLOCorrectionsAsync(String sloId) Get Corrections For an SLO.Get corrections applied to an SLOGet Corrections For an SLO.getSLOHistory(String sloId, Long fromTs, Long toTs) Get an SLO's history.getSLOHistory(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSLOHistoryOptionalParameters parameters) Get an SLO's history.getSLOHistoryAsync(String sloId, Long fromTs, Long toTs) Get an SLO's history.getSLOHistoryAsync(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSLOHistoryOptionalParameters parameters) Get an SLO's history.getSLOHistoryWithHttpInfo(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSLOHistoryOptionalParameters parameters) Get a specific SLO’s history, regardless of its SLO type.getSLOHistoryWithHttpInfoAsync(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSLOHistoryOptionalParameters parameters) Get an SLO's history.getSLOWithHttpInfo(String sloId, ServiceLevelObjectivesApi.GetSLOOptionalParameters parameters) Get a service level objective object.getSLOWithHttpInfoAsync(String sloId, ServiceLevelObjectivesApi.GetSLOOptionalParameters parameters) Get an SLO's details.listSLOs()Get all SLOs.Get all SLOs.Get all SLOs.Get all SLOs.Get a list of service level objective objects for your organization.Get all SLOs.Get all SLOs.Get all SLOs.Search for SLOs.Search for SLOs.Search for SLOs.Search for SLOs.Get a list of service level objective objects for your organization.Search for SLOs.voidsetApiClient(ApiClient apiClient) Set the API client.updateSLO(String sloId, ServiceLevelObjective body) Update an SLO.updateSLOAsync(String sloId, ServiceLevelObjective body) Update an SLO.updateSLOWithHttpInfo(String sloId, ServiceLevelObjective body) Update the specified service level objective object.updateSLOWithHttpInfoAsync(String sloId, ServiceLevelObjective body) Update an SLO.
-
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
-
checkCanDeleteSLO
Check if SLOs can be safely deleted.- Parameters:
ids- A comma separated list of the IDs of the service level objectives objects. (required)- Returns:
- CheckCanDeleteSLOResponse
- Throws:
ApiException- if fails to make API call
-
checkCanDeleteSLOAsync
Check if SLOs can be safely deleted.- Parameters:
ids- A comma separated list of the IDs of the service level objectives objects. (required)- Returns:
- CompletableFuture<CheckCanDeleteSLOResponse>
-
checkCanDeleteSLOWithHttpInfo
public ApiResponse<CheckCanDeleteSLOResponse> checkCanDeleteSLOWithHttpInfo(String ids) throws ApiException Check if an SLO can be safely deleted. For example, assure an SLO can be deleted without disrupting a dashboard.- Parameters:
ids- A comma separated list of the IDs of the service level objectives objects. (required)- Returns:
- ApiResponse<CheckCanDeleteSLOResponse>
- 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 - 409 Conflict - 429 Too many requests -
-
checkCanDeleteSLOWithHttpInfoAsync
public CompletableFuture<ApiResponse<CheckCanDeleteSLOResponse>> checkCanDeleteSLOWithHttpInfoAsync(String ids) Check if SLOs can be safely deleted.- Parameters:
ids- A comma separated list of the IDs of the service level objectives objects. (required)- Returns:
- CompletableFuture<ApiResponse<CheckCanDeleteSLOResponse>>
-
createSLO
Create an SLO object.See
createSLOWithHttpInfo(com.datadog.api.client.v1.model.ServiceLevelObjectiveRequest).- Parameters:
body- Service level objective request object. (required)- Returns:
- SLOListResponse
- Throws:
ApiException- if fails to make API call
-
createSLOAsync
Create an SLO object.See
createSLOWithHttpInfoAsync(com.datadog.api.client.v1.model.ServiceLevelObjectiveRequest).- Parameters:
body- Service level objective request object. (required)- Returns:
- CompletableFuture<SLOListResponse>
-
createSLOWithHttpInfo
public ApiResponse<SLOListResponse> createSLOWithHttpInfo(ServiceLevelObjectiveRequest body) throws ApiException Create a service level objective object.- Parameters:
body- Service level objective request object. (required)- Returns:
- ApiResponse<SLOListResponse>
- 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 -
-
createSLOWithHttpInfoAsync
public CompletableFuture<ApiResponse<SLOListResponse>> createSLOWithHttpInfoAsync(ServiceLevelObjectiveRequest body) Create an SLO object.See
createSLOWithHttpInfo(com.datadog.api.client.v1.model.ServiceLevelObjectiveRequest).- Parameters:
body- Service level objective request object. (required)- Returns:
- CompletableFuture<ApiResponse<SLOListResponse>>
-
deleteSLO
Delete an SLO.- Parameters:
sloId- The ID of the service level objective. (required)- Returns:
- SLODeleteResponse
- Throws:
ApiException- if fails to make API call
-
deleteSLOAsync
Delete an SLO.- Parameters:
sloId- The ID of the service level objective. (required)- Returns:
- CompletableFuture<SLODeleteResponse>
-
deleteSLO
public SLODeleteResponse deleteSLO(String sloId, ServiceLevelObjectivesApi.DeleteSLOOptionalParameters parameters) throws ApiException Delete an SLO.- Parameters:
sloId- The ID of the service level objective. (required)parameters- Optional parameters for the request.- Returns:
- SLODeleteResponse
- Throws:
ApiException- if fails to make API call
-
deleteSLOAsync
public CompletableFuture<SLODeleteResponse> deleteSLOAsync(String sloId, ServiceLevelObjectivesApi.DeleteSLOOptionalParameters parameters) Delete an SLO.- Parameters:
sloId- The ID of the service level objective. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<SLODeleteResponse>
-
deleteSLOWithHttpInfo
public ApiResponse<SLODeleteResponse> deleteSLOWithHttpInfo(String sloId, ServiceLevelObjectivesApi.DeleteSLOOptionalParameters parameters) throws ApiException Permanently delete the specified service level objective object.If an SLO is used in a dashboard, the
DELETE /v1/slo/endpoint returns a 409 conflict error because the SLO is referenced in a dashboard.- Parameters:
sloId- The ID of the service level objective. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<SLODeleteResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 Not found - 409 Conflict - 429 Too many requests -
-
deleteSLOWithHttpInfoAsync
public CompletableFuture<ApiResponse<SLODeleteResponse>> deleteSLOWithHttpInfoAsync(String sloId, ServiceLevelObjectivesApi.DeleteSLOOptionalParameters parameters) Delete an SLO.- Parameters:
sloId- The ID of the service level objective. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<SLODeleteResponse>>
-
deleteSLOTimeframeInBulk
public SLOBulkDeleteResponse deleteSLOTimeframeInBulk(Map<String, List<SLOTimeframe>> body) throws ApiExceptionBulk Delete SLO Timeframes.- Parameters:
body- Delete multiple service level objective objects request body. (required)- Returns:
- SLOBulkDeleteResponse
- Throws:
ApiException- if fails to make API call
-
deleteSLOTimeframeInBulkAsync
public CompletableFuture<SLOBulkDeleteResponse> deleteSLOTimeframeInBulkAsync(Map<String, List<SLOTimeframe>> body) Bulk Delete SLO Timeframes.- Parameters:
body- Delete multiple service level objective objects request body. (required)- Returns:
- CompletableFuture<SLOBulkDeleteResponse>
-
deleteSLOTimeframeInBulkWithHttpInfo
public ApiResponse<SLOBulkDeleteResponse> deleteSLOTimeframeInBulkWithHttpInfo(Map<String, List<SLOTimeframe>> body) throws ApiExceptionDelete (or partially delete) multiple service level objective objects.This endpoint facilitates deletion of one or more thresholds for one or more service level objective objects. If all thresholds are deleted, the service level objective object is deleted as well.
- Parameters:
body- Delete multiple service level objective objects request body. (required)- Returns:
- ApiResponse<SLOBulkDeleteResponse>
- 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 -
-
deleteSLOTimeframeInBulkWithHttpInfoAsync
public CompletableFuture<ApiResponse<SLOBulkDeleteResponse>> deleteSLOTimeframeInBulkWithHttpInfoAsync(Map<String, List<SLOTimeframe>> body) Bulk Delete SLO Timeframes.- Parameters:
body- Delete multiple service level objective objects request body. (required)- Returns:
- CompletableFuture<ApiResponse<SLOBulkDeleteResponse>>
-
getSLO
Get an SLO's details.- Parameters:
sloId- The ID of the service level objective object. (required)- Returns:
- SLOResponse
- Throws:
ApiException- if fails to make API call
-
getSLOAsync
Get an SLO's details.- Parameters:
sloId- The ID of the service level objective object. (required)- Returns:
- CompletableFuture<SLOResponse>
-
getSLO
public SLOResponse getSLO(String sloId, ServiceLevelObjectivesApi.GetSLOOptionalParameters parameters) throws ApiException Get an SLO's details.- Parameters:
sloId- The ID of the service level objective object. (required)parameters- Optional parameters for the request.- Returns:
- SLOResponse
- Throws:
ApiException- if fails to make API call
-
getSLOAsync
public CompletableFuture<SLOResponse> getSLOAsync(String sloId, ServiceLevelObjectivesApi.GetSLOOptionalParameters parameters) Get an SLO's details.- Parameters:
sloId- The ID of the service level objective object. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<SLOResponse>
-
getSLOWithHttpInfo
public ApiResponse<SLOResponse> getSLOWithHttpInfo(String sloId, ServiceLevelObjectivesApi.GetSLOOptionalParameters parameters) throws ApiException Get a service level objective object.- Parameters:
sloId- The ID of the service level objective object. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<SLOResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 Not found - 429 Too many requests -
-
getSLOWithHttpInfoAsync
public CompletableFuture<ApiResponse<SLOResponse>> getSLOWithHttpInfoAsync(String sloId, ServiceLevelObjectivesApi.GetSLOOptionalParameters parameters) Get an SLO's details.- Parameters:
sloId- The ID of the service level objective object. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<SLOResponse>>
-
getSLOCorrections
Get Corrections For an SLO.- Parameters:
sloId- The ID of the service level objective object. (required)- Returns:
- SLOCorrectionListResponse
- Throws:
ApiException- if fails to make API call
-
getSLOCorrectionsAsync
Get Corrections For an SLO.- Parameters:
sloId- The ID of the service level objective object. (required)- Returns:
- CompletableFuture<SLOCorrectionListResponse>
-
getSLOCorrectionsWithHttpInfo
public ApiResponse<SLOCorrectionListResponse> getSLOCorrectionsWithHttpInfo(String sloId) throws ApiException Get corrections applied to an SLO- Parameters:
sloId- The ID of the service level objective object. (required)- Returns:
- ApiResponse<SLOCorrectionListResponse>
- 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 -
-
getSLOCorrectionsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SLOCorrectionListResponse>> getSLOCorrectionsWithHttpInfoAsync(String sloId) Get Corrections For an SLO.- Parameters:
sloId- The ID of the service level objective object. (required)- Returns:
- CompletableFuture<ApiResponse<SLOCorrectionListResponse>>
-
getSLOHistory
Get an SLO's history.- Parameters:
sloId- The ID of the service level objective object. (required)fromTs- Thefromtimestamp for the query window in epoch seconds. (required)toTs- Thetotimestamp for the query window in epoch seconds. (required)- Returns:
- SLOHistoryResponse
- Throws:
ApiException- if fails to make API call
-
getSLOHistoryAsync
public CompletableFuture<SLOHistoryResponse> getSLOHistoryAsync(String sloId, Long fromTs, Long toTs) Get an SLO's history.- Parameters:
sloId- The ID of the service level objective object. (required)fromTs- Thefromtimestamp for the query window in epoch seconds. (required)toTs- Thetotimestamp for the query window in epoch seconds. (required)- Returns:
- CompletableFuture<SLOHistoryResponse>
-
getSLOHistory
public SLOHistoryResponse getSLOHistory(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSLOHistoryOptionalParameters parameters) throws ApiException Get an SLO's history.- Parameters:
sloId- The ID of the service level objective object. (required)fromTs- Thefromtimestamp for the query window in epoch seconds. (required)toTs- Thetotimestamp for the query window in epoch seconds. (required)parameters- Optional parameters for the request.- Returns:
- SLOHistoryResponse
- Throws:
ApiException- if fails to make API call
-
getSLOHistoryAsync
public CompletableFuture<SLOHistoryResponse> getSLOHistoryAsync(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSLOHistoryOptionalParameters parameters) Get an SLO's history.- Parameters:
sloId- The ID of the service level objective object. (required)fromTs- Thefromtimestamp for the query window in epoch seconds. (required)toTs- Thetotimestamp for the query window in epoch seconds. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<SLOHistoryResponse>
-
getSLOHistoryWithHttpInfo
public ApiResponse<SLOHistoryResponse> getSLOHistoryWithHttpInfo(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSLOHistoryOptionalParameters parameters) throws ApiException Get a specific SLO’s history, regardless of its SLO type.The detailed history data is structured according to the source data type. For example, metric data is included for event SLOs that use the metric source, and monitor SLO types include the monitor transition history.
Note: There are different response formats for event based and time based SLOs. Examples of both are shown.
- Parameters:
sloId- The ID of the service level objective object. (required)fromTs- Thefromtimestamp for the query window in epoch seconds. (required)toTs- Thetotimestamp for the query window in epoch seconds. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<SLOHistoryResponse>
- 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 -
-
getSLOHistoryWithHttpInfoAsync
public CompletableFuture<ApiResponse<SLOHistoryResponse>> getSLOHistoryWithHttpInfoAsync(String sloId, Long fromTs, Long toTs, ServiceLevelObjectivesApi.GetSLOHistoryOptionalParameters parameters) Get an SLO's history.- Parameters:
sloId- The ID of the service level objective object. (required)fromTs- Thefromtimestamp for the query window in epoch seconds. (required)toTs- Thetotimestamp for the query window in epoch seconds. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<SLOHistoryResponse>>
-
listSLOs
Get all SLOs.- Returns:
- SLOListResponse
- Throws:
ApiException- if fails to make API call
-
listSLOsAsync
Get all SLOs.- Returns:
- CompletableFuture<SLOListResponse>
-
listSLOs
public SLOListResponse listSLOs(ServiceLevelObjectivesApi.ListSLOsOptionalParameters parameters) throws ApiException Get all SLOs.- Parameters:
parameters- Optional parameters for the request.- Returns:
- SLOListResponse
- Throws:
ApiException- if fails to make API call
-
listSLOsAsync
public CompletableFuture<SLOListResponse> listSLOsAsync(ServiceLevelObjectivesApi.ListSLOsOptionalParameters parameters) Get all SLOs.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<SLOListResponse>
-
listSLOsWithPagination
Get all SLOs.- Returns:
- PaginationIterable<ServiceLevelObjective>
-
listSLOsWithPagination
public PaginationIterable<ServiceLevelObjective> listSLOsWithPagination(ServiceLevelObjectivesApi.ListSLOsOptionalParameters parameters) Get all SLOs.- Returns:
- SLOListResponse
-
listSLOsWithHttpInfo
public ApiResponse<SLOListResponse> listSLOsWithHttpInfo(ServiceLevelObjectivesApi.ListSLOsOptionalParameters parameters) throws ApiException Get a list of service level objective objects for your organization.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<SLOListResponse>
- 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 -
-
listSLOsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SLOListResponse>> listSLOsWithHttpInfoAsync(ServiceLevelObjectivesApi.ListSLOsOptionalParameters parameters) Get all SLOs.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<SLOListResponse>>
-
searchSLO
Search for SLOs.- Returns:
- SearchSLOResponse
- Throws:
ApiException- if fails to make API call
-
searchSLOAsync
Search for SLOs.- Returns:
- CompletableFuture<SearchSLOResponse>
-
searchSLO
public SearchSLOResponse searchSLO(ServiceLevelObjectivesApi.SearchSLOOptionalParameters parameters) throws ApiException Search for SLOs.- Parameters:
parameters- Optional parameters for the request.- Returns:
- SearchSLOResponse
- Throws:
ApiException- if fails to make API call
-
searchSLOAsync
public CompletableFuture<SearchSLOResponse> searchSLOAsync(ServiceLevelObjectivesApi.SearchSLOOptionalParameters parameters) Search for SLOs.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<SearchSLOResponse>
-
searchSLOWithHttpInfo
public ApiResponse<SearchSLOResponse> searchSLOWithHttpInfo(ServiceLevelObjectivesApi.SearchSLOOptionalParameters parameters) throws ApiException Get a list of service level objective objects for your organization.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<SearchSLOResponse>
- 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 -
-
searchSLOWithHttpInfoAsync
public CompletableFuture<ApiResponse<SearchSLOResponse>> searchSLOWithHttpInfoAsync(ServiceLevelObjectivesApi.SearchSLOOptionalParameters parameters) Search for SLOs.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<SearchSLOResponse>>
-
updateSLO
Update an SLO.See
updateSLOWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.ServiceLevelObjective).- Parameters:
sloId- The ID of the service level objective object. (required)body- The edited service level objective request object. (required)- Returns:
- SLOListResponse
- Throws:
ApiException- if fails to make API call
-
updateSLOAsync
Update an SLO.See
updateSLOWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.ServiceLevelObjective).- Parameters:
sloId- The ID of the service level objective object. (required)body- The edited service level objective request object. (required)- Returns:
- CompletableFuture<SLOListResponse>
-
updateSLOWithHttpInfo
public ApiResponse<SLOListResponse> updateSLOWithHttpInfo(String sloId, ServiceLevelObjective body) throws ApiException Update the specified service level objective object.- Parameters:
sloId- The ID of the service level objective object. (required)body- The edited service level objective request object. (required)- Returns:
- ApiResponse<SLOListResponse>
- 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 -
-
updateSLOWithHttpInfoAsync
public CompletableFuture<ApiResponse<SLOListResponse>> updateSLOWithHttpInfoAsync(String sloId, ServiceLevelObjective body) Update an SLO.See
updateSLOWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.ServiceLevelObjective).- Parameters:
sloId- The ID of the service level objective object. (required)body- The edited service level objective request object. (required)- Returns:
- CompletableFuture<ApiResponse<SLOListResponse>>
-