Package com.datadog.api.client.v2.api

Class TagRulesApi

java.lang.Object

com.datadog.api.client.v2.api.TagRulesApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TagRulesApi.DeleteTagRuleOptionalParameters	Manage optional parameters to deleteTagRule.
static class	TagRulesApi.GetTagRuleOptionalParameters	Manage optional parameters to getTagRule.
static class	TagRulesApi.GetTagRuleScoreOptionalParameters	Manage optional parameters to getTagRuleScore.
static class	TagRulesApi.ListTagRulesOptionalParameters	Manage optional parameters to listTagRules.

Constructor Summary

Constructors

Constructor	Description
TagRulesApi()
TagRulesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
TagRuleResponse	createTagRule(TagRuleCreateRequest body)	Create a tag rule.
CompletableFuture<TagRuleResponse>	createTagRuleAsync(TagRuleCreateRequest body)	Create a tag rule.
ApiResponse<TagRuleResponse>	createTagRuleWithHttpInfo(TagRuleCreateRequest body)	Create a new tag rule for the organization.
CompletableFuture<ApiResponse<TagRuleResponse>>	createTagRuleWithHttpInfoAsync(TagRuleCreateRequest body)	Create a tag rule.
void	deleteTagRule(String ruleId)	Delete a tag rule.
void	deleteTagRule(String ruleId, TagRulesApi.DeleteTagRuleOptionalParameters parameters)	Delete a tag rule.
CompletableFuture<Void>	deleteTagRuleAsync(String ruleId)	Delete a tag rule.
CompletableFuture<Void>	deleteTagRuleAsync(String ruleId, TagRulesApi.DeleteTagRuleOptionalParameters parameters)	Delete a tag rule.
ApiResponse<Void>	deleteTagRuleWithHttpInfo(String ruleId, TagRulesApi.DeleteTagRuleOptionalParameters parameters)	Delete a tag rule.
CompletableFuture<ApiResponse<Void>>	deleteTagRuleWithHttpInfoAsync(String ruleId, TagRulesApi.DeleteTagRuleOptionalParameters parameters)	Delete a tag rule.
ApiClient	getApiClient()	Get the API client.
TagRuleResponse	getTagRule(String ruleId)	Get a tag rule.
TagRuleResponse	getTagRule(String ruleId, TagRulesApi.GetTagRuleOptionalParameters parameters)	Get a tag rule.
CompletableFuture<TagRuleResponse>	getTagRuleAsync(String ruleId)	Get a tag rule.
CompletableFuture<TagRuleResponse>	getTagRuleAsync(String ruleId, TagRulesApi.GetTagRuleOptionalParameters parameters)	Get a tag rule.
TagRuleScoreResponse	getTagRuleScore(String ruleId)	Get a tag rule compliance score.
TagRuleScoreResponse	getTagRuleScore(String ruleId, TagRulesApi.GetTagRuleScoreOptionalParameters parameters)	Get a tag rule compliance score.
CompletableFuture<TagRuleScoreResponse>	getTagRuleScoreAsync(String ruleId)	Get a tag rule compliance score.
CompletableFuture<TagRuleScoreResponse>	getTagRuleScoreAsync(String ruleId, TagRulesApi.GetTagRuleScoreOptionalParameters parameters)	Get a tag rule compliance score.
ApiResponse<TagRuleScoreResponse>	getTagRuleScoreWithHttpInfo(String ruleId, TagRulesApi.GetTagRuleScoreOptionalParameters parameters)	Retrieve the compliance score for a single tag rule.
CompletableFuture<ApiResponse<TagRuleScoreResponse>>	getTagRuleScoreWithHttpInfoAsync(String ruleId, TagRulesApi.GetTagRuleScoreOptionalParameters parameters)	Get a tag rule compliance score.
ApiResponse<TagRuleResponse>	getTagRuleWithHttpInfo(String ruleId, TagRulesApi.GetTagRuleOptionalParameters parameters)	Retrieve a single tag rule by ID.
CompletableFuture<ApiResponse<TagRuleResponse>>	getTagRuleWithHttpInfoAsync(String ruleId, TagRulesApi.GetTagRuleOptionalParameters parameters)	Get a tag rule.
TagRulesListResponse	listTagRules()	List tag rules.
TagRulesListResponse	listTagRules(TagRulesApi.ListTagRulesOptionalParameters parameters)	List tag rules.
CompletableFuture<TagRulesListResponse>	listTagRulesAsync()	List tag rules.
CompletableFuture<TagRulesListResponse>	listTagRulesAsync(TagRulesApi.ListTagRulesOptionalParameters parameters)	List tag rules.
ApiResponse<TagRulesListResponse>	listTagRulesWithHttpInfo(TagRulesApi.ListTagRulesOptionalParameters parameters)	Retrieve all tag rules for the organization.
CompletableFuture<ApiResponse<TagRulesListResponse>>	listTagRulesWithHttpInfoAsync(TagRulesApi.ListTagRulesOptionalParameters parameters)	List tag rules.
void	setApiClient(ApiClient apiClient)	Set the API client.
TagRuleResponse	updateTagRule(String ruleId, TagRuleUpdateRequest body)	Update a tag rule.
CompletableFuture<TagRuleResponse>	updateTagRuleAsync(String ruleId, TagRuleUpdateRequest body)	Update a tag rule.
ApiResponse<TagRuleResponse>	updateTagRuleWithHttpInfo(String ruleId, TagRuleUpdateRequest body)	Update one or more attributes of an existing tag rule.
CompletableFuture<ApiResponse<TagRuleResponse>>	updateTagRuleWithHttpInfoAsync(String ruleId, TagRuleUpdateRequest body)	Update a tag rule.

