com.datadog.api.client.v1.api

Class TagsApi

java.lang.Object

com.datadog.api.client.v1.api.TagsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TagsApi.CreateHostTagsOptionalParameters Manage optional parameters to createHostTags.
static class	TagsApi.DeleteHostTagsOptionalParameters Manage optional parameters to deleteHostTags.
static class	TagsApi.GetHostTagsOptionalParameters Manage optional parameters to getHostTags.
static class	TagsApi.ListHostTagsOptionalParameters Manage optional parameters to listHostTags.
static class	TagsApi.UpdateHostTagsOptionalParameters Manage optional parameters to updateHostTags.

Constructor Summary

Constructors

Constructor and Description
TagsApi()
TagsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
HostTags	createHostTags(String hostName, HostTags body) Add tags to a host.
HostTags	createHostTags(String hostName, HostTags body, TagsApi.CreateHostTagsOptionalParameters parameters) Add tags to a host.
CompletableFuture<HostTags>	createHostTagsAsync(String hostName, HostTags body) Add tags to a host.
CompletableFuture<HostTags>	createHostTagsAsync(String hostName, HostTags body, TagsApi.CreateHostTagsOptionalParameters parameters) Add tags to a host.
ApiResponse<HostTags>	createHostTagsWithHttpInfo(String hostName, HostTags body, TagsApi.CreateHostTagsOptionalParameters parameters) This endpoint allows you to add new tags to a host, optionally specifying what source these tags come from.
CompletableFuture<ApiResponse<HostTags>>	createHostTagsWithHttpInfoAsync(String hostName, HostTags body, TagsApi.CreateHostTagsOptionalParameters parameters) Add tags to a host.
void	deleteHostTags(String hostName) Remove host tags.
void	deleteHostTags(String hostName, TagsApi.DeleteHostTagsOptionalParameters parameters) Remove host tags.
CompletableFuture<Void>	deleteHostTagsAsync(String hostName) Remove host tags.
CompletableFuture<Void>	deleteHostTagsAsync(String hostName, TagsApi.DeleteHostTagsOptionalParameters parameters) Remove host tags.
ApiResponse<Void>	deleteHostTagsWithHttpInfo(String hostName, TagsApi.DeleteHostTagsOptionalParameters parameters) This endpoint allows you to remove all tags for a single host.
CompletableFuture<ApiResponse<Void>>	deleteHostTagsWithHttpInfoAsync(String hostName, TagsApi.DeleteHostTagsOptionalParameters parameters) Remove host tags.
ApiClient	getApiClient() Get the API client.
HostTags	getHostTags(String hostName) Get Host Tags.
HostTags	getHostTags(String hostName, TagsApi.GetHostTagsOptionalParameters parameters) Get Host Tags.
CompletableFuture<HostTags>	getHostTagsAsync(String hostName) Get Host Tags.
CompletableFuture<HostTags>	getHostTagsAsync(String hostName, TagsApi.GetHostTagsOptionalParameters parameters) Get Host Tags.
ApiResponse<HostTags>	getHostTagsWithHttpInfo(String hostName, TagsApi.GetHostTagsOptionalParameters parameters) Return the list of tags that apply to a given host.
CompletableFuture<ApiResponse<HostTags>>	getHostTagsWithHttpInfoAsync(String hostName, TagsApi.GetHostTagsOptionalParameters parameters) Get Host Tags.
TagToHosts	listHostTags() Get All Host Tags.
TagToHosts	listHostTags(TagsApi.ListHostTagsOptionalParameters parameters) Get All Host Tags.
CompletableFuture<TagToHosts>	listHostTagsAsync() Get All Host Tags.
CompletableFuture<TagToHosts>	listHostTagsAsync(TagsApi.ListHostTagsOptionalParameters parameters) Get All Host Tags.
ApiResponse<TagToHosts>	listHostTagsWithHttpInfo(TagsApi.ListHostTagsOptionalParameters parameters) Returns a mapping of tags to hosts.
CompletableFuture<ApiResponse<TagToHosts>>	listHostTagsWithHttpInfoAsync(TagsApi.ListHostTagsOptionalParameters parameters) Get All Host Tags.
void	setApiClient(ApiClient apiClient) Set the API client.
HostTags	updateHostTags(String hostName, HostTags body) Update host tags.
HostTags	updateHostTags(String hostName, HostTags body, TagsApi.UpdateHostTagsOptionalParameters parameters) Update host tags.
CompletableFuture<HostTags>	updateHostTagsAsync(String hostName, HostTags body) Update host tags.
CompletableFuture<HostTags>	updateHostTagsAsync(String hostName, HostTags body, TagsApi.UpdateHostTagsOptionalParameters parameters) Update host tags.
ApiResponse<HostTags>	updateHostTagsWithHttpInfo(String hostName, HostTags body, TagsApi.UpdateHostTagsOptionalParameters parameters) This endpoint allows you to update/replace all tags in an integration source with those supplied in the request.
CompletableFuture<ApiResponse<HostTags>>	updateHostTagsWithHttpInfoAsync(String hostName, HostTags body, TagsApi.UpdateHostTagsOptionalParameters parameters) Update host tags.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagsApi

public TagsApi()

TagsApi

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

createHostTags

public HostTags createHostTags(String hostName,
                               HostTags body)
                        throws ApiException

Add tags to a host.

See createHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.HostTags, com.datadog.api.client.v1.api.TagsApi.CreateHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to add new tags (required)

body - Update host tags request body. (required)

Returns:

HostTags

Throws:

ApiException - if fails to make API call

createHostTagsAsync

public CompletableFuture<HostTags> createHostTagsAsync(String hostName,
                                                       HostTags body)

Add tags to a host.

See createHostTagsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.HostTags, com.datadog.api.client.v1.api.TagsApi.CreateHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to add new tags (required)

body - Update host tags request body. (required)

Returns:

CompletableFuture<HostTags>

createHostTags

public HostTags createHostTags(String hostName,
                               HostTags body,
                               TagsApi.CreateHostTagsOptionalParameters parameters)
                        throws ApiException

Add tags to a host.

See createHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.HostTags, com.datadog.api.client.v1.api.TagsApi.CreateHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to add new tags (required)

body - Update host tags request body. (required)

parameters - Optional parameters for the request.

Returns:

HostTags

Throws:

ApiException - if fails to make API call

createHostTagsAsync

public CompletableFuture<HostTags> createHostTagsAsync(String hostName,
                                                       HostTags body,
                                                       TagsApi.CreateHostTagsOptionalParameters parameters)

Add tags to a host.

See createHostTagsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.HostTags, com.datadog.api.client.v1.api.TagsApi.CreateHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to add new tags (required)

body - Update host tags request body. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<HostTags>

createHostTagsWithHttpInfo

public ApiResponse<HostTags> createHostTagsWithHttpInfo(String hostName,
                                                        HostTags body,
                                                        TagsApi.CreateHostTagsOptionalParameters parameters)
                                                 throws ApiException

This endpoint allows you to add new tags to a host, optionally specifying what source these tags come from. If tags already exist, appends new tags to the tag list. If no source is specified, defaults to "user".

Parameters:

hostName - Specified host name to add new tags (required)

body - Update host tags request body. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<HostTags>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
201	Created	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

createHostTagsWithHttpInfoAsync

public CompletableFuture<ApiResponse<HostTags>> createHostTagsWithHttpInfoAsync(String hostName,
                                                                                HostTags body,
                                                                                TagsApi.CreateHostTagsOptionalParameters parameters)

Add tags to a host.

See createHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.HostTags, com.datadog.api.client.v1.api.TagsApi.CreateHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to add new tags (required)

body - Update host tags request body. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<HostTags>>

deleteHostTags

public void deleteHostTags(String hostName)
                    throws ApiException

Remove host tags.

See deleteHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.TagsApi.DeleteHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to delete tags (required)

Throws:

ApiException - if fails to make API call

deleteHostTagsAsync

public CompletableFuture<Void> deleteHostTagsAsync(String hostName)

Remove host tags.

See deleteHostTagsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.api.TagsApi.DeleteHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to delete tags (required)

Returns:

CompletableFuture

deleteHostTags

public void deleteHostTags(String hostName,
                           TagsApi.DeleteHostTagsOptionalParameters parameters)
                    throws ApiException

Remove host tags.

See deleteHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.TagsApi.DeleteHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to delete tags (required)

parameters - Optional parameters for the request.

Throws:

ApiException - if fails to make API call

deleteHostTagsAsync

public CompletableFuture<Void> deleteHostTagsAsync(String hostName,
                                                   TagsApi.DeleteHostTagsOptionalParameters parameters)

Remove host tags.

See deleteHostTagsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.api.TagsApi.DeleteHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to delete tags (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture

deleteHostTagsWithHttpInfo

public ApiResponse<Void> deleteHostTagsWithHttpInfo(String hostName,
                                                    TagsApi.DeleteHostTagsOptionalParameters parameters)
                                             throws ApiException

This endpoint allows you to remove all tags for a single host. If no source is specified, only deletes from the source "User".

Parameters:

hostName - Specified host name to delete tags (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	OK	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

deleteHostTagsWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteHostTagsWithHttpInfoAsync(String hostName,
                                                                            TagsApi.DeleteHostTagsOptionalParameters parameters)

Remove host tags.

See deleteHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.TagsApi.DeleteHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to delete tags (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<Void>>

getHostTags

public HostTags getHostTags(String hostName)
                     throws ApiException

Get Host Tags.

See getHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.TagsApi.GetHostTagsOptionalParameters).

Parameters:

hostName - Name of the host to retrieve tags for (required)

Returns:

HostTags

Throws:

ApiException - if fails to make API call

getHostTagsAsync

public CompletableFuture<HostTags> getHostTagsAsync(String hostName)

Get Host Tags.

See getHostTagsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.api.TagsApi.GetHostTagsOptionalParameters).

Parameters:

hostName - Name of the host to retrieve tags for (required)

Returns:

CompletableFuture<HostTags>

getHostTags

public HostTags getHostTags(String hostName,
                            TagsApi.GetHostTagsOptionalParameters parameters)
                     throws ApiException

Get Host Tags.

See getHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.TagsApi.GetHostTagsOptionalParameters).

Parameters:

hostName - Name of the host to retrieve tags for (required)

parameters - Optional parameters for the request.

Returns:

HostTags

Throws:

ApiException - if fails to make API call

getHostTagsAsync

public CompletableFuture<HostTags> getHostTagsAsync(String hostName,
                                                    TagsApi.GetHostTagsOptionalParameters parameters)

Get Host Tags.

See getHostTagsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.api.TagsApi.GetHostTagsOptionalParameters).

Parameters:

hostName - Name of the host to retrieve tags for (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<HostTags>

getHostTagsWithHttpInfo

public ApiResponse<HostTags> getHostTagsWithHttpInfo(String hostName,
                                                     TagsApi.GetHostTagsOptionalParameters parameters)
                                              throws ApiException

Return the list of tags that apply to a given host.

Parameters:

hostName - Name of the host to retrieve tags for (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<HostTags>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

getHostTagsWithHttpInfoAsync

public CompletableFuture<ApiResponse<HostTags>> getHostTagsWithHttpInfoAsync(String hostName,
                                                                             TagsApi.GetHostTagsOptionalParameters parameters)

Get Host Tags.

See getHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.TagsApi.GetHostTagsOptionalParameters).

Parameters:

hostName - Name of the host to retrieve tags for (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<HostTags>>

listHostTags

public TagToHosts listHostTags()
                        throws ApiException

Get All Host Tags.

See listHostTagsWithHttpInfo(com.datadog.api.client.v1.api.TagsApi.ListHostTagsOptionalParameters).

Returns:

TagToHosts

Throws:

ApiException - if fails to make API call

listHostTagsAsync

public CompletableFuture<TagToHosts> listHostTagsAsync()

Get All Host Tags.

See listHostTagsWithHttpInfoAsync(com.datadog.api.client.v1.api.TagsApi.ListHostTagsOptionalParameters).

Returns:

CompletableFuture<TagToHosts>

listHostTags

public TagToHosts listHostTags(TagsApi.ListHostTagsOptionalParameters parameters)
                        throws ApiException

Get All Host Tags.

See listHostTagsWithHttpInfo(com.datadog.api.client.v1.api.TagsApi.ListHostTagsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

TagToHosts

Throws:

ApiException - if fails to make API call

listHostTagsAsync

public CompletableFuture<TagToHosts> listHostTagsAsync(TagsApi.ListHostTagsOptionalParameters parameters)

Get All Host Tags.

See listHostTagsWithHttpInfoAsync(com.datadog.api.client.v1.api.TagsApi.ListHostTagsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<TagToHosts>

listHostTagsWithHttpInfo

public ApiResponse<TagToHosts> listHostTagsWithHttpInfo(TagsApi.ListHostTagsOptionalParameters parameters)
                                                 throws ApiException

Returns a mapping of tags to hosts. For each tag, the response returns a list of host names that contain this tag. There is a restriction of 10k total host names from the org that can be attached to tags and returned.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<TagToHosts>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

listHostTagsWithHttpInfoAsync

public CompletableFuture<ApiResponse<TagToHosts>> listHostTagsWithHttpInfoAsync(TagsApi.ListHostTagsOptionalParameters parameters)

Get All Host Tags.

See listHostTagsWithHttpInfo(com.datadog.api.client.v1.api.TagsApi.ListHostTagsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<TagToHosts>>

updateHostTags

public HostTags updateHostTags(String hostName,
                               HostTags body)
                        throws ApiException

Update host tags.

See updateHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.HostTags, com.datadog.api.client.v1.api.TagsApi.UpdateHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to change tags (required)

body - Add tags to host (required)

Returns:

HostTags

Throws:

ApiException - if fails to make API call

updateHostTagsAsync

public CompletableFuture<HostTags> updateHostTagsAsync(String hostName,
                                                       HostTags body)

Update host tags.

See updateHostTagsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.HostTags, com.datadog.api.client.v1.api.TagsApi.UpdateHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to change tags (required)

body - Add tags to host (required)

Returns:

CompletableFuture<HostTags>

updateHostTags

public HostTags updateHostTags(String hostName,
                               HostTags body,
                               TagsApi.UpdateHostTagsOptionalParameters parameters)
                        throws ApiException

Update host tags.

See updateHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.HostTags, com.datadog.api.client.v1.api.TagsApi.UpdateHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to change tags (required)

body - Add tags to host (required)

parameters - Optional parameters for the request.

Returns:

HostTags

Throws:

ApiException - if fails to make API call

updateHostTagsAsync

public CompletableFuture<HostTags> updateHostTagsAsync(String hostName,
                                                       HostTags body,
                                                       TagsApi.UpdateHostTagsOptionalParameters parameters)

Update host tags.

See updateHostTagsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.HostTags, com.datadog.api.client.v1.api.TagsApi.UpdateHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to change tags (required)

body - Add tags to host (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<HostTags>

updateHostTagsWithHttpInfo

public ApiResponse<HostTags> updateHostTagsWithHttpInfo(String hostName,
                                                        HostTags body,
                                                        TagsApi.UpdateHostTagsOptionalParameters parameters)
                                                 throws ApiException

This endpoint allows you to update/replace all tags in an integration source with those supplied in the request.

Parameters:

hostName - Specified host name to change tags (required)

body - Add tags to host (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<HostTags>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
201	OK	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

updateHostTagsWithHttpInfoAsync

public CompletableFuture<ApiResponse<HostTags>> updateHostTagsWithHttpInfoAsync(String hostName,
                                                                                HostTags body,
                                                                                TagsApi.UpdateHostTagsOptionalParameters parameters)

Update host tags.

See updateHostTagsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.HostTags, com.datadog.api.client.v1.api.TagsApi.UpdateHostTagsOptionalParameters).

Parameters:

hostName - Specified host name to change tags (required)

body - Add tags to host (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<HostTags>>