com.datadog.api.client.v2.api

Class TagPoliciesApi

java.lang.Object

com.datadog.api.client.v2.api.TagPoliciesApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TagPoliciesApi.DeleteTagPolicyOptionalParameters Manage optional parameters to deleteTagPolicy.
static class	TagPoliciesApi.GetTagPolicyOptionalParameters Manage optional parameters to getTagPolicy.
static class	TagPoliciesApi.GetTagPolicyScoreOptionalParameters Manage optional parameters to getTagPolicyScore.
static class	TagPoliciesApi.ListTagPoliciesOptionalParameters Manage optional parameters to listTagPolicies.

Constructor Summary

Constructors

Constructor and Description
TagPoliciesApi()
TagPoliciesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
TagPolicyResponse	createTagPolicy(TagPolicyCreateRequest body) Create a tag policy.
CompletableFuture<TagPolicyResponse>	createTagPolicyAsync(TagPolicyCreateRequest body) Create a tag policy.
ApiResponse<TagPolicyResponse>	createTagPolicyWithHttpInfo(TagPolicyCreateRequest body) Create a new tag policy for the organization.
CompletableFuture<ApiResponse<TagPolicyResponse>>	createTagPolicyWithHttpInfoAsync(TagPolicyCreateRequest body) Create a tag policy.
void	deleteTagPolicy(String policyId) Delete a tag policy.
void	deleteTagPolicy(String policyId, TagPoliciesApi.DeleteTagPolicyOptionalParameters parameters) Delete a tag policy.
CompletableFuture<Void>	deleteTagPolicyAsync(String policyId) Delete a tag policy.
CompletableFuture<Void>	deleteTagPolicyAsync(String policyId, TagPoliciesApi.DeleteTagPolicyOptionalParameters parameters) Delete a tag policy.
ApiResponse<Void>	deleteTagPolicyWithHttpInfo(String policyId, TagPoliciesApi.DeleteTagPolicyOptionalParameters parameters) Delete a tag policy.
CompletableFuture<ApiResponse<Void>>	deleteTagPolicyWithHttpInfoAsync(String policyId, TagPoliciesApi.DeleteTagPolicyOptionalParameters parameters) Delete a tag policy.
ApiClient	getApiClient() Get the API client.
TagPolicyResponse	getTagPolicy(String policyId) Get a tag policy.
TagPolicyResponse	getTagPolicy(String policyId, TagPoliciesApi.GetTagPolicyOptionalParameters parameters) Get a tag policy.
CompletableFuture<TagPolicyResponse>	getTagPolicyAsync(String policyId) Get a tag policy.
CompletableFuture<TagPolicyResponse>	getTagPolicyAsync(String policyId, TagPoliciesApi.GetTagPolicyOptionalParameters parameters) Get a tag policy.
TagPolicyScoreResponse	getTagPolicyScore(String policyId) Get a tag policy compliance score.
TagPolicyScoreResponse	getTagPolicyScore(String policyId, TagPoliciesApi.GetTagPolicyScoreOptionalParameters parameters) Get a tag policy compliance score.
CompletableFuture<TagPolicyScoreResponse>	getTagPolicyScoreAsync(String policyId) Get a tag policy compliance score.
CompletableFuture<TagPolicyScoreResponse>	getTagPolicyScoreAsync(String policyId, TagPoliciesApi.GetTagPolicyScoreOptionalParameters parameters) Get a tag policy compliance score.
ApiResponse<TagPolicyScoreResponse>	getTagPolicyScoreWithHttpInfo(String policyId, TagPoliciesApi.GetTagPolicyScoreOptionalParameters parameters) Retrieve the compliance score for a single tag policy.
CompletableFuture<ApiResponse<TagPolicyScoreResponse>>	getTagPolicyScoreWithHttpInfoAsync(String policyId, TagPoliciesApi.GetTagPolicyScoreOptionalParameters parameters) Get a tag policy compliance score.
ApiResponse<TagPolicyResponse>	getTagPolicyWithHttpInfo(String policyId, TagPoliciesApi.GetTagPolicyOptionalParameters parameters) Retrieve a single tag policy by ID.
CompletableFuture<ApiResponse<TagPolicyResponse>>	getTagPolicyWithHttpInfoAsync(String policyId, TagPoliciesApi.GetTagPolicyOptionalParameters parameters) Get a tag policy.
TagPoliciesListResponse	listTagPolicies() List tag policies.
TagPoliciesListResponse	listTagPolicies(TagPoliciesApi.ListTagPoliciesOptionalParameters parameters) List tag policies.
CompletableFuture<TagPoliciesListResponse>	listTagPoliciesAsync() List tag policies.
CompletableFuture<TagPoliciesListResponse>	listTagPoliciesAsync(TagPoliciesApi.ListTagPoliciesOptionalParameters parameters) List tag policies.
ApiResponse<TagPoliciesListResponse>	listTagPoliciesWithHttpInfo(TagPoliciesApi.ListTagPoliciesOptionalParameters parameters) Retrieve all tag policies for the organization.
CompletableFuture<ApiResponse<TagPoliciesListResponse>>	listTagPoliciesWithHttpInfoAsync(TagPoliciesApi.ListTagPoliciesOptionalParameters parameters) List tag policies.
void	setApiClient(ApiClient apiClient) Set the API client.
TagPolicyResponse	updateTagPolicy(String policyId, TagPolicyUpdateRequest body) Update a tag policy.
CompletableFuture<TagPolicyResponse>	updateTagPolicyAsync(String policyId, TagPolicyUpdateRequest body) Update a tag policy.
ApiResponse<TagPolicyResponse>	updateTagPolicyWithHttpInfo(String policyId, TagPolicyUpdateRequest body) Update one or more attributes of an existing tag policy.
CompletableFuture<ApiResponse<TagPolicyResponse>>	updateTagPolicyWithHttpInfoAsync(String policyId, TagPolicyUpdateRequest body) Update a tag policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagPoliciesApi

public TagPoliciesApi()

TagPoliciesApi

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

createTagPolicy

public TagPolicyResponse createTagPolicy(TagPolicyCreateRequest body)
                                  throws ApiException

Create a tag policy.

See createTagPolicyWithHttpInfo(com.datadog.api.client.v2.model.TagPolicyCreateRequest).

Parameters:

body - (required)

Returns:

TagPolicyResponse

Throws:

ApiException - if fails to make API call

createTagPolicyAsync

public CompletableFuture<TagPolicyResponse> createTagPolicyAsync(TagPolicyCreateRequest body)

Create a tag policy.

See createTagPolicyWithHttpInfoAsync(com.datadog.api.client.v2.model.TagPolicyCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<TagPolicyResponse>

createTagPolicyWithHttpInfo

public ApiResponse<TagPolicyResponse> createTagPolicyWithHttpInfo(TagPolicyCreateRequest body)
                                                           throws ApiException

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

Parameters:

body - (required)

Returns:

ApiResponse<TagPolicyResponse>

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	-

createTagPolicyWithHttpInfoAsync

public CompletableFuture<ApiResponse<TagPolicyResponse>> createTagPolicyWithHttpInfoAsync(TagPolicyCreateRequest body)

Create a tag policy.

See createTagPolicyWithHttpInfo(com.datadog.api.client.v2.model.TagPolicyCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<TagPolicyResponse>>

deleteTagPolicy

public void deleteTagPolicy(String policyId)
                     throws ApiException

Delete a tag policy.

See deleteTagPolicyWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.DeleteTagPolicyOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy to delete. (required)

Throws:

ApiException - if fails to make API call

deleteTagPolicyAsync

public CompletableFuture<Void> deleteTagPolicyAsync(String policyId)

Delete a tag policy.

See deleteTagPolicyWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.DeleteTagPolicyOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy to delete. (required)

Returns:

CompletableFuture

deleteTagPolicy

public void deleteTagPolicy(String policyId,
                            TagPoliciesApi.DeleteTagPolicyOptionalParameters parameters)
                     throws ApiException

Delete a tag policy.

See deleteTagPolicyWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.DeleteTagPolicyOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy to delete. (required)

parameters - Optional parameters for the request.

Throws:

ApiException - if fails to make API call

deleteTagPolicyAsync

public CompletableFuture<Void> deleteTagPolicyAsync(String policyId,
                                                    TagPoliciesApi.DeleteTagPolicyOptionalParameters parameters)

Delete a tag policy.

See deleteTagPolicyWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.DeleteTagPolicyOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy to delete. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture

deleteTagPolicyWithHttpInfo

public ApiResponse<Void> deleteTagPolicyWithHttpInfo(String policyId,
                                                     TagPoliciesApi.DeleteTagPolicyOptionalParameters parameters)
                                              throws ApiException

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

Parameters:

policyId - The unique identifier of the tag policy 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	-

deleteTagPolicyWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteTagPolicyWithHttpInfoAsync(String policyId,
                                                                             TagPoliciesApi.DeleteTagPolicyOptionalParameters parameters)

Delete a tag policy.

See deleteTagPolicyWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.DeleteTagPolicyOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy to delete. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<Void>>

getTagPolicy

public TagPolicyResponse getTagPolicy(String policyId)
                               throws ApiException

Get a tag policy.

See getTagPolicyWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.GetTagPolicyOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy. (required)

Returns:

TagPolicyResponse

Throws:

ApiException - if fails to make API call

getTagPolicyAsync

public CompletableFuture<TagPolicyResponse> getTagPolicyAsync(String policyId)

Get a tag policy.

See getTagPolicyWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.GetTagPolicyOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy. (required)

Returns:

CompletableFuture<TagPolicyResponse>

getTagPolicy

public TagPolicyResponse getTagPolicy(String policyId,
                                      TagPoliciesApi.GetTagPolicyOptionalParameters parameters)
                               throws ApiException

Get a tag policy.

See getTagPolicyWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.GetTagPolicyOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy. (required)

parameters - Optional parameters for the request.

Returns:

TagPolicyResponse

Throws:

ApiException - if fails to make API call

getTagPolicyAsync

public CompletableFuture<TagPolicyResponse> getTagPolicyAsync(String policyId,
                                                              TagPoliciesApi.GetTagPolicyOptionalParameters parameters)

Get a tag policy.

See getTagPolicyWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.GetTagPolicyOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<TagPolicyResponse>

getTagPolicyWithHttpInfo

public ApiResponse<TagPolicyResponse> getTagPolicyWithHttpInfo(String policyId,
                                                               TagPoliciesApi.GetTagPolicyOptionalParameters parameters)
                                                        throws ApiException

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

Parameters:

policyId - The unique identifier of the tag policy. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<TagPolicyResponse>

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	-

getTagPolicyWithHttpInfoAsync

public CompletableFuture<ApiResponse<TagPolicyResponse>> getTagPolicyWithHttpInfoAsync(String policyId,
                                                                                       TagPoliciesApi.GetTagPolicyOptionalParameters parameters)

Get a tag policy.

See getTagPolicyWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.GetTagPolicyOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<TagPolicyResponse>>

getTagPolicyScore

public TagPolicyScoreResponse getTagPolicyScore(String policyId)
                                         throws ApiException

Get a tag policy compliance score.

See getTagPolicyScoreWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.GetTagPolicyScoreOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy. (required)

Returns:

TagPolicyScoreResponse

Throws:

ApiException - if fails to make API call

getTagPolicyScoreAsync

public CompletableFuture<TagPolicyScoreResponse> getTagPolicyScoreAsync(String policyId)

Get a tag policy compliance score.

See getTagPolicyScoreWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.GetTagPolicyScoreOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy. (required)

Returns:

CompletableFuture<TagPolicyScoreResponse>

getTagPolicyScore

public TagPolicyScoreResponse getTagPolicyScore(String policyId,
                                                TagPoliciesApi.GetTagPolicyScoreOptionalParameters parameters)
                                         throws ApiException

Get a tag policy compliance score.

See getTagPolicyScoreWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.GetTagPolicyScoreOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy. (required)

parameters - Optional parameters for the request.

Returns:

TagPolicyScoreResponse

Throws:

ApiException - if fails to make API call

getTagPolicyScoreAsync

public CompletableFuture<TagPolicyScoreResponse> getTagPolicyScoreAsync(String policyId,
                                                                        TagPoliciesApi.GetTagPolicyScoreOptionalParameters parameters)

Get a tag policy compliance score.

See getTagPolicyScoreWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.GetTagPolicyScoreOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<TagPolicyScoreResponse>

getTagPolicyScoreWithHttpInfo

public ApiResponse<TagPolicyScoreResponse> getTagPolicyScoreWithHttpInfo(String policyId,
                                                                         TagPoliciesApi.GetTagPolicyScoreOptionalParameters parameters)
                                                                  throws ApiException

Retrieve the compliance score for a single tag policy. 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 policy. A null score indicates that no relevant telemetry was found.

Parameters:

policyId - The unique identifier of the tag policy. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<TagPolicyScoreResponse>

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	-

getTagPolicyScoreWithHttpInfoAsync

public CompletableFuture<ApiResponse<TagPolicyScoreResponse>> getTagPolicyScoreWithHttpInfoAsync(String policyId,
                                                                                                 TagPoliciesApi.GetTagPolicyScoreOptionalParameters parameters)

Get a tag policy compliance score.

See getTagPolicyScoreWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.TagPoliciesApi.GetTagPolicyScoreOptionalParameters).

Parameters:

policyId - The unique identifier of the tag policy. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<TagPolicyScoreResponse>>

listTagPolicies

public TagPoliciesListResponse listTagPolicies()
                                        throws ApiException

List tag policies.

See listTagPoliciesWithHttpInfo(com.datadog.api.client.v2.api.TagPoliciesApi.ListTagPoliciesOptionalParameters).

Returns:

TagPoliciesListResponse

Throws:

ApiException - if fails to make API call

listTagPoliciesAsync

public CompletableFuture<TagPoliciesListResponse> listTagPoliciesAsync()

List tag policies.

See listTagPoliciesWithHttpInfoAsync(com.datadog.api.client.v2.api.TagPoliciesApi.ListTagPoliciesOptionalParameters).

Returns:

CompletableFuture<TagPoliciesListResponse>

listTagPolicies

public TagPoliciesListResponse listTagPolicies(TagPoliciesApi.ListTagPoliciesOptionalParameters parameters)
                                        throws ApiException

List tag policies.

See listTagPoliciesWithHttpInfo(com.datadog.api.client.v2.api.TagPoliciesApi.ListTagPoliciesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

TagPoliciesListResponse

Throws:

ApiException - if fails to make API call

listTagPoliciesAsync

public CompletableFuture<TagPoliciesListResponse> listTagPoliciesAsync(TagPoliciesApi.ListTagPoliciesOptionalParameters parameters)

List tag policies.

See listTagPoliciesWithHttpInfoAsync(com.datadog.api.client.v2.api.TagPoliciesApi.ListTagPoliciesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<TagPoliciesListResponse>

listTagPoliciesWithHttpInfo

public ApiResponse<TagPoliciesListResponse> listTagPoliciesWithHttpInfo(TagPoliciesApi.ListTagPoliciesOptionalParameters parameters)
                                                                 throws ApiException

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

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<TagPoliciesListResponse>

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	-

listTagPoliciesWithHttpInfoAsync

public CompletableFuture<ApiResponse<TagPoliciesListResponse>> listTagPoliciesWithHttpInfoAsync(TagPoliciesApi.ListTagPoliciesOptionalParameters parameters)

List tag policies.

See listTagPoliciesWithHttpInfo(com.datadog.api.client.v2.api.TagPoliciesApi.ListTagPoliciesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<TagPoliciesListResponse>>

updateTagPolicy

public TagPolicyResponse updateTagPolicy(String policyId,
                                         TagPolicyUpdateRequest body)
                                  throws ApiException

Update a tag policy.

See updateTagPolicyWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.TagPolicyUpdateRequest).

Parameters:

policyId - The unique identifier of the tag policy to update. (required)

body - (required)

Returns:

TagPolicyResponse

Throws:

ApiException - if fails to make API call

updateTagPolicyAsync

public CompletableFuture<TagPolicyResponse> updateTagPolicyAsync(String policyId,
                                                                 TagPolicyUpdateRequest body)

Update a tag policy.

See updateTagPolicyWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.TagPolicyUpdateRequest).

Parameters:

policyId - The unique identifier of the tag policy to update. (required)

body - (required)

Returns:

CompletableFuture<TagPolicyResponse>

updateTagPolicyWithHttpInfo

public ApiResponse<TagPolicyResponse> updateTagPolicyWithHttpInfo(String policyId,
                                                                  TagPolicyUpdateRequest body)
                                                           throws ApiException

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

Parameters:

policyId - The unique identifier of the tag policy to update. (required)

body - (required)

Returns:

ApiResponse<TagPolicyResponse>

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	-

updateTagPolicyWithHttpInfoAsync

public CompletableFuture<ApiResponse<TagPolicyResponse>> updateTagPolicyWithHttpInfoAsync(String policyId,
                                                                                          TagPolicyUpdateRequest body)

Update a tag policy.

See updateTagPolicyWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.TagPolicyUpdateRequest).

Parameters:

policyId - The unique identifier of the tag policy to update. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<TagPolicyResponse>>