Methods inherited from class java.lang.Object

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

Constructor Details

TagRulesApi

public TagRulesApi()

TagRulesApi

public TagRulesApi(ApiClient apiClient)

Method Details

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

createTagRule

public TagRuleResponse createTagRule(TagRuleCreateRequest body)
                              throws ApiException

Create a tag rule.

See createTagRuleWithHttpInfo(com.datadog.api.client.v2.model.TagRuleCreateRequest).

Parameters:

body - (required)

Returns:

TagRuleResponse

Throws:

ApiException - if fails to make API call

createTagRuleAsync

public CompletableFuture<TagRuleResponse> createTagRuleAsync(TagRuleCreateRequest body)

Create a tag rule.

See createTagRuleWithHttpInfoAsync(com.datadog.api.client.v2.model.TagRuleCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<TagRuleResponse>

createTagRuleWithHttpInfo

public ApiResponse<TagRuleResponse> createTagRuleWithHttpInfo(TagRuleCreateRequest body)
                                                       throws ApiException

Create a new tag rule for the organization. The caller's organization is derived from the authenticated user; cross-organization creation is not supported. Fields such as rule_id , version, and the timestamp/audit fields are assigned by the server.

Parameters:

body - (required)

Returns:

ApiResponse<TagRuleResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

createTagRuleWithHttpInfoAsync

public CompletableFuture<ApiResponse<TagRuleResponse>> createTagRuleWithHttpInfoAsync(TagRuleCreateRequest body)

Create a tag rule.

See createTagRuleWithHttpInfo(com.datadog.api.client.v2.model.TagRuleCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<TagRuleResponse>>

deleteTagRule

public void deleteTagRule(String ruleId)
                   throws ApiException

Delete a tag rule.

See deleteTagRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.DeleteTagRuleOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule to delete. (required)

Throws:

ApiException - if fails to make API call

deleteTagRuleAsync

public CompletableFuture<Void> deleteTagRuleAsync(String ruleId)

Delete a tag rule.

See deleteTagRuleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.DeleteTagRuleOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule to delete. (required)

Returns:

CompletableFuture

deleteTagRule

public void deleteTagRule(String ruleId,
 TagRulesApi.DeleteTagRuleOptionalParameters parameters)
                   throws ApiException

Delete a tag rule.

See deleteTagRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.DeleteTagRuleOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule to delete. (required)

parameters - Optional parameters for the request.

Throws:

ApiException - if fails to make API call

deleteTagRuleAsync

public CompletableFuture<Void> deleteTagRuleAsync(String ruleId,
 TagRulesApi.DeleteTagRuleOptionalParameters parameters)

Delete a tag rule.

See deleteTagRuleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.DeleteTagRuleOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule to delete. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture

deleteTagRuleWithHttpInfo

public ApiResponse<Void> deleteTagRuleWithHttpInfo(String ruleId,
 TagRulesApi.DeleteTagRuleOptionalParameters parameters)
                                            throws ApiException

Delete a tag rule. By default the rule is soft-deleted so it can be recovered later and so that historical score data remains queryable. Pass hard_delete=true to remove the rule permanently.

Parameters:

ruleId - The unique identifier of the tag rule to delete. (required)

parameters - Optional parameters for the request.

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

deleteTagRuleWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteTagRuleWithHttpInfoAsync(String ruleId,
 TagRulesApi.DeleteTagRuleOptionalParameters parameters)

Delete a tag rule.

See deleteTagRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.DeleteTagRuleOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule to delete. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<Void>>

getTagRule

public TagRuleResponse getTagRule(String ruleId)
                           throws ApiException

Get a tag rule.

See getTagRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.GetTagRuleOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule. (required)

Returns:

TagRuleResponse

Throws:

ApiException - if fails to make API call

getTagRuleAsync

public CompletableFuture<TagRuleResponse> getTagRuleAsync(String ruleId)

Get a tag rule.

See getTagRuleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.GetTagRuleOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule. (required)

Returns:

CompletableFuture<TagRuleResponse>

getTagRule

public TagRuleResponse getTagRule(String ruleId,
 TagRulesApi.GetTagRuleOptionalParameters parameters)
                           throws ApiException

Get a tag rule.

See getTagRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.GetTagRuleOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule. (required)

parameters - Optional parameters for the request.

Returns:

TagRuleResponse

Throws:

ApiException - if fails to make API call

getTagRuleAsync

public CompletableFuture<TagRuleResponse> getTagRuleAsync(String ruleId,
 TagRulesApi.GetTagRuleOptionalParameters parameters)

Get a tag rule.

See getTagRuleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.GetTagRuleOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<TagRuleResponse>

getTagRuleWithHttpInfo

public ApiResponse<TagRuleResponse> getTagRuleWithHttpInfo(String ruleId,
 TagRulesApi.GetTagRuleOptionalParameters parameters)
                                                    throws ApiException

Retrieve a single tag rule by ID. Optionally include the rule's current compliance score via the include=score query parameter. Rules belonging to other organizations cannot be retrieved.

Parameters:

ruleId - The unique identifier of the tag rule. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<TagRuleResponse>

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	-

getTagRuleWithHttpInfoAsync

public CompletableFuture<ApiResponse<TagRuleResponse>> getTagRuleWithHttpInfoAsync(String ruleId,
 TagRulesApi.GetTagRuleOptionalParameters parameters)

Get a tag rule.

See getTagRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.GetTagRuleOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<TagRuleResponse>>

getTagRuleScore

public TagRuleScoreResponse getTagRuleScore(String ruleId)
                                     throws ApiException

Get a tag rule compliance score.

See getTagRuleScoreWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.GetTagRuleScoreOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule. (required)

Returns:

TagRuleScoreResponse

Throws:

ApiException - if fails to make API call

getTagRuleScoreAsync

public CompletableFuture<TagRuleScoreResponse> getTagRuleScoreAsync(String ruleId)

Get a tag rule compliance score.

See getTagRuleScoreWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.GetTagRuleScoreOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule. (required)

Returns:

CompletableFuture<TagRuleScoreResponse>

getTagRuleScore

public TagRuleScoreResponse getTagRuleScore(String ruleId,
 TagRulesApi.GetTagRuleScoreOptionalParameters parameters)
                                     throws ApiException

Get a tag rule compliance score.

See getTagRuleScoreWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.GetTagRuleScoreOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule. (required)

parameters - Optional parameters for the request.

Returns:

TagRuleScoreResponse

Throws:

ApiException - if fails to make API call

getTagRuleScoreAsync

public CompletableFuture<TagRuleScoreResponse> getTagRuleScoreAsync(String ruleId,
 TagRulesApi.GetTagRuleScoreOptionalParameters parameters)

Get a tag rule compliance score.

See getTagRuleScoreWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.GetTagRuleScoreOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<TagRuleScoreResponse>

getTagRuleScoreWithHttpInfo

public ApiResponse<TagRuleScoreResponse> getTagRuleScoreWithHttpInfo(String ruleId,
 TagRulesApi.GetTagRuleScoreOptionalParameters parameters)
                                                              throws ApiException

Retrieve the compliance score for a single tag rule. The score is computed over the requested time window (or a source-appropriate default) and represents the percentage of telemetry within that window that conforms to the rule. A null score indicates that no relevant telemetry was found.

Parameters:

ruleId - The unique identifier of the tag rule. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<TagRuleScoreResponse>

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	-

getTagRuleScoreWithHttpInfoAsync

public CompletableFuture<ApiResponse<TagRuleScoreResponse>> getTagRuleScoreWithHttpInfoAsync(String ruleId,
 TagRulesApi.GetTagRuleScoreOptionalParameters parameters)

Get a tag rule compliance score.

See getTagRuleScoreWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagRulesApi.GetTagRuleScoreOptionalParameters).

Parameters:

ruleId - The unique identifier of the tag rule. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<TagRuleScoreResponse>>

listTagRules

public TagRulesListResponse listTagRules()
                                  throws ApiException

List tag rules.

See listTagRulesWithHttpInfo(com.datadog.api.client.v2.api.TagRulesApi.ListTagRulesOptionalParameters).

Returns:

TagRulesListResponse

Throws:

ApiException - if fails to make API call

listTagRulesAsync

public CompletableFuture<TagRulesListResponse> listTagRulesAsync()

List tag rules.

See listTagRulesWithHttpInfoAsync(com.datadog.api.client.v2.api.TagRulesApi.ListTagRulesOptionalParameters).

Returns:

CompletableFuture<TagRulesListResponse>

listTagRules

public TagRulesListResponse listTagRules(TagRulesApi.ListTagRulesOptionalParameters parameters)
                                  throws ApiException

List tag rules.

See listTagRulesWithHttpInfo(com.datadog.api.client.v2.api.TagRulesApi.ListTagRulesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

TagRulesListResponse

Throws:

ApiException - if fails to make API call

listTagRulesAsync

public CompletableFuture<TagRulesListResponse> listTagRulesAsync(TagRulesApi.ListTagRulesOptionalParameters parameters)

List tag rules.

See listTagRulesWithHttpInfoAsync(com.datadog.api.client.v2.api.TagRulesApi.ListTagRulesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<TagRulesListResponse>

listTagRulesWithHttpInfo

public ApiResponse<TagRulesListResponse> listTagRulesWithHttpInfo(TagRulesApi.ListTagRulesOptionalParameters parameters)
                                                           throws ApiException

Retrieve all tag rules for the organization. Optionally include disabled or deleted rules, filter by telemetry source, and include each rule's current compliance score via the include=score query parameter.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<TagRulesListResponse>

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	-

listTagRulesWithHttpInfoAsync

public CompletableFuture<ApiResponse<TagRulesListResponse>> listTagRulesWithHttpInfoAsync(TagRulesApi.ListTagRulesOptionalParameters parameters)

List tag rules.

See listTagRulesWithHttpInfo(com.datadog.api.client.v2.api.TagRulesApi.ListTagRulesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<TagRulesListResponse>>

updateTagRule

public TagRuleResponse updateTagRule(String ruleId,
 TagRuleUpdateRequest body)
                              throws ApiException

Update a tag rule.

See updateTagRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.TagRuleUpdateRequest).

Parameters:

ruleId - The unique identifier of the tag rule to update. (required)

body - (required)

Returns:

TagRuleResponse

Throws:

ApiException - if fails to make API call

updateTagRuleAsync

public CompletableFuture<TagRuleResponse> updateTagRuleAsync(String ruleId,
 TagRuleUpdateRequest body)

Update a tag rule.

See updateTagRuleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.TagRuleUpdateRequest).

Parameters:

ruleId - The unique identifier of the tag rule to update. (required)

body - (required)

Returns:

CompletableFuture<TagRuleResponse>

updateTagRuleWithHttpInfo

public ApiResponse<TagRuleResponse> updateTagRuleWithHttpInfo(String ruleId,
 TagRuleUpdateRequest body)
                                                       throws ApiException

Update one or more attributes of an existing tag rule. Only the fields supplied in the request body are modified; omitted fields retain their current values. The rule's source cannot be changed after creation.

Parameters:

ruleId - The unique identifier of the tag rule to update. (required)

body - (required)

Returns:

ApiResponse<TagRuleResponse>

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	-

updateTagRuleWithHttpInfoAsync

public CompletableFuture<ApiResponse<TagRuleResponse>> updateTagRuleWithHttpInfoAsync(String ruleId,
 TagRuleUpdateRequest body)

Update a tag rule.

See updateTagRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.TagRuleUpdateRequest).

Parameters:

ruleId - The unique identifier of the tag rule to update. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<TagRuleResponse>>