com.datadog.api.client.v1.api

Class HostsApi

java.lang.Object

com.datadog.api.client.v1.api.HostsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HostsApi.GetHostTotalsOptionalParameters Manage optional parameters to getHostTotals.
static class	HostsApi.ListHostsOptionalParameters Manage optional parameters to listHosts.

Constructor Summary

Constructors

Constructor and Description
HostsApi()
HostsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient() Get the API client.
HostTotals	getHostTotals() Get the total number of active hosts.
HostTotals	getHostTotals(HostsApi.GetHostTotalsOptionalParameters parameters) Get the total number of active hosts.
CompletableFuture<HostTotals>	getHostTotalsAsync() Get the total number of active hosts.
CompletableFuture<HostTotals>	getHostTotalsAsync(HostsApi.GetHostTotalsOptionalParameters parameters) Get the total number of active hosts.
ApiResponse<HostTotals>	getHostTotalsWithHttpInfo(HostsApi.GetHostTotalsOptionalParameters parameters) This endpoint returns the total number of active and up hosts in your Datadog account.
CompletableFuture<ApiResponse<HostTotals>>	getHostTotalsWithHttpInfoAsync(HostsApi.GetHostTotalsOptionalParameters parameters) Get the total number of active hosts.
HostListResponse	listHosts() Get all hosts for your organization.
HostListResponse	listHosts(HostsApi.ListHostsOptionalParameters parameters) Get all hosts for your organization.
CompletableFuture<HostListResponse>	listHostsAsync() Get all hosts for your organization.
CompletableFuture<HostListResponse>	listHostsAsync(HostsApi.ListHostsOptionalParameters parameters) Get all hosts for your organization.
ApiResponse<HostListResponse>	listHostsWithHttpInfo(HostsApi.ListHostsOptionalParameters parameters) This endpoint allows searching for hosts by name, alias, or tag.
CompletableFuture<ApiResponse<HostListResponse>>	listHostsWithHttpInfoAsync(HostsApi.ListHostsOptionalParameters parameters) Get all hosts for your organization.
HostMuteResponse	muteHost(String hostName, HostMuteSettings body) Mute a host.
CompletableFuture<HostMuteResponse>	muteHostAsync(String hostName, HostMuteSettings body) Mute a host.
ApiResponse<HostMuteResponse>	muteHostWithHttpInfo(String hostName, HostMuteSettings body) Mute a host.
CompletableFuture<ApiResponse<HostMuteResponse>>	muteHostWithHttpInfoAsync(String hostName, HostMuteSettings body) Mute a host.
void	setApiClient(ApiClient apiClient) Set the API client.
HostMuteResponse	unmuteHost(String hostName) Unmute a host.
CompletableFuture<HostMuteResponse>	unmuteHostAsync(String hostName) Unmute a host.
ApiResponse<HostMuteResponse>	unmuteHostWithHttpInfo(String hostName) Unmutes a host.
CompletableFuture<ApiResponse<HostMuteResponse>>	unmuteHostWithHttpInfoAsync(String hostName) Unmute a host.

Methods inherited from class java.lang.Object

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

Constructor Detail

HostsApi

public HostsApi()

HostsApi

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

getHostTotals

public HostTotals getHostTotals()
                         throws ApiException

Get the total number of active hosts.

See getHostTotalsWithHttpInfo(com.datadog.api.client.v1.api.HostsApi.GetHostTotalsOptionalParameters).

Returns:

HostTotals

Throws:

ApiException - if fails to make API call

getHostTotalsAsync

public CompletableFuture<HostTotals> getHostTotalsAsync()

Get the total number of active hosts.

See getHostTotalsWithHttpInfoAsync(com.datadog.api.client.v1.api.HostsApi.GetHostTotalsOptionalParameters).

Returns:

CompletableFuture<HostTotals>

getHostTotals

public HostTotals getHostTotals(HostsApi.GetHostTotalsOptionalParameters parameters)
                         throws ApiException

Get the total number of active hosts.

See getHostTotalsWithHttpInfo(com.datadog.api.client.v1.api.HostsApi.GetHostTotalsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

HostTotals

Throws:

ApiException - if fails to make API call

getHostTotalsAsync

public CompletableFuture<HostTotals> getHostTotalsAsync(HostsApi.GetHostTotalsOptionalParameters parameters)

Get the total number of active hosts.

See getHostTotalsWithHttpInfoAsync(com.datadog.api.client.v1.api.HostsApi.GetHostTotalsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<HostTotals>

getHostTotalsWithHttpInfo

public ApiResponse<HostTotals> getHostTotalsWithHttpInfo(HostsApi.GetHostTotalsOptionalParameters parameters)
                                                  throws ApiException

This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<HostTotals>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Invalid Parameter Error	-
403	Forbidden	-
429	Too many requests	-

getHostTotalsWithHttpInfoAsync

public CompletableFuture<ApiResponse<HostTotals>> getHostTotalsWithHttpInfoAsync(HostsApi.GetHostTotalsOptionalParameters parameters)

Get the total number of active hosts.

See getHostTotalsWithHttpInfo(com.datadog.api.client.v1.api.HostsApi.GetHostTotalsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<HostTotals>>

listHosts

public HostListResponse listHosts()
                           throws ApiException

Get all hosts for your organization.

See listHostsWithHttpInfo(com.datadog.api.client.v1.api.HostsApi.ListHostsOptionalParameters).

Returns:

HostListResponse

Throws:

ApiException - if fails to make API call

listHostsAsync

public CompletableFuture<HostListResponse> listHostsAsync()

Get all hosts for your organization.

See listHostsWithHttpInfoAsync(com.datadog.api.client.v1.api.HostsApi.ListHostsOptionalParameters).

Returns:

CompletableFuture<HostListResponse>

listHosts

public HostListResponse listHosts(HostsApi.ListHostsOptionalParameters parameters)
                           throws ApiException

Get all hosts for your organization.

See listHostsWithHttpInfo(com.datadog.api.client.v1.api.HostsApi.ListHostsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

HostListResponse

Throws:

ApiException - if fails to make API call

listHostsAsync

public CompletableFuture<HostListResponse> listHostsAsync(HostsApi.ListHostsOptionalParameters parameters)

Get all hosts for your organization.

See listHostsWithHttpInfoAsync(com.datadog.api.client.v1.api.HostsApi.ListHostsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<HostListResponse>

listHostsWithHttpInfo

public ApiResponse<HostListResponse> listHostsWithHttpInfo(HostsApi.ListHostsOptionalParameters parameters)
                                                    throws ApiException

This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included by default. Retention is 7 days. Results are paginated with a max of 1000 results at a time.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<HostListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Invalid Parameter Error	-
403	Forbidden	-
429	Too many requests	-

listHostsWithHttpInfoAsync

public CompletableFuture<ApiResponse<HostListResponse>> listHostsWithHttpInfoAsync(HostsApi.ListHostsOptionalParameters parameters)

Get all hosts for your organization.

See listHostsWithHttpInfo(com.datadog.api.client.v1.api.HostsApi.ListHostsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<HostListResponse>>

muteHost

public HostMuteResponse muteHost(String hostName,
                                 HostMuteSettings body)
                          throws ApiException

Mute a host.

See muteHostWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.HostMuteSettings).

Parameters:

hostName - Name of the host to mute. (required)

body - Mute a host request body. (required)

Returns:

HostMuteResponse

Throws:

ApiException - if fails to make API call

muteHostAsync

public CompletableFuture<HostMuteResponse> muteHostAsync(String hostName,
                                                         HostMuteSettings body)

Mute a host.

See muteHostWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.HostMuteSettings).

Parameters:

hostName - Name of the host to mute. (required)

body - Mute a host request body. (required)

Returns:

CompletableFuture<HostMuteResponse>

muteHostWithHttpInfo

public ApiResponse<HostMuteResponse> muteHostWithHttpInfo(String hostName,
                                                          HostMuteSettings body)
                                                   throws ApiException

Mute a host. Note: This creates a Downtime V2 for the host.

Parameters:

hostName - Name of the host to mute. (required)

body - Mute a host request body. (required)

Returns:

ApiResponse<HostMuteResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Invalid Parameter Error	-
403	Forbidden	-
429	Too many requests	-

muteHostWithHttpInfoAsync

public CompletableFuture<ApiResponse<HostMuteResponse>> muteHostWithHttpInfoAsync(String hostName,
                                                                                  HostMuteSettings body)

Mute a host.

See muteHostWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.HostMuteSettings).

Parameters:

hostName - Name of the host to mute. (required)

body - Mute a host request body. (required)

Returns:

CompletableFuture<ApiResponse<HostMuteResponse>>

unmuteHost

public HostMuteResponse unmuteHost(String hostName)
                            throws ApiException

Unmute a host.

See unmuteHostWithHttpInfo(java.lang.String).

Parameters:

hostName - Name of the host to unmute. (required)

Returns:

HostMuteResponse

Throws:

ApiException - if fails to make API call

unmuteHostAsync

public CompletableFuture<HostMuteResponse> unmuteHostAsync(String hostName)

Unmute a host.

See unmuteHostWithHttpInfoAsync(java.lang.String).

Parameters:

hostName - Name of the host to unmute. (required)

Returns:

CompletableFuture<HostMuteResponse>

unmuteHostWithHttpInfo

public ApiResponse<HostMuteResponse> unmuteHostWithHttpInfo(String hostName)
                                                     throws ApiException

Unmutes a host. This endpoint takes no JSON arguments.

Parameters:

hostName - Name of the host to unmute. (required)

Returns:

ApiResponse<HostMuteResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Invalid Parameter Error	-
403	Forbidden	-
429	Too many requests	-

unmuteHostWithHttpInfoAsync

public CompletableFuture<ApiResponse<HostMuteResponse>> unmuteHostWithHttpInfoAsync(String hostName)

Unmute a host.

See unmuteHostWithHttpInfo(java.lang.String).

Parameters:

hostName - Name of the host to unmute. (required)

Returns:

CompletableFuture<ApiResponse<HostMuteResponse>>