com.datadog.api.client.v2.api

Class ServiceScorecardsApi

java.lang.Object

com.datadog.api.client.v2.api.ServiceScorecardsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceScorecardsApi.ListScorecardOutcomesOptionalParameters Manage optional parameters to listScorecardOutcomes.
static class	ServiceScorecardsApi.ListScorecardRulesOptionalParameters Manage optional parameters to listScorecardRules.

Constructor Summary

Constructors

Constructor and Description
ServiceScorecardsApi()
ServiceScorecardsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
OutcomesBatchResponse	createScorecardOutcomesBatch(OutcomesBatchRequest body) Create outcomes batch.
CompletableFuture<OutcomesBatchResponse>	createScorecardOutcomesBatchAsync(OutcomesBatchRequest body) Create outcomes batch.
ApiResponse<OutcomesBatchResponse>	createScorecardOutcomesBatchWithHttpInfo(OutcomesBatchRequest body) Sets multiple service-rule outcomes in a single batched request.
CompletableFuture<ApiResponse<OutcomesBatchResponse>>	createScorecardOutcomesBatchWithHttpInfoAsync(OutcomesBatchRequest body) Create outcomes batch.
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	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.
OutcomesResponse	listScorecardOutcomes() List all rule outcomes.
OutcomesResponse	listScorecardOutcomes(ServiceScorecardsApi.ListScorecardOutcomesOptionalParameters parameters) List all rule outcomes.
CompletableFuture<OutcomesResponse>	listScorecardOutcomesAsync() List all rule outcomes.
CompletableFuture<OutcomesResponse>	listScorecardOutcomesAsync(ServiceScorecardsApi.ListScorecardOutcomesOptionalParameters parameters) List all rule outcomes.
ApiResponse<OutcomesResponse>	listScorecardOutcomesWithHttpInfo(ServiceScorecardsApi.ListScorecardOutcomesOptionalParameters parameters) Fetches all rule outcomes.
CompletableFuture<ApiResponse<OutcomesResponse>>	listScorecardOutcomesWithHttpInfoAsync(ServiceScorecardsApi.ListScorecardOutcomesOptionalParameters parameters) List all rule outcomes.
PaginationIterable<OutcomesResponseDataItem>	listScorecardOutcomesWithPagination() List all rule outcomes.
PaginationIterable<OutcomesResponseDataItem>	listScorecardOutcomesWithPagination(ServiceScorecardsApi.ListScorecardOutcomesOptionalParameters parameters) List all rule outcomes.
ListRulesResponse	listScorecardRules() List all rules.
ListRulesResponse	listScorecardRules(ServiceScorecardsApi.ListScorecardRulesOptionalParameters parameters) List all rules.
CompletableFuture<ListRulesResponse>	listScorecardRulesAsync() List all rules.
CompletableFuture<ListRulesResponse>	listScorecardRulesAsync(ServiceScorecardsApi.ListScorecardRulesOptionalParameters parameters) List all rules.
ApiResponse<ListRulesResponse>	listScorecardRulesWithHttpInfo(ServiceScorecardsApi.ListScorecardRulesOptionalParameters parameters) Fetch all rules.
CompletableFuture<ApiResponse<ListRulesResponse>>	listScorecardRulesWithHttpInfoAsync(ServiceScorecardsApi.ListScorecardRulesOptionalParameters parameters) List all rules.
PaginationIterable<ListRulesResponseDataItem>	listScorecardRulesWithPagination() List all rules.
PaginationIterable<ListRulesResponseDataItem>	listScorecardRulesWithPagination(ServiceScorecardsApi.ListScorecardRulesOptionalParameters parameters) List all rules.
void	setApiClient(ApiClient apiClient) Set the API client.
UpdateRuleResponse	updateScorecardRule(String ruleId, UpdateRuleRequest body) Update an existing rule.
CompletableFuture<UpdateRuleResponse>	updateScorecardRuleAsync(String ruleId, UpdateRuleRequest body) Update an existing rule.
ApiResponse<UpdateRuleResponse>	updateScorecardRuleWithHttpInfo(String ruleId, UpdateRuleRequest body) Updates an existing rule.
CompletableFuture<ApiResponse<UpdateRuleResponse>>	updateScorecardRuleWithHttpInfoAsync(String ruleId, UpdateRuleRequest body) Update an existing rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceScorecardsApi

public ServiceScorecardsApi()

ServiceScorecardsApi

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

createScorecardOutcomesBatch

public OutcomesBatchResponse createScorecardOutcomesBatch(OutcomesBatchRequest body)
                                                   throws ApiException

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

public CompletableFuture<OutcomesBatchResponse> createScorecardOutcomesBatchAsync(OutcomesBatchRequest body)

Create outcomes batch.

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

Parameters:

body - Set of scorecard outcomes. (required)

Returns:

CompletableFuture<OutcomesBatchResponse>

createScorecardOutcomesBatchWithHttpInfo

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

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

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

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>>

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>>

listScorecardOutcomes

public OutcomesResponse listScorecardOutcomes()
                                       throws ApiException

List all rule outcomes.

See listScorecardOutcomesWithHttpInfo(com.datadog.api.client.v2.api.ServiceScorecardsApi.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.ServiceScorecardsApi.ListScorecardOutcomesOptionalParameters).

Returns:

CompletableFuture<OutcomesResponse>

listScorecardOutcomes

public OutcomesResponse listScorecardOutcomes(ServiceScorecardsApi.ListScorecardOutcomesOptionalParameters parameters)
                                       throws ApiException

List all rule outcomes.

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

Parameters:

parameters - Optional parameters for the request.

Returns:

OutcomesResponse

Throws:

ApiException - if fails to make API call

listScorecardOutcomesAsync

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

List all rule outcomes.

See listScorecardOutcomesWithHttpInfoAsync(com.datadog.api.client.v2.api.ServiceScorecardsApi.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.ServiceScorecardsApi.ListScorecardOutcomesOptionalParameters).

Returns:

PaginationIterable<OutcomesResponseDataItem>

listScorecardOutcomesWithPagination

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

List all rule outcomes.

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

Returns:

OutcomesResponse

listScorecardOutcomesWithHttpInfo

public ApiResponse<OutcomesResponse> listScorecardOutcomesWithHttpInfo(ServiceScorecardsApi.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(ServiceScorecardsApi.ListScorecardOutcomesOptionalParameters parameters)

List all rule outcomes.

See listScorecardOutcomesWithHttpInfo(com.datadog.api.client.v2.api.ServiceScorecardsApi.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.ServiceScorecardsApi.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.ServiceScorecardsApi.ListScorecardRulesOptionalParameters).

Returns:

CompletableFuture<ListRulesResponse>

listScorecardRules

public ListRulesResponse listScorecardRules(ServiceScorecardsApi.ListScorecardRulesOptionalParameters parameters)
                                     throws ApiException

List all rules.

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

Parameters:

parameters - Optional parameters for the request.

Returns:

ListRulesResponse

Throws:

ApiException - if fails to make API call

listScorecardRulesAsync

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

List all rules.

See listScorecardRulesWithHttpInfoAsync(com.datadog.api.client.v2.api.ServiceScorecardsApi.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.ServiceScorecardsApi.ListScorecardRulesOptionalParameters).

Returns:

PaginationIterable<ListRulesResponseDataItem>

listScorecardRulesWithPagination

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

List all rules.

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

Returns:

ListRulesResponse

listScorecardRulesWithHttpInfo

public ApiResponse<ListRulesResponse> listScorecardRulesWithHttpInfo(ServiceScorecardsApi.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(ServiceScorecardsApi.ListScorecardRulesOptionalParameters parameters)

List all rules.

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

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListRulesResponse>>

updateScorecardRule

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

Update an existing 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 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 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>>