com.datadog.api.client.v2.api

Class ScorecardsApi

java.lang.Object

com.datadog.api.client.v2.api.ScorecardsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScorecardsApi.GetScorecardCampaignOptionalParameters Manage optional parameters to getScorecardCampaign.
static class	ScorecardsApi.ListScorecardCampaignsOptionalParameters Manage optional parameters to listScorecardCampaigns.
static class	ScorecardsApi.ListScorecardOutcomesOptionalParameters Manage optional parameters to listScorecardOutcomes.
static class	ScorecardsApi.ListScorecardRulesOptionalParameters Manage optional parameters to listScorecardRules.
static class	ScorecardsApi.ListScorecardScoresOptionalParameters Manage optional parameters to listScorecardScores.
static class	ScorecardsApi.ListScorecardsOptionalParameters Manage optional parameters to listScorecards.

Constructor Summary

Constructors

Constructor and Description
ScorecardsApi()
ScorecardsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CampaignResponse	createScorecardCampaign(CreateCampaignRequest body) Create a new campaign.
CompletableFuture<CampaignResponse>	createScorecardCampaignAsync(CreateCampaignRequest body) Create a new campaign.
ApiResponse<CampaignResponse>	createScorecardCampaignWithHttpInfo(CreateCampaignRequest body) Creates a new scorecard campaign.
CompletableFuture<ApiResponse<CampaignResponse>>	createScorecardCampaignWithHttpInfoAsync(CreateCampaignRequest body) Create a new campaign.
OutcomesBatchResponse	createScorecardOutcomesBatch(OutcomesBatchRequest body) Deprecated.
CompletableFuture<OutcomesBatchResponse>	createScorecardOutcomesBatchAsync(OutcomesBatchRequest body) Deprecated.
ApiResponse<OutcomesBatchResponse>	createScorecardOutcomesBatchWithHttpInfo(OutcomesBatchRequest body) Deprecated.
CompletableFuture<ApiResponse<OutcomesBatchResponse>>	createScorecardOutcomesBatchWithHttpInfoAsync(OutcomesBatchRequest body) Deprecated.
CreateRuleResponse	createScorecardRule(CreateRuleRequest body) Create a new rule.
CompletableFuture<CreateRuleResponse>	createScorecardRuleAsync(CreateRuleRequest body) Create a new rule.
ApiResponse<CreateRuleResponse>	createScorecardRuleWithHttpInfo(CreateRuleRequest body) Creates a new rule.
CompletableFuture<ApiResponse<CreateRuleResponse>>	createScorecardRuleWithHttpInfoAsync(CreateRuleRequest body) Create a new rule.
void	deleteScorecardCampaign(String campaignId) Delete a campaign.
CompletableFuture<Void>	deleteScorecardCampaignAsync(String campaignId) Delete a campaign.
ApiResponse<Void>	deleteScorecardCampaignWithHttpInfo(String campaignId) Deletes a single campaign by ID or key.
CompletableFuture<ApiResponse<Void>>	deleteScorecardCampaignWithHttpInfoAsync(String campaignId) Delete a campaign.
void	deleteScorecardRule(String ruleId) Delete a rule.
CompletableFuture<Void>	deleteScorecardRuleAsync(String ruleId) Delete a rule.
ApiResponse<Void>	deleteScorecardRuleWithHttpInfo(String ruleId) Deletes a single rule.
CompletableFuture<ApiResponse<Void>>	deleteScorecardRuleWithHttpInfoAsync(String ruleId) Delete a rule.
ApiClient	getApiClient() Get the API client.
CampaignResponse	getScorecardCampaign(String campaignId) Get a campaign.
CampaignResponse	getScorecardCampaign(String campaignId, ScorecardsApi.GetScorecardCampaignOptionalParameters parameters) Get a campaign.
CompletableFuture<CampaignResponse>	getScorecardCampaignAsync(String campaignId) Get a campaign.
CompletableFuture<CampaignResponse>	getScorecardCampaignAsync(String campaignId, ScorecardsApi.GetScorecardCampaignOptionalParameters parameters) Get a campaign.
ApiResponse<CampaignResponse>	getScorecardCampaignWithHttpInfo(String campaignId, ScorecardsApi.GetScorecardCampaignOptionalParameters parameters) Fetches a single campaign by ID or key.
CompletableFuture<ApiResponse<CampaignResponse>>	getScorecardCampaignWithHttpInfoAsync(String campaignId, ScorecardsApi.GetScorecardCampaignOptionalParameters parameters) Get a campaign.
ListCampaignsResponse	listScorecardCampaigns() List all campaigns.
ListCampaignsResponse	listScorecardCampaigns(ScorecardsApi.ListScorecardCampaignsOptionalParameters parameters) List all campaigns.
CompletableFuture<ListCampaignsResponse>	listScorecardCampaignsAsync() List all campaigns.
CompletableFuture<ListCampaignsResponse>	listScorecardCampaignsAsync(ScorecardsApi.ListScorecardCampaignsOptionalParameters parameters) List all campaigns.
ApiResponse<ListCampaignsResponse>	listScorecardCampaignsWithHttpInfo(ScorecardsApi.ListScorecardCampaignsOptionalParameters parameters) Fetches all scorecard campaigns.
CompletableFuture<ApiResponse<ListCampaignsResponse>>	listScorecardCampaignsWithHttpInfoAsync(ScorecardsApi.ListScorecardCampaignsOptionalParameters parameters) List all campaigns.
OutcomesResponse	listScorecardOutcomes() List all rule outcomes.
OutcomesResponse	listScorecardOutcomes(ScorecardsApi.ListScorecardOutcomesOptionalParameters parameters) List all rule outcomes.
CompletableFuture<OutcomesResponse>	listScorecardOutcomesAsync() List all rule outcomes.
CompletableFuture<OutcomesResponse>	listScorecardOutcomesAsync(ScorecardsApi.ListScorecardOutcomesOptionalParameters parameters) List all rule outcomes.
ApiResponse<OutcomesResponse>	listScorecardOutcomesWithHttpInfo(ScorecardsApi.ListScorecardOutcomesOptionalParameters parameters) Fetches all rule outcomes.
CompletableFuture<ApiResponse<OutcomesResponse>>	listScorecardOutcomesWithHttpInfoAsync(ScorecardsApi.ListScorecardOutcomesOptionalParameters parameters) List all rule outcomes.
PaginationIterable<OutcomesResponseDataItem>	listScorecardOutcomesWithPagination() List all rule outcomes.
PaginationIterable<OutcomesResponseDataItem>	listScorecardOutcomesWithPagination(ScorecardsApi.ListScorecardOutcomesOptionalParameters parameters) List all rule outcomes.
ListRulesResponse	listScorecardRules() List all rules.
ListRulesResponse	listScorecardRules(ScorecardsApi.ListScorecardRulesOptionalParameters parameters) List all rules.
CompletableFuture<ListRulesResponse>	listScorecardRulesAsync() List all rules.
CompletableFuture<ListRulesResponse>	listScorecardRulesAsync(ScorecardsApi.ListScorecardRulesOptionalParameters parameters) List all rules.
ApiResponse<ListRulesResponse>	listScorecardRulesWithHttpInfo(ScorecardsApi.ListScorecardRulesOptionalParameters parameters) Fetch all rules.
CompletableFuture<ApiResponse<ListRulesResponse>>	listScorecardRulesWithHttpInfoAsync(ScorecardsApi.ListScorecardRulesOptionalParameters parameters) List all rules.
PaginationIterable<ListRulesResponseDataItem>	listScorecardRulesWithPagination() List all rules.
PaginationIterable<ListRulesResponseDataItem>	listScorecardRulesWithPagination(ScorecardsApi.ListScorecardRulesOptionalParameters parameters) List all rules.
ListScorecardsResponse	listScorecards() List all scorecards.
ListScorecardsResponse	listScorecards(ScorecardsApi.ListScorecardsOptionalParameters parameters) List all scorecards.
CompletableFuture<ListScorecardsResponse>	listScorecardsAsync() List all scorecards.
CompletableFuture<ListScorecardsResponse>	listScorecardsAsync(ScorecardsApi.ListScorecardsOptionalParameters parameters) List all scorecards.
ListScorecardScoresResponse	listScorecardScores(ScorecardScoresAggregation aggregation) List all scores.
ListScorecardScoresResponse	listScorecardScores(ScorecardScoresAggregation aggregation, ScorecardsApi.ListScorecardScoresOptionalParameters parameters) List all scores.
CompletableFuture<ListScorecardScoresResponse>	listScorecardScoresAsync(ScorecardScoresAggregation aggregation) List all scores.
CompletableFuture<ListScorecardScoresResponse>	listScorecardScoresAsync(ScorecardScoresAggregation aggregation, ScorecardsApi.ListScorecardScoresOptionalParameters parameters) List all scores.
ApiResponse<ListScorecardScoresResponse>	listScorecardScoresWithHttpInfo(ScorecardScoresAggregation aggregation, ScorecardsApi.ListScorecardScoresOptionalParameters parameters) Returns a list of scorecard scores for each aggregation type, with score breakdowns.
CompletableFuture<ApiResponse<ListScorecardScoresResponse>>	listScorecardScoresWithHttpInfoAsync(ScorecardScoresAggregation aggregation, ScorecardsApi.ListScorecardScoresOptionalParameters parameters) List all scores.
ApiResponse<ListScorecardsResponse>	listScorecardsWithHttpInfo(ScorecardsApi.ListScorecardsOptionalParameters parameters) Fetches all scorecards.
CompletableFuture<ApiResponse<ListScorecardsResponse>>	listScorecardsWithHttpInfoAsync(ScorecardsApi.ListScorecardsOptionalParameters parameters) List all scorecards.
void	setApiClient(ApiClient apiClient) Set the API client.
CampaignResponse	updateScorecardCampaign(String campaignId, UpdateCampaignRequest body) Update a campaign.
CompletableFuture<CampaignResponse>	updateScorecardCampaignAsync(String campaignId, UpdateCampaignRequest body) Update a campaign.
ApiResponse<CampaignResponse>	updateScorecardCampaignWithHttpInfo(String campaignId, UpdateCampaignRequest body) Updates an existing campaign.
CompletableFuture<ApiResponse<CampaignResponse>>	updateScorecardCampaignWithHttpInfoAsync(String campaignId, UpdateCampaignRequest body) Update a campaign.
void	updateScorecardOutcomes(UpdateOutcomesAsyncRequest body) Update Scorecard outcomes.
CompletableFuture<Void>	updateScorecardOutcomesAsync(UpdateOutcomesAsyncRequest body) Update Scorecard outcomes.
ApiResponse<Void>	updateScorecardOutcomesWithHttpInfo(UpdateOutcomesAsyncRequest body) Updates multiple scorecard rule outcomes in a single batched request.
CompletableFuture<ApiResponse<Void>>	updateScorecardOutcomesWithHttpInfoAsync(UpdateOutcomesAsyncRequest body) Update Scorecard outcomes.
UpdateRuleResponse	updateScorecardRule(String ruleId, UpdateRuleRequest body) Update an existing scorecard rule.
CompletableFuture<UpdateRuleResponse>	updateScorecardRuleAsync(String ruleId, UpdateRuleRequest body) Update an existing scorecard rule.
ApiResponse<UpdateRuleResponse>	updateScorecardRuleWithHttpInfo(String ruleId, UpdateRuleRequest body) Updates an existing rule.
CompletableFuture<ApiResponse<UpdateRuleResponse>>	updateScorecardRuleWithHttpInfoAsync(String ruleId, UpdateRuleRequest body) Update an existing scorecard rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScorecardsApi

public ScorecardsApi()

ScorecardsApi

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

createScorecardCampaign

public CampaignResponse createScorecardCampaign(CreateCampaignRequest body)
                                         throws ApiException

Create a new campaign.

See createScorecardCampaignWithHttpInfo(com.datadog.api.client.v2.model.CreateCampaignRequest).

Parameters:

body - Campaign data. (required)

Returns:

CampaignResponse

Throws:

ApiException - if fails to make API call

createScorecardCampaignAsync

public CompletableFuture<CampaignResponse> createScorecardCampaignAsync(CreateCampaignRequest body)

Create a new campaign.

See createScorecardCampaignWithHttpInfoAsync(com.datadog.api.client.v2.model.CreateCampaignRequest).

Parameters:

body - Campaign data. (required)

Returns:

CompletableFuture<CampaignResponse>

createScorecardCampaignWithHttpInfo

public ApiResponse<CampaignResponse> createScorecardCampaignWithHttpInfo(CreateCampaignRequest body)
                                                                  throws ApiException

Creates a new scorecard campaign.

Parameters:

body - Campaign data. (required)

Returns:

ApiResponse<CampaignResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
201	Created	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

createScorecardCampaignWithHttpInfoAsync

public CompletableFuture<ApiResponse<CampaignResponse>> createScorecardCampaignWithHttpInfoAsync(CreateCampaignRequest body)

Create a new campaign.

See createScorecardCampaignWithHttpInfo(com.datadog.api.client.v2.model.CreateCampaignRequest).

Parameters:

body - Campaign data. (required)

Returns:

CompletableFuture<ApiResponse<CampaignResponse>>

createScorecardOutcomesBatch

@Deprecated
public OutcomesBatchResponse createScorecardOutcomesBatch(OutcomesBatchRequest body)
                                                               throws ApiException

Deprecated.

Create outcomes batch.

See createScorecardOutcomesBatchWithHttpInfo(com.datadog.api.client.v2.model.OutcomesBatchRequest).

Parameters:

body - Set of scorecard outcomes. (required)

Returns:

OutcomesBatchResponse

Throws:

ApiException - if fails to make API call

createScorecardOutcomesBatchAsync

@Deprecated
public CompletableFuture<OutcomesBatchResponse> createScorecardOutcomesBatchAsync(OutcomesBatchRequest body)

Deprecated.

Create outcomes batch.

See createScorecardOutcomesBatchWithHttpInfoAsync(com.datadog.api.client.v2.model.OutcomesBatchRequest).

Parameters:

body - Set of scorecard outcomes. (required)

Returns:

CompletableFuture<OutcomesBatchResponse>

createScorecardOutcomesBatchWithHttpInfo

@Deprecated
public ApiResponse<OutcomesBatchResponse> createScorecardOutcomesBatchWithHttpInfo(OutcomesBatchRequest body)
                                                                                        throws ApiException

Deprecated.

Sets multiple service-rule outcomes in a single batched request.

Parameters:

body - Set of scorecard outcomes. (required)

Returns:

ApiResponse<OutcomesBatchResponse>

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	-

createScorecardOutcomesBatchWithHttpInfoAsync

@Deprecated
public CompletableFuture<ApiResponse<OutcomesBatchResponse>> createScorecardOutcomesBatchWithHttpInfoAsync(OutcomesBatchRequest body)

Deprecated.

Create outcomes batch.

See createScorecardOutcomesBatchWithHttpInfo(com.datadog.api.client.v2.model.OutcomesBatchRequest).

Parameters:

body - Set of scorecard outcomes. (required)

Returns:

CompletableFuture<ApiResponse<OutcomesBatchResponse>>

createScorecardRule

public CreateRuleResponse createScorecardRule(CreateRuleRequest body)
                                       throws ApiException

Create a new rule.

See createScorecardRuleWithHttpInfo(com.datadog.api.client.v2.model.CreateRuleRequest).

Parameters:

body - Rule attributes. (required)

Returns:

CreateRuleResponse

Throws:

ApiException - if fails to make API call

createScorecardRuleAsync

public CompletableFuture<CreateRuleResponse> createScorecardRuleAsync(CreateRuleRequest body)

Create a new rule.

See createScorecardRuleWithHttpInfoAsync(com.datadog.api.client.v2.model.CreateRuleRequest).

Parameters:

body - Rule attributes. (required)

Returns:

CompletableFuture<CreateRuleResponse>

createScorecardRuleWithHttpInfo

public ApiResponse<CreateRuleResponse> createScorecardRuleWithHttpInfo(CreateRuleRequest body)
                                                                throws ApiException

Creates a new rule.

Parameters:

body - Rule attributes. (required)

Returns:

ApiResponse<CreateRuleResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
201	Created	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

createScorecardRuleWithHttpInfoAsync

public CompletableFuture<ApiResponse<CreateRuleResponse>> createScorecardRuleWithHttpInfoAsync(CreateRuleRequest body)

Create a new rule.

See createScorecardRuleWithHttpInfo(com.datadog.api.client.v2.model.CreateRuleRequest).

Parameters:

body - Rule attributes. (required)

Returns:

CompletableFuture<ApiResponse<CreateRuleResponse>>

deleteScorecardCampaign

public void deleteScorecardCampaign(String campaignId)
                             throws ApiException

Delete a campaign.

See deleteScorecardCampaignWithHttpInfo(java.lang.String).

Parameters:

campaignId - Campaign ID or key. (required)

Throws:

ApiException - if fails to make API call

deleteScorecardCampaignAsync

public CompletableFuture<Void> deleteScorecardCampaignAsync(String campaignId)

Delete a campaign.

See deleteScorecardCampaignWithHttpInfoAsync(java.lang.String).

Parameters:

campaignId - Campaign ID or key. (required)

Returns:

CompletableFuture

deleteScorecardCampaignWithHttpInfo

public ApiResponse<Void> deleteScorecardCampaignWithHttpInfo(String campaignId)
                                                      throws ApiException

Deletes a single campaign by ID or key.

Parameters:

campaignId - Campaign ID or key. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	No Content	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

deleteScorecardCampaignWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteScorecardCampaignWithHttpInfoAsync(String campaignId)

Delete a campaign.

See deleteScorecardCampaignWithHttpInfo(java.lang.String).

Parameters:

campaignId - Campaign ID or key. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

deleteScorecardRule

public void deleteScorecardRule(String ruleId)
                         throws ApiException

Delete a rule.

See deleteScorecardRuleWithHttpInfo(java.lang.String).

Parameters:

ruleId - The ID of the rule. (required)

Throws:

ApiException - if fails to make API call

deleteScorecardRuleAsync

public CompletableFuture<Void> deleteScorecardRuleAsync(String ruleId)

Delete a rule.

See deleteScorecardRuleWithHttpInfoAsync(java.lang.String).

Parameters:

ruleId - The ID of the rule. (required)

Returns:

CompletableFuture

deleteScorecardRuleWithHttpInfo

public ApiResponse<Void> deleteScorecardRuleWithHttpInfo(String ruleId)
                                                  throws ApiException

Deletes a single rule.

Parameters:

ruleId - The ID of the rule. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

deleteScorecardRuleWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteScorecardRuleWithHttpInfoAsync(String ruleId)

Delete a rule.

See deleteScorecardRuleWithHttpInfo(java.lang.String).

Parameters:

ruleId - The ID of the rule. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getScorecardCampaign

public CampaignResponse getScorecardCampaign(String campaignId)
                                      throws ApiException

Get a campaign.

See getScorecardCampaignWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ScorecardsApi.GetScorecardCampaignOptionalParameters).

Parameters:

campaignId - Campaign ID or key. (required)

Returns:

CampaignResponse

Throws:

ApiException - if fails to make API call

getScorecardCampaignAsync

public CompletableFuture<CampaignResponse> getScorecardCampaignAsync(String campaignId)

Get a campaign.

See getScorecardCampaignWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.ScorecardsApi.GetScorecardCampaignOptionalParameters).

Parameters:

campaignId - Campaign ID or key. (required)

Returns:

CompletableFuture<CampaignResponse>

getScorecardCampaign

public CampaignResponse getScorecardCampaign(String campaignId,
                                             ScorecardsApi.GetScorecardCampaignOptionalParameters parameters)
                                      throws ApiException

Get a campaign.

See getScorecardCampaignWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ScorecardsApi.GetScorecardCampaignOptionalParameters).

Parameters:

campaignId - Campaign ID or key. (required)

parameters - Optional parameters for the request.

Returns:

CampaignResponse

Throws:

ApiException - if fails to make API call

getScorecardCampaignAsync

public CompletableFuture<CampaignResponse> getScorecardCampaignAsync(String campaignId,
                                                                     ScorecardsApi.GetScorecardCampaignOptionalParameters parameters)

Get a campaign.

See getScorecardCampaignWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.ScorecardsApi.GetScorecardCampaignOptionalParameters).

Parameters:

campaignId - Campaign ID or key. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<CampaignResponse>

getScorecardCampaignWithHttpInfo

public ApiResponse<CampaignResponse> getScorecardCampaignWithHttpInfo(String campaignId,
                                                                      ScorecardsApi.GetScorecardCampaignOptionalParameters parameters)
                                                               throws ApiException

Fetches a single campaign by ID or key.

Parameters:

campaignId - Campaign ID or key. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<CampaignResponse>

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	-

getScorecardCampaignWithHttpInfoAsync

public CompletableFuture<ApiResponse<CampaignResponse>> getScorecardCampaignWithHttpInfoAsync(String campaignId,
                                                                                              ScorecardsApi.GetScorecardCampaignOptionalParameters parameters)

Get a campaign.

See getScorecardCampaignWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ScorecardsApi.GetScorecardCampaignOptionalParameters).

Parameters:

campaignId - Campaign ID or key. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<CampaignResponse>>

listScorecardCampaigns

public ListCampaignsResponse listScorecardCampaigns()
                                             throws ApiException

List all campaigns.

See listScorecardCampaignsWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardCampaignsOptionalParameters).

Returns:

ListCampaignsResponse

Throws:

ApiException - if fails to make API call

listScorecardCampaignsAsync

public CompletableFuture<ListCampaignsResponse> listScorecardCampaignsAsync()

List all campaigns.

See listScorecardCampaignsWithHttpInfoAsync(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardCampaignsOptionalParameters).

Returns:

CompletableFuture<ListCampaignsResponse>

listScorecardCampaigns

public ListCampaignsResponse listScorecardCampaigns(ScorecardsApi.ListScorecardCampaignsOptionalParameters parameters)
                                             throws ApiException

List all campaigns.

See listScorecardCampaignsWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardCampaignsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

ListCampaignsResponse

Throws:

ApiException - if fails to make API call

listScorecardCampaignsAsync

public CompletableFuture<ListCampaignsResponse> listScorecardCampaignsAsync(ScorecardsApi.ListScorecardCampaignsOptionalParameters parameters)

List all campaigns.

See listScorecardCampaignsWithHttpInfoAsync(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardCampaignsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ListCampaignsResponse>

listScorecardCampaignsWithHttpInfo

public ApiResponse<ListCampaignsResponse> listScorecardCampaignsWithHttpInfo(ScorecardsApi.ListScorecardCampaignsOptionalParameters parameters)
                                                                      throws ApiException

Fetches all scorecard campaigns.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<ListCampaignsResponse>

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	-

listScorecardCampaignsWithHttpInfoAsync

public CompletableFuture<ApiResponse<ListCampaignsResponse>> listScorecardCampaignsWithHttpInfoAsync(ScorecardsApi.ListScorecardCampaignsOptionalParameters parameters)

List all campaigns.

See listScorecardCampaignsWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardCampaignsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListCampaignsResponse>>

listScorecardOutcomes

public OutcomesResponse listScorecardOutcomes()
                                       throws ApiException

List all rule outcomes.

See listScorecardOutcomesWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardOutcomesOptionalParameters).

Returns:

OutcomesResponse

Throws:

ApiException - if fails to make API call

listScorecardOutcomesAsync

public CompletableFuture<OutcomesResponse> listScorecardOutcomesAsync()

List all rule outcomes.

See listScorecardOutcomesWithHttpInfoAsync(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardOutcomesOptionalParameters).

Returns:

CompletableFuture<OutcomesResponse>

listScorecardOutcomes

public OutcomesResponse listScorecardOutcomes(ScorecardsApi.ListScorecardOutcomesOptionalParameters parameters)
                                       throws ApiException

List all rule outcomes.

See listScorecardOutcomesWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardOutcomesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

OutcomesResponse

Throws:

ApiException - if fails to make API call

listScorecardOutcomesAsync

public CompletableFuture<OutcomesResponse> listScorecardOutcomesAsync(ScorecardsApi.ListScorecardOutcomesOptionalParameters parameters)

List all rule outcomes.

See listScorecardOutcomesWithHttpInfoAsync(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardOutcomesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<OutcomesResponse>

listScorecardOutcomesWithPagination

public PaginationIterable<OutcomesResponseDataItem> listScorecardOutcomesWithPagination()

List all rule outcomes.

See listScorecardOutcomesWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardOutcomesOptionalParameters).

Returns:

PaginationIterable<OutcomesResponseDataItem>

listScorecardOutcomesWithPagination

public PaginationIterable<OutcomesResponseDataItem> listScorecardOutcomesWithPagination(ScorecardsApi.ListScorecardOutcomesOptionalParameters parameters)

List all rule outcomes.

See listScorecardOutcomesWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardOutcomesOptionalParameters).

Returns:

OutcomesResponse

listScorecardOutcomesWithHttpInfo

public ApiResponse<OutcomesResponse> listScorecardOutcomesWithHttpInfo(ScorecardsApi.ListScorecardOutcomesOptionalParameters parameters)
                                                                throws ApiException

Fetches all rule outcomes.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<OutcomesResponse>

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	-

listScorecardOutcomesWithHttpInfoAsync

public CompletableFuture<ApiResponse<OutcomesResponse>> listScorecardOutcomesWithHttpInfoAsync(ScorecardsApi.ListScorecardOutcomesOptionalParameters parameters)

List all rule outcomes.

See listScorecardOutcomesWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardOutcomesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<OutcomesResponse>>

listScorecardRules

public ListRulesResponse listScorecardRules()
                                     throws ApiException

List all rules.

See listScorecardRulesWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardRulesOptionalParameters).

Returns:

ListRulesResponse

Throws:

ApiException - if fails to make API call

listScorecardRulesAsync

public CompletableFuture<ListRulesResponse> listScorecardRulesAsync()

List all rules.

See listScorecardRulesWithHttpInfoAsync(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardRulesOptionalParameters).

Returns:

CompletableFuture<ListRulesResponse>

listScorecardRules

public ListRulesResponse listScorecardRules(ScorecardsApi.ListScorecardRulesOptionalParameters parameters)
                                     throws ApiException

List all rules.

See listScorecardRulesWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardRulesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

ListRulesResponse

Throws:

ApiException - if fails to make API call

listScorecardRulesAsync

public CompletableFuture<ListRulesResponse> listScorecardRulesAsync(ScorecardsApi.ListScorecardRulesOptionalParameters parameters)

List all rules.

See listScorecardRulesWithHttpInfoAsync(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardRulesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ListRulesResponse>

listScorecardRulesWithPagination

public PaginationIterable<ListRulesResponseDataItem> listScorecardRulesWithPagination()

List all rules.

See listScorecardRulesWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardRulesOptionalParameters).

Returns:

PaginationIterable<ListRulesResponseDataItem>

listScorecardRulesWithPagination

public PaginationIterable<ListRulesResponseDataItem> listScorecardRulesWithPagination(ScorecardsApi.ListScorecardRulesOptionalParameters parameters)

List all rules.

See listScorecardRulesWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardRulesOptionalParameters).

Returns:

ListRulesResponse

listScorecardRulesWithHttpInfo

public ApiResponse<ListRulesResponse> listScorecardRulesWithHttpInfo(ScorecardsApi.ListScorecardRulesOptionalParameters parameters)
                                                              throws ApiException

Fetch all rules.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<ListRulesResponse>

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	-

listScorecardRulesWithHttpInfoAsync

public CompletableFuture<ApiResponse<ListRulesResponse>> listScorecardRulesWithHttpInfoAsync(ScorecardsApi.ListScorecardRulesOptionalParameters parameters)

List all rules.

See listScorecardRulesWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardRulesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListRulesResponse>>

listScorecards

public ListScorecardsResponse listScorecards()
                                      throws ApiException

List all scorecards.

See listScorecardsWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardsOptionalParameters).

Returns:

ListScorecardsResponse

Throws:

ApiException - if fails to make API call

listScorecardsAsync

public CompletableFuture<ListScorecardsResponse> listScorecardsAsync()

List all scorecards.

See listScorecardsWithHttpInfoAsync(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardsOptionalParameters).

Returns:

CompletableFuture<ListScorecardsResponse>

listScorecards

public ListScorecardsResponse listScorecards(ScorecardsApi.ListScorecardsOptionalParameters parameters)
                                      throws ApiException

List all scorecards.

See listScorecardsWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

ListScorecardsResponse

Throws:

ApiException - if fails to make API call

listScorecardsAsync

public CompletableFuture<ListScorecardsResponse> listScorecardsAsync(ScorecardsApi.ListScorecardsOptionalParameters parameters)

List all scorecards.

See listScorecardsWithHttpInfoAsync(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ListScorecardsResponse>

listScorecardsWithHttpInfo

public ApiResponse<ListScorecardsResponse> listScorecardsWithHttpInfo(ScorecardsApi.ListScorecardsOptionalParameters parameters)
                                                               throws ApiException

Fetches all scorecards.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<ListScorecardsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
429	Too many requests	-

listScorecardsWithHttpInfoAsync

public CompletableFuture<ApiResponse<ListScorecardsResponse>> listScorecardsWithHttpInfoAsync(ScorecardsApi.ListScorecardsOptionalParameters parameters)

List all scorecards.

See listScorecardsWithHttpInfo(com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListScorecardsResponse>>

listScorecardScores

public ListScorecardScoresResponse listScorecardScores(ScorecardScoresAggregation aggregation)
                                                throws ApiException

List all scores.

See listScorecardScoresWithHttpInfo(com.datadog.api.client.v2.model.ScorecardScoresAggregation, com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardScoresOptionalParameters).

Parameters:

aggregation - The type of scores being requested. (required)

Returns:

ListScorecardScoresResponse

Throws:

ApiException - if fails to make API call

listScorecardScoresAsync

public CompletableFuture<ListScorecardScoresResponse> listScorecardScoresAsync(ScorecardScoresAggregation aggregation)

List all scores.

See listScorecardScoresWithHttpInfoAsync(com.datadog.api.client.v2.model.ScorecardScoresAggregation, com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardScoresOptionalParameters).

Parameters:

aggregation - The type of scores being requested. (required)

Returns:

CompletableFuture<ListScorecardScoresResponse>

listScorecardScores

public ListScorecardScoresResponse listScorecardScores(ScorecardScoresAggregation aggregation,
                                                       ScorecardsApi.ListScorecardScoresOptionalParameters parameters)
                                                throws ApiException

List all scores.

See listScorecardScoresWithHttpInfo(com.datadog.api.client.v2.model.ScorecardScoresAggregation, com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardScoresOptionalParameters).

Parameters:

aggregation - The type of scores being requested. (required)

parameters - Optional parameters for the request.

Returns:

ListScorecardScoresResponse

Throws:

ApiException - if fails to make API call

listScorecardScoresAsync

public CompletableFuture<ListScorecardScoresResponse> listScorecardScoresAsync(ScorecardScoresAggregation aggregation,
                                                                               ScorecardsApi.ListScorecardScoresOptionalParameters parameters)

List all scores.

See listScorecardScoresWithHttpInfoAsync(com.datadog.api.client.v2.model.ScorecardScoresAggregation, com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardScoresOptionalParameters).

Parameters:

aggregation - The type of scores being requested. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ListScorecardScoresResponse>

listScorecardScoresWithHttpInfo

public ApiResponse<ListScorecardScoresResponse> listScorecardScoresWithHttpInfo(ScorecardScoresAggregation aggregation,
                                                                                ScorecardsApi.ListScorecardScoresOptionalParameters parameters)
                                                                         throws ApiException

Returns a list of scorecard scores for each aggregation type, with score breakdowns.

Parameters:

aggregation - The type of scores being requested. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<ListScorecardScoresResponse>

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	-

listScorecardScoresWithHttpInfoAsync

public CompletableFuture<ApiResponse<ListScorecardScoresResponse>> listScorecardScoresWithHttpInfoAsync(ScorecardScoresAggregation aggregation,
                                                                                                        ScorecardsApi.ListScorecardScoresOptionalParameters parameters)

List all scores.

See listScorecardScoresWithHttpInfo(com.datadog.api.client.v2.model.ScorecardScoresAggregation, com.datadog.api.client.v2.api.ScorecardsApi.ListScorecardScoresOptionalParameters).

Parameters:

aggregation - The type of scores being requested. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListScorecardScoresResponse>>

updateScorecardCampaign

public CampaignResponse updateScorecardCampaign(String campaignId,
                                                UpdateCampaignRequest body)
                                         throws ApiException

Update a campaign.

See updateScorecardCampaignWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.UpdateCampaignRequest).

Parameters:

campaignId - Campaign ID or key. (required)

body - Campaign data. (required)

Returns:

CampaignResponse

Throws:

ApiException - if fails to make API call

updateScorecardCampaignAsync

public CompletableFuture<CampaignResponse> updateScorecardCampaignAsync(String campaignId,
                                                                        UpdateCampaignRequest body)

Update a campaign.

See updateScorecardCampaignWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.UpdateCampaignRequest).

Parameters:

campaignId - Campaign ID or key. (required)

body - Campaign data. (required)

Returns:

CompletableFuture<CampaignResponse>

updateScorecardCampaignWithHttpInfo

public ApiResponse<CampaignResponse> updateScorecardCampaignWithHttpInfo(String campaignId,
                                                                         UpdateCampaignRequest body)
                                                                  throws ApiException

Updates an existing campaign.

Parameters:

campaignId - Campaign ID or key. (required)

body - Campaign data. (required)

Returns:

ApiResponse<CampaignResponse>

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	-

updateScorecardCampaignWithHttpInfoAsync

public CompletableFuture<ApiResponse<CampaignResponse>> updateScorecardCampaignWithHttpInfoAsync(String campaignId,
                                                                                                 UpdateCampaignRequest body)

Update a campaign.

See updateScorecardCampaignWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.UpdateCampaignRequest).

Parameters:

campaignId - Campaign ID or key. (required)

body - Campaign data. (required)

Returns:

CompletableFuture<ApiResponse<CampaignResponse>>

updateScorecardOutcomes

public void updateScorecardOutcomes(UpdateOutcomesAsyncRequest body)
                             throws ApiException

Update Scorecard outcomes.

See updateScorecardOutcomesWithHttpInfo(com.datadog.api.client.v2.model.UpdateOutcomesAsyncRequest).

Parameters:

body - Set of scorecard outcomes. (required)

Throws:

ApiException - if fails to make API call

updateScorecardOutcomesAsync

public CompletableFuture<Void> updateScorecardOutcomesAsync(UpdateOutcomesAsyncRequest body)

Update Scorecard outcomes.

See updateScorecardOutcomesWithHttpInfoAsync(com.datadog.api.client.v2.model.UpdateOutcomesAsyncRequest).

Parameters:

body - Set of scorecard outcomes. (required)

Returns:

CompletableFuture

updateScorecardOutcomesWithHttpInfo

public ApiResponse<Void> updateScorecardOutcomesWithHttpInfo(UpdateOutcomesAsyncRequest body)
                                                      throws ApiException

Updates multiple scorecard rule outcomes in a single batched request.

Parameters:

body - Set of scorecard outcomes. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
403	Forbidden	-
409	Conflict	-
429	Too many requests	-

updateScorecardOutcomesWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> updateScorecardOutcomesWithHttpInfoAsync(UpdateOutcomesAsyncRequest body)

Update Scorecard outcomes.

See updateScorecardOutcomesWithHttpInfo(com.datadog.api.client.v2.model.UpdateOutcomesAsyncRequest).

Parameters:

body - Set of scorecard outcomes. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

updateScorecardRule

public UpdateRuleResponse updateScorecardRule(String ruleId,
                                              UpdateRuleRequest body)
                                       throws ApiException

Update an existing scorecard rule.

See updateScorecardRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.UpdateRuleRequest).

Parameters:

ruleId - The ID of the rule. (required)

body - Rule attributes. (required)

Returns:

UpdateRuleResponse

Throws:

ApiException - if fails to make API call

updateScorecardRuleAsync

public CompletableFuture<UpdateRuleResponse> updateScorecardRuleAsync(String ruleId,
                                                                      UpdateRuleRequest body)

Update an existing scorecard rule.

See updateScorecardRuleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.UpdateRuleRequest).

Parameters:

ruleId - The ID of the rule. (required)

body - Rule attributes. (required)

Returns:

CompletableFuture<UpdateRuleResponse>

updateScorecardRuleWithHttpInfo

public ApiResponse<UpdateRuleResponse> updateScorecardRuleWithHttpInfo(String ruleId,
                                                                       UpdateRuleRequest body)
                                                                throws ApiException

Updates an existing rule.

Parameters:

ruleId - The ID of the rule. (required)

body - Rule attributes. (required)

Returns:

ApiResponse<UpdateRuleResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	Rule updated successfully	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

updateScorecardRuleWithHttpInfoAsync

public CompletableFuture<ApiResponse<UpdateRuleResponse>> updateScorecardRuleWithHttpInfoAsync(String ruleId,
                                                                                               UpdateRuleRequest body)

Update an existing scorecard rule.

See updateScorecardRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.UpdateRuleRequest).

Parameters:

ruleId - The ID of the rule. (required)

body - Rule attributes. (required)

Returns:

CompletableFuture<ApiResponse<UpdateRuleResponse>>