com.datadog.api.client.v2.api

Class EntityRiskScoresApi

java.lang.Object

com.datadog.api.client.v2.api.EntityRiskScoresApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters Manage optional parameters to listEntityRiskScores.

Constructor Summary

Constructors

Constructor and Description
EntityRiskScoresApi()
EntityRiskScoresApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient() Get the API client.
SecurityEntityRiskScoreResponse	getEntityRiskScore(String entityId) Get Entity Risk Score.
CompletableFuture<SecurityEntityRiskScoreResponse>	getEntityRiskScoreAsync(String entityId) Get Entity Risk Score.
ApiResponse<SecurityEntityRiskScoreResponse>	getEntityRiskScoreWithHttpInfo(String entityId) Get the risk score for a specific entity by its ID.
CompletableFuture<ApiResponse<SecurityEntityRiskScoreResponse>>	getEntityRiskScoreWithHttpInfoAsync(String entityId) Get Entity Risk Score.
SecurityEntityRiskScoresResponse	listEntityRiskScores() List Entity Risk Scores.
SecurityEntityRiskScoresResponse	listEntityRiskScores(EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters parameters) List Entity Risk Scores.
CompletableFuture<SecurityEntityRiskScoresResponse>	listEntityRiskScoresAsync() List Entity Risk Scores.
CompletableFuture<SecurityEntityRiskScoresResponse>	listEntityRiskScoresAsync(EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters parameters) List Entity Risk Scores.
ApiResponse<SecurityEntityRiskScoresResponse>	listEntityRiskScoresWithHttpInfo(EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters parameters) Get a list of entity risk scores for your organization.
CompletableFuture<ApiResponse<SecurityEntityRiskScoresResponse>>	listEntityRiskScoresWithHttpInfoAsync(EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters parameters) List Entity Risk Scores.
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

EntityRiskScoresApi

public EntityRiskScoresApi()

EntityRiskScoresApi

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

getEntityRiskScore

public SecurityEntityRiskScoreResponse getEntityRiskScore(String entityId)
                                                   throws ApiException

Get Entity Risk Score.

See getEntityRiskScoreWithHttpInfo(java.lang.String).

Parameters:

entityId - The URL-encoded unique identifier for the entity. (required)

Returns:

SecurityEntityRiskScoreResponse

Throws:

ApiException - if fails to make API call

getEntityRiskScoreAsync

public CompletableFuture<SecurityEntityRiskScoreResponse> getEntityRiskScoreAsync(String entityId)

Get Entity Risk Score.

See getEntityRiskScoreWithHttpInfoAsync(java.lang.String).

Parameters:

entityId - The URL-encoded unique identifier for the entity. (required)

Returns:

CompletableFuture<SecurityEntityRiskScoreResponse>

getEntityRiskScoreWithHttpInfo

public ApiResponse<SecurityEntityRiskScoreResponse> getEntityRiskScoreWithHttpInfo(String entityId)
                                                                            throws ApiException

Get the risk score for a specific entity by its ID. Returns security risk assessment including risk score, severity, detected signals, misconfigurations, and identity risks.

Parameters:

entityId - The URL-encoded unique identifier for the entity. (required)

Returns:

ApiResponse<SecurityEntityRiskScoreResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

getEntityRiskScoreWithHttpInfoAsync

public CompletableFuture<ApiResponse<SecurityEntityRiskScoreResponse>> getEntityRiskScoreWithHttpInfoAsync(String entityId)

Get Entity Risk Score.

See getEntityRiskScoreWithHttpInfo(java.lang.String).

Parameters:

entityId - The URL-encoded unique identifier for the entity. (required)

Returns:

CompletableFuture<ApiResponse<SecurityEntityRiskScoreResponse>>

listEntityRiskScores

public SecurityEntityRiskScoresResponse listEntityRiskScores()
                                                      throws ApiException

List Entity Risk Scores.

See listEntityRiskScoresWithHttpInfo(com.datadog.api.client.v2.api.EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters).

Returns:

SecurityEntityRiskScoresResponse

Throws:

ApiException - if fails to make API call

listEntityRiskScoresAsync

public CompletableFuture<SecurityEntityRiskScoresResponse> listEntityRiskScoresAsync()

List Entity Risk Scores.

See listEntityRiskScoresWithHttpInfoAsync(com.datadog.api.client.v2.api.EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters).

Returns:

CompletableFuture<SecurityEntityRiskScoresResponse>

listEntityRiskScores

public SecurityEntityRiskScoresResponse listEntityRiskScores(EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters parameters)
                                                      throws ApiException

List Entity Risk Scores.

See listEntityRiskScoresWithHttpInfo(com.datadog.api.client.v2.api.EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

SecurityEntityRiskScoresResponse

Throws:

ApiException - if fails to make API call

listEntityRiskScoresAsync

public CompletableFuture<SecurityEntityRiskScoresResponse> listEntityRiskScoresAsync(EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters parameters)

List Entity Risk Scores.

See listEntityRiskScoresWithHttpInfoAsync(com.datadog.api.client.v2.api.EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<SecurityEntityRiskScoresResponse>

listEntityRiskScoresWithHttpInfo

public ApiResponse<SecurityEntityRiskScoresResponse> listEntityRiskScoresWithHttpInfo(EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters parameters)
                                                                               throws ApiException

Get a list of entity risk scores for your organization. Entity risk scores provide security risk assessment for entities like cloud resources, identities, or services based on detected signals, misconfigurations, and identity risks.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<SecurityEntityRiskScoresResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
429	Too many requests	-

listEntityRiskScoresWithHttpInfoAsync

public CompletableFuture<ApiResponse<SecurityEntityRiskScoresResponse>> listEntityRiskScoresWithHttpInfoAsync(EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters parameters)

List Entity Risk Scores.

See listEntityRiskScoresWithHttpInfo(com.datadog.api.client.v2.api.EntityRiskScoresApi.ListEntityRiskScoresOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<SecurityEntityRiskScoresResponse>>