com.datadog.api.client.v2.api

Class ComplianceApi

java.lang.Object

com.datadog.api.client.v2.api.ComplianceApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComplianceApi.GetRuleBasedViewOptionalParameters Manage optional parameters to getRuleBasedView.

Constructor Summary

Constructors

Constructor and Description
ComplianceApi()
ComplianceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient() Get the API client.
RuleBasedViewResponse	getRuleBasedView(Long to) Get the rule-based view of compliance findings.
RuleBasedViewResponse	getRuleBasedView(Long to, ComplianceApi.GetRuleBasedViewOptionalParameters parameters) Get the rule-based view of compliance findings.
CompletableFuture<RuleBasedViewResponse>	getRuleBasedViewAsync(Long to) Get the rule-based view of compliance findings.
CompletableFuture<RuleBasedViewResponse>	getRuleBasedViewAsync(Long to, ComplianceApi.GetRuleBasedViewOptionalParameters parameters) Get the rule-based view of compliance findings.
ApiResponse<RuleBasedViewResponse>	getRuleBasedViewWithHttpInfo(Long to, ComplianceApi.GetRuleBasedViewOptionalParameters parameters) Get an aggregated view of compliance rules with their pass, fail, and muted finding counts.
CompletableFuture<ApiResponse<RuleBasedViewResponse>>	getRuleBasedViewWithHttpInfoAsync(Long to, ComplianceApi.GetRuleBasedViewOptionalParameters parameters) Get the rule-based view of compliance findings.
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

ComplianceApi

public ComplianceApi()

ComplianceApi

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

getRuleBasedView

public RuleBasedViewResponse getRuleBasedView(Long to)
                                       throws ApiException

Get the rule-based view of compliance findings.

See getRuleBasedViewWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.api.ComplianceApi.GetRuleBasedViewOptionalParameters).

Parameters:

to - Timestamp of the query end, in milliseconds since the Unix epoch. (required)

Returns:

RuleBasedViewResponse

Throws:

ApiException - if fails to make API call

getRuleBasedViewAsync

public CompletableFuture<RuleBasedViewResponse> getRuleBasedViewAsync(Long to)

Get the rule-based view of compliance findings.

See getRuleBasedViewWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v2.api.ComplianceApi.GetRuleBasedViewOptionalParameters).

Parameters:

to - Timestamp of the query end, in milliseconds since the Unix epoch. (required)

Returns:

CompletableFuture<RuleBasedViewResponse>

getRuleBasedView

public RuleBasedViewResponse getRuleBasedView(Long to,
                                              ComplianceApi.GetRuleBasedViewOptionalParameters parameters)
                                       throws ApiException

Get the rule-based view of compliance findings.

See getRuleBasedViewWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.api.ComplianceApi.GetRuleBasedViewOptionalParameters).

Parameters:

to - Timestamp of the query end, in milliseconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

RuleBasedViewResponse

Throws:

ApiException - if fails to make API call

getRuleBasedViewAsync

public CompletableFuture<RuleBasedViewResponse> getRuleBasedViewAsync(Long to,
                                                                      ComplianceApi.GetRuleBasedViewOptionalParameters parameters)

Get the rule-based view of compliance findings.

See getRuleBasedViewWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v2.api.ComplianceApi.GetRuleBasedViewOptionalParameters).

Parameters:

to - Timestamp of the query end, in milliseconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<RuleBasedViewResponse>

getRuleBasedViewWithHttpInfo

public ApiResponse<RuleBasedViewResponse> getRuleBasedViewWithHttpInfo(Long to,
                                                                       ComplianceApi.GetRuleBasedViewOptionalParameters parameters)
                                                                throws ApiException

Get an aggregated view of compliance rules with their pass, fail, and muted finding counts. Supports filtering by compliance framework, framework version, and additional query filters.

Parameters:

to - Timestamp of the query end, in milliseconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<RuleBasedViewResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-
503	Service Unavailable	-

getRuleBasedViewWithHttpInfoAsync

public CompletableFuture<ApiResponse<RuleBasedViewResponse>> getRuleBasedViewWithHttpInfoAsync(Long to,
                                                                                               ComplianceApi.GetRuleBasedViewOptionalParameters parameters)

Get the rule-based view of compliance findings.

See getRuleBasedViewWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.api.ComplianceApi.GetRuleBasedViewOptionalParameters).

Parameters:

to - Timestamp of the query end, in milliseconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<RuleBasedViewResponse>>