com.datadog.api.client.v1.api

Class MonitorsApi

java.lang.Object

com.datadog.api.client.v1.api.MonitorsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MonitorsApi.DeleteMonitorOptionalParameters Manage optional parameters to deleteMonitor.
static class	MonitorsApi.GetMonitorOptionalParameters Manage optional parameters to getMonitor.
static class	MonitorsApi.ListMonitorsOptionalParameters Manage optional parameters to listMonitors.
static class	MonitorsApi.SearchMonitorGroupsOptionalParameters Manage optional parameters to searchMonitorGroups.
static class	MonitorsApi.SearchMonitorsOptionalParameters Manage optional parameters to searchMonitors.

Constructor Summary

Constructors

Constructor and Description
MonitorsApi()
MonitorsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CheckCanDeleteMonitorResponse	checkCanDeleteMonitor(List<Long> monitorIds) Check if a monitor can be deleted.
CompletableFuture<CheckCanDeleteMonitorResponse>	checkCanDeleteMonitorAsync(List<Long> monitorIds) Check if a monitor can be deleted.
ApiResponse<CheckCanDeleteMonitorResponse>	checkCanDeleteMonitorWithHttpInfo(List<Long> monitorIds) Check if the given monitors can be deleted.
CompletableFuture<ApiResponse<CheckCanDeleteMonitorResponse>>	checkCanDeleteMonitorWithHttpInfoAsync(List<Long> monitorIds) Check if a monitor can be deleted.
Monitor	createMonitor(Monitor body) Create a monitor.
CompletableFuture<Monitor>	createMonitorAsync(Monitor body) Create a monitor.
ApiResponse<Monitor>	createMonitorWithHttpInfo(Monitor body) Create a monitor using the specified options.
CompletableFuture<ApiResponse<Monitor>>	createMonitorWithHttpInfoAsync(Monitor body) Create a monitor.
DeletedMonitor	deleteMonitor(Long monitorId) Delete a monitor.
DeletedMonitor	deleteMonitor(Long monitorId, MonitorsApi.DeleteMonitorOptionalParameters parameters) Delete a monitor.
CompletableFuture<DeletedMonitor>	deleteMonitorAsync(Long monitorId) Delete a monitor.
CompletableFuture<DeletedMonitor>	deleteMonitorAsync(Long monitorId, MonitorsApi.DeleteMonitorOptionalParameters parameters) Delete a monitor.
ApiResponse<DeletedMonitor>	deleteMonitorWithHttpInfo(Long monitorId, MonitorsApi.DeleteMonitorOptionalParameters parameters) Delete the specified monitor
CompletableFuture<ApiResponse<DeletedMonitor>>	deleteMonitorWithHttpInfoAsync(Long monitorId, MonitorsApi.DeleteMonitorOptionalParameters parameters) Delete a monitor.
ApiClient	getApiClient() Get the API client.
Monitor	getMonitor(Long monitorId) Get a monitor's details.
Monitor	getMonitor(Long monitorId, MonitorsApi.GetMonitorOptionalParameters parameters) Get a monitor's details.
CompletableFuture<Monitor>	getMonitorAsync(Long monitorId) Get a monitor's details.
CompletableFuture<Monitor>	getMonitorAsync(Long monitorId, MonitorsApi.GetMonitorOptionalParameters parameters) Get a monitor's details.
ApiResponse<Monitor>	getMonitorWithHttpInfo(Long monitorId, MonitorsApi.GetMonitorOptionalParameters parameters) Get details about the specified monitor from your organization.
CompletableFuture<ApiResponse<Monitor>>	getMonitorWithHttpInfoAsync(Long monitorId, MonitorsApi.GetMonitorOptionalParameters parameters) Get a monitor's details.
List<Monitor>	listMonitors() Get all monitor details.
List<Monitor>	listMonitors(MonitorsApi.ListMonitorsOptionalParameters parameters) Get all monitor details.
CompletableFuture<List<Monitor>>	listMonitorsAsync() Get all monitor details.
CompletableFuture<List<Monitor>>	listMonitorsAsync(MonitorsApi.ListMonitorsOptionalParameters parameters) Get all monitor details.
ApiResponse<List<Monitor>>	listMonitorsWithHttpInfo(MonitorsApi.ListMonitorsOptionalParameters parameters) Get details about the specified monitor from your organization.
CompletableFuture<ApiResponse<List<Monitor>>>	listMonitorsWithHttpInfoAsync(MonitorsApi.ListMonitorsOptionalParameters parameters) Get all monitor details.
PaginationIterable<Monitor>	listMonitorsWithPagination() Get all monitor details.
PaginationIterable<Monitor>	listMonitorsWithPagination(MonitorsApi.ListMonitorsOptionalParameters parameters) Get all monitor details.
MonitorGroupSearchResponse	searchMonitorGroups() Monitors group search.
MonitorGroupSearchResponse	searchMonitorGroups(MonitorsApi.SearchMonitorGroupsOptionalParameters parameters) Monitors group search.
CompletableFuture<MonitorGroupSearchResponse>	searchMonitorGroupsAsync() Monitors group search.
CompletableFuture<MonitorGroupSearchResponse>	searchMonitorGroupsAsync(MonitorsApi.SearchMonitorGroupsOptionalParameters parameters) Monitors group search.
ApiResponse<MonitorGroupSearchResponse>	searchMonitorGroupsWithHttpInfo(MonitorsApi.SearchMonitorGroupsOptionalParameters parameters) Search and filter your monitor groups details.
CompletableFuture<ApiResponse<MonitorGroupSearchResponse>>	searchMonitorGroupsWithHttpInfoAsync(MonitorsApi.SearchMonitorGroupsOptionalParameters parameters) Monitors group search.
MonitorSearchResponse	searchMonitors() Monitors search.
MonitorSearchResponse	searchMonitors(MonitorsApi.SearchMonitorsOptionalParameters parameters) Monitors search.
CompletableFuture<MonitorSearchResponse>	searchMonitorsAsync() Monitors search.
CompletableFuture<MonitorSearchResponse>	searchMonitorsAsync(MonitorsApi.SearchMonitorsOptionalParameters parameters) Monitors search.
ApiResponse<MonitorSearchResponse>	searchMonitorsWithHttpInfo(MonitorsApi.SearchMonitorsOptionalParameters parameters) Search and filter your monitors details.
CompletableFuture<ApiResponse<MonitorSearchResponse>>	searchMonitorsWithHttpInfoAsync(MonitorsApi.SearchMonitorsOptionalParameters parameters) Monitors search.
void	setApiClient(ApiClient apiClient) Set the API client.
Monitor	updateMonitor(Long monitorId, MonitorUpdateRequest body) Edit a monitor.
CompletableFuture<Monitor>	updateMonitorAsync(Long monitorId, MonitorUpdateRequest body) Edit a monitor.
ApiResponse<Monitor>	updateMonitorWithHttpInfo(Long monitorId, MonitorUpdateRequest body) Edit the specified monitor.
CompletableFuture<ApiResponse<Monitor>>	updateMonitorWithHttpInfoAsync(Long monitorId, MonitorUpdateRequest body) Edit a monitor.
Object	validateExistingMonitor(Long monitorId, Monitor body) Validate an existing monitor.
CompletableFuture<Object>	validateExistingMonitorAsync(Long monitorId, Monitor body) Validate an existing monitor.
ApiResponse<Object>	validateExistingMonitorWithHttpInfo(Long monitorId, Monitor body) Validate the monitor provided in the request.
CompletableFuture<ApiResponse<Object>>	validateExistingMonitorWithHttpInfoAsync(Long monitorId, Monitor body) Validate an existing monitor.
Object	validateMonitor(Monitor body) Validate a monitor.
CompletableFuture<Object>	validateMonitorAsync(Monitor body) Validate a monitor.
ApiResponse<Object>	validateMonitorWithHttpInfo(Monitor body) Validate the monitor provided in the request.
CompletableFuture<ApiResponse<Object>>	validateMonitorWithHttpInfoAsync(Monitor body) Validate a monitor.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorsApi

public MonitorsApi()

MonitorsApi

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

checkCanDeleteMonitor

public CheckCanDeleteMonitorResponse checkCanDeleteMonitor(List<Long> monitorIds)
                                                    throws ApiException

Check if a monitor can be deleted.

See checkCanDeleteMonitorWithHttpInfo(java.util.List<java.lang.Long>).

Parameters:

monitorIds - The IDs of the monitor to check. (required)

Returns:

CheckCanDeleteMonitorResponse

Throws:

ApiException - if fails to make API call

checkCanDeleteMonitorAsync

public CompletableFuture<CheckCanDeleteMonitorResponse> checkCanDeleteMonitorAsync(List<Long> monitorIds)

Check if a monitor can be deleted.

See checkCanDeleteMonitorWithHttpInfoAsync(java.util.List<java.lang.Long>).

Parameters:

monitorIds - The IDs of the monitor to check. (required)

Returns:

CompletableFuture<CheckCanDeleteMonitorResponse>

checkCanDeleteMonitorWithHttpInfo

public ApiResponse<CheckCanDeleteMonitorResponse> checkCanDeleteMonitorWithHttpInfo(List<Long> monitorIds)
                                                                             throws ApiException

Check if the given monitors can be deleted.

Parameters:

monitorIds - The IDs of the monitor to check. (required)

Returns:

ApiResponse<CheckCanDeleteMonitorResponse>

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	-
409	Deletion conflict error	-
429	Too many requests	-

checkCanDeleteMonitorWithHttpInfoAsync

public CompletableFuture<ApiResponse<CheckCanDeleteMonitorResponse>> checkCanDeleteMonitorWithHttpInfoAsync(List<Long> monitorIds)

Check if a monitor can be deleted.

See checkCanDeleteMonitorWithHttpInfo(java.util.List<java.lang.Long>).

Parameters:

monitorIds - The IDs of the monitor to check. (required)

Returns:

CompletableFuture<ApiResponse<CheckCanDeleteMonitorResponse>>

createMonitor

public Monitor createMonitor(Monitor body)
                      throws ApiException

Create a monitor.

See createMonitorWithHttpInfo(com.datadog.api.client.v1.model.Monitor).

Parameters:

body - Create a monitor request body. (required)

Returns:

Monitor

Throws:

ApiException - if fails to make API call

createMonitorAsync

public CompletableFuture<Monitor> createMonitorAsync(Monitor body)

Create a monitor.

See createMonitorWithHttpInfoAsync(com.datadog.api.client.v1.model.Monitor).

Parameters:

body - Create a monitor request body. (required)

Returns:

CompletableFuture<Monitor>

createMonitorWithHttpInfo

public ApiResponse<Monitor> createMonitorWithHttpInfo(Monitor body)
                                               throws ApiException

Create a monitor using the specified options.

Monitor Types

The type of monitor chosen from:

• anomaly: query alert
• APM: query alert or trace-analytics alert
• composite: composite
• custom: service check
• forecast: query alert
• host: service check
• integration: query alert or service check
• live process: process alert
• logs: log alert
• metric: query alert
• network: service check
• outlier: query alert
• process: service check
• rum: rum alert
• SLO: slo alert
• watchdog: event-v2 alert
• event-v2: event-v2 alert
• audit: audit alert
• error-tracking: error-tracking alert
• database-monitoring: database-monitoring alert
• network-performance: network-performance alert

Notes: - Synthetic monitors are created through the Synthetics API. See the Synthetics API documentation for more information. - Log monitors require an unscoped App Key.

Query Types

Metric Alert Query

Example: time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #

• time_aggr: avg, sum, max, min, change, or pct_change
• time_window: last_#m (with # between 1 and 10080 depending on the monitor type) or last_#h(with # between 1 and 168 depending on the monitor type) or last_1d, or last_1w
• space_aggr: avg, sum, min, or max
• tags: one or more tags (comma-separated), or *
• key: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert)
• operator: <, <=, >, >=, ==, or !=
• #: an integer or decimal number used to set the threshold

If you are using the _change_ or _pct_change_ time aggregator, instead use change_aggr(time_aggr(time_window), timeshift):space_aggr:metric{tags} [by {key}] operator # with:

• change_aggr change, pct_change
• time_aggr avg, sum, max, min Learn more
• time_window last_#m (between 1 and 2880 depending on the monitor type), last_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2)
• timeshift #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago

Use this to create an outlier monitor using the following query: avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0

Service Check Query

Example: "check".over(tags).last(count).by(group).count_by_status()

• check name of the check, for example datadog.agent.up
• tags one or more quoted tags (comma-separated), or "*". for example: .over("env:prod", "role:db"); over cannot be blank.
• count must be at greater than or equal to your max threshold (defined in the options). It is limited to 100. For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, count should be at least 3.
• group must be specified for check monitors. Per-check grouping is already explicitly known for some service checks. For example, Postgres integration monitors are tagged by db, host, and port, and Network monitors by host, instance, and url. See Service Checks documentation for more information.

Event Alert Query

Note: The Event Alert Query has been replaced by the Event V2 Alert Query. For more information, see the Event Migration guide.

Event V2 Alert Query

Example: events(query).rollup(rollup_method[, measure]).last(time_window) operator #

• query The search query - following the Log search syntax.
• rollup_method The stats roll-up method - supports count, avg and cardinality.
• measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use.
• time_window #m (between 1 and 2880), #h (between 1 and 48).
• operator <, <=, >, >=, ==, or !=.
• # an integer or decimal number used to set the threshold.

Process Alert Query

Example: processes(search).over(tags).rollup('count').last(timeframe) operator #

• search free text search string for querying processes. Matching processes match results on the Live Processes page.
• tags one or more tags (comma-separated)
• timeframe the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d
• operator <, <=, >, >=, ==, or !=
• # an integer or decimal number used to set the threshold

Logs Alert Query

Example: logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #

• query The search query - following the Log search syntax.
• index_name For multi-index organizations, the log index in which the request is performed.
• rollup_method The stats roll-up method - supports count, avg and cardinality.
• measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use.
• time_window #m (between 1 and 2880), #h (between 1 and 48).
• operator <, <=, >, >=, ==, or !=.
• # an integer or decimal number used to set the threshold.

Composite Query

Example: 12345 && 67890, where 12345 and 67890 are the IDs of non-composite monitors

• name [required, default = dynamic, based on query]: The name of the alert.
• message [required, default = dynamic, based on query]: A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same '@username' notation as events.
• tags [optional, default = empty list]: A list of tags to associate with your monitor. When getting all monitor details via the API, use the monitor_tags argument to filter results by these tags. It is only available via the API and isn't visible or editable in the Datadog UI.

SLO Alert Query

Example: error_budget("slo_id").over("time_window") operator #

• slo_id: The alphanumeric SLO ID of the SLO you are configuring the alert for.
• time_window: The time window of the SLO target you wish to alert on. Valid options: 7d, 30d, 90d.
• operator: >= or >

Audit Alert Query

Example: audits(query).rollup(rollup_method[, measure]).last(time_window) operator #

• query The search query - following the Log search syntax.
• rollup_method The stats roll-up method - supports count, avg and cardinality.
• measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use.
• time_window #m (between 1 and 2880), #h (between 1 and 48).
• operator <, <=, >, >=, ==, or !=.
• # an integer or decimal number used to set the threshold.

CI Pipelines Alert Query

Example: ci-pipelines(query).rollup(rollup_method[, measure]).last(time_window) operator #

• query The search query - following the Log search syntax.
• rollup_method The stats roll-up method - supports count, avg, and cardinality.
• measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use.
• time_window #m (between 1 and 2880), #h (between 1 and 48).
• operator <, <=, >, >=, ==, or !=.
• # an integer or decimal number used to set the threshold.

CI Tests Alert Query

Example: ci-tests(query).rollup(rollup_method[, measure]).last(time_window) operator #

• query The search query - following the Log search syntax.
• rollup_method The stats roll-up method - supports count, avg, and cardinality.
• measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use.
• time_window #m (between 1 and 2880), #h (between 1 and 48).
• operator <, <=, >, >=, ==, or !=.
• # an integer or decimal number used to set the threshold.

Error Tracking Alert Query

Example(RUM): error-tracking-rum(query).rollup(rollup_method[, measure]).last(time_window) operator # Example(APM Traces): error-tracking-traces(query).rollup(rollup_method[, measure]).last(time_window) operator #

• query The search query - following the Log search syntax.
• rollup_method The stats roll-up method - supports count, avg, and cardinality.
• measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use.
• time_window #m (between 1 and 2880), #h (between 1 and 48).
• operator <, <=, >, >=, ==, or !=.
• # an integer or decimal number used to set the threshold.

Database Monitoring Alert Query

Example: database-monitoring(query).rollup(rollup_method[, measure]).last(time_window) operator #

• query The search query - following the Log search syntax.
• rollup_method The stats roll-up method - supports count, avg, and cardinality.
• measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use.
• time_window #m (between 1 and 2880), #h (between 1 and 48).
• operator <, <=, >, >=, ==, or !=.
• # an integer or decimal number used to set the threshold.

Network Performance Alert Query

Example: network-performance(query).rollup(rollup_method[, measure]).last(time_window) operator #

• query The search query - following the Log search syntax.
• rollup_method The stats roll-up method - supports count, avg, and cardinality.
• measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use.
• time_window #m (between 1 and 2880), #h (between 1 and 48).
• operator <, <=, >, >=, ==, or !=.
• # an integer or decimal number used to set the threshold.

Parameters:

body - Create a monitor request body. (required)

Returns:

ApiResponse<Monitor>

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	-

createMonitorWithHttpInfoAsync

public CompletableFuture<ApiResponse<Monitor>> createMonitorWithHttpInfoAsync(Monitor body)

Create a monitor.

See createMonitorWithHttpInfo(com.datadog.api.client.v1.model.Monitor).

Parameters:

body - Create a monitor request body. (required)

Returns:

CompletableFuture<ApiResponse<Monitor>>

deleteMonitor

public DeletedMonitor deleteMonitor(Long monitorId)
                             throws ApiException

Delete a monitor.

See deleteMonitorWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.api.MonitorsApi.DeleteMonitorOptionalParameters).

Parameters:

monitorId - The ID of the monitor. (required)

Returns:

DeletedMonitor

Throws:

ApiException - if fails to make API call

deleteMonitorAsync

public CompletableFuture<DeletedMonitor> deleteMonitorAsync(Long monitorId)

Delete a monitor.

See deleteMonitorWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v1.api.MonitorsApi.DeleteMonitorOptionalParameters).

Parameters:

monitorId - The ID of the monitor. (required)

Returns:

CompletableFuture<DeletedMonitor>

deleteMonitor

public DeletedMonitor deleteMonitor(Long monitorId,
                                    MonitorsApi.DeleteMonitorOptionalParameters parameters)
                             throws ApiException

Delete a monitor.

See deleteMonitorWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.api.MonitorsApi.DeleteMonitorOptionalParameters).

Parameters:

monitorId - The ID of the monitor. (required)

parameters - Optional parameters for the request.

Returns:

DeletedMonitor

Throws:

ApiException - if fails to make API call

deleteMonitorAsync

public CompletableFuture<DeletedMonitor> deleteMonitorAsync(Long monitorId,
                                                            MonitorsApi.DeleteMonitorOptionalParameters parameters)

Delete a monitor.

See deleteMonitorWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v1.api.MonitorsApi.DeleteMonitorOptionalParameters).

Parameters:

monitorId - The ID of the monitor. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<DeletedMonitor>

deleteMonitorWithHttpInfo

public ApiResponse<DeletedMonitor> deleteMonitorWithHttpInfo(Long monitorId,
                                                             MonitorsApi.DeleteMonitorOptionalParameters parameters)
                                                      throws ApiException

Delete the specified monitor

Parameters:

monitorId - The ID of the monitor. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<DeletedMonitor>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Authentication error	-
403	Forbidden	-
404	Item not found error	-
429	Too many requests	-

deleteMonitorWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeletedMonitor>> deleteMonitorWithHttpInfoAsync(Long monitorId,
                                                                                     MonitorsApi.DeleteMonitorOptionalParameters parameters)

Delete a monitor.

See deleteMonitorWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.api.MonitorsApi.DeleteMonitorOptionalParameters).

Parameters:

monitorId - The ID of the monitor. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<DeletedMonitor>>

getMonitor

public Monitor getMonitor(Long monitorId)
                   throws ApiException

Get a monitor's details.

See getMonitorWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.api.MonitorsApi.GetMonitorOptionalParameters).

Parameters:

monitorId - The ID of the monitor (required)

Returns:

Monitor

Throws:

ApiException - if fails to make API call

getMonitorAsync

public CompletableFuture<Monitor> getMonitorAsync(Long monitorId)

Get a monitor's details.

See getMonitorWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v1.api.MonitorsApi.GetMonitorOptionalParameters).

Parameters:

monitorId - The ID of the monitor (required)

Returns:

CompletableFuture<Monitor>

getMonitor

public Monitor getMonitor(Long monitorId,
                          MonitorsApi.GetMonitorOptionalParameters parameters)
                   throws ApiException

Get a monitor's details.

See getMonitorWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.api.MonitorsApi.GetMonitorOptionalParameters).

Parameters:

monitorId - The ID of the monitor (required)

parameters - Optional parameters for the request.

Returns:

Monitor

Throws:

ApiException - if fails to make API call

getMonitorAsync

public CompletableFuture<Monitor> getMonitorAsync(Long monitorId,
                                                  MonitorsApi.GetMonitorOptionalParameters parameters)

Get a monitor's details.

See getMonitorWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v1.api.MonitorsApi.GetMonitorOptionalParameters).

Parameters:

monitorId - The ID of the monitor (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<Monitor>

getMonitorWithHttpInfo

public ApiResponse<Monitor> getMonitorWithHttpInfo(Long monitorId,
                                                   MonitorsApi.GetMonitorOptionalParameters parameters)
                                            throws ApiException

Get details about the specified monitor from your organization.

Parameters:

monitorId - The ID of the monitor (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<Monitor>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication error	-
404	Monitor Not Found error	-
429	Too many requests	-

getMonitorWithHttpInfoAsync

public CompletableFuture<ApiResponse<Monitor>> getMonitorWithHttpInfoAsync(Long monitorId,
                                                                           MonitorsApi.GetMonitorOptionalParameters parameters)

Get a monitor's details.

See getMonitorWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.api.MonitorsApi.GetMonitorOptionalParameters).

Parameters:

monitorId - The ID of the monitor (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<Monitor>>

listMonitors

public List<Monitor> listMonitors()
                           throws ApiException

Get all monitor details.

See listMonitorsWithHttpInfo(com.datadog.api.client.v1.api.MonitorsApi.ListMonitorsOptionalParameters).

Returns:

List<Monitor>

Throws:

ApiException - if fails to make API call

listMonitorsAsync

public CompletableFuture<List<Monitor>> listMonitorsAsync()

Get all monitor details.

See listMonitorsWithHttpInfoAsync(com.datadog.api.client.v1.api.MonitorsApi.ListMonitorsOptionalParameters).

Returns:

CompletableFuture<List<Monitor>>

listMonitors

public List<Monitor> listMonitors(MonitorsApi.ListMonitorsOptionalParameters parameters)
                           throws ApiException

Get all monitor details.

See listMonitorsWithHttpInfo(com.datadog.api.client.v1.api.MonitorsApi.ListMonitorsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

List<Monitor>

Throws:

ApiException - if fails to make API call

listMonitorsAsync

public CompletableFuture<List<Monitor>> listMonitorsAsync(MonitorsApi.ListMonitorsOptionalParameters parameters)

Get all monitor details.

See listMonitorsWithHttpInfoAsync(com.datadog.api.client.v1.api.MonitorsApi.ListMonitorsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<List<Monitor>>

listMonitorsWithPagination

public PaginationIterable<Monitor> listMonitorsWithPagination()

Get all monitor details.

See listMonitorsWithHttpInfo(com.datadog.api.client.v1.api.MonitorsApi.ListMonitorsOptionalParameters).

Returns:

PaginationIterable<Monitor>

listMonitorsWithPagination

public PaginationIterable<Monitor> listMonitorsWithPagination(MonitorsApi.ListMonitorsOptionalParameters parameters)

Get all monitor details.

See listMonitorsWithHttpInfo(com.datadog.api.client.v1.api.MonitorsApi.ListMonitorsOptionalParameters).

Returns:

List<Monitor>

listMonitorsWithHttpInfo

public ApiResponse<List<Monitor>> listMonitorsWithHttpInfo(MonitorsApi.ListMonitorsOptionalParameters parameters)
                                                    throws ApiException

Get details about the specified monitor from your organization.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<List<Monitor>>

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	-

listMonitorsWithHttpInfoAsync

public CompletableFuture<ApiResponse<List<Monitor>>> listMonitorsWithHttpInfoAsync(MonitorsApi.ListMonitorsOptionalParameters parameters)

Get all monitor details.

See listMonitorsWithHttpInfo(com.datadog.api.client.v1.api.MonitorsApi.ListMonitorsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<List<Monitor>>>

searchMonitorGroups

public MonitorGroupSearchResponse searchMonitorGroups()
                                               throws ApiException

Monitors group search.

See searchMonitorGroupsWithHttpInfo(com.datadog.api.client.v1.api.MonitorsApi.SearchMonitorGroupsOptionalParameters).

Returns:

MonitorGroupSearchResponse

Throws:

ApiException - if fails to make API call

searchMonitorGroupsAsync

public CompletableFuture<MonitorGroupSearchResponse> searchMonitorGroupsAsync()

Monitors group search.

See searchMonitorGroupsWithHttpInfoAsync(com.datadog.api.client.v1.api.MonitorsApi.SearchMonitorGroupsOptionalParameters).

Returns:

CompletableFuture<MonitorGroupSearchResponse>

searchMonitorGroups

public MonitorGroupSearchResponse searchMonitorGroups(MonitorsApi.SearchMonitorGroupsOptionalParameters parameters)
                                               throws ApiException

Monitors group search.

See searchMonitorGroupsWithHttpInfo(com.datadog.api.client.v1.api.MonitorsApi.SearchMonitorGroupsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

MonitorGroupSearchResponse

Throws:

ApiException - if fails to make API call

searchMonitorGroupsAsync

public CompletableFuture<MonitorGroupSearchResponse> searchMonitorGroupsAsync(MonitorsApi.SearchMonitorGroupsOptionalParameters parameters)

Monitors group search.

See searchMonitorGroupsWithHttpInfoAsync(com.datadog.api.client.v1.api.MonitorsApi.SearchMonitorGroupsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<MonitorGroupSearchResponse>

searchMonitorGroupsWithHttpInfo

public ApiResponse<MonitorGroupSearchResponse> searchMonitorGroupsWithHttpInfo(MonitorsApi.SearchMonitorGroupsOptionalParameters parameters)
                                                                        throws ApiException

Search and filter your monitor groups details.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<MonitorGroupSearchResponse>

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	-

searchMonitorGroupsWithHttpInfoAsync

public CompletableFuture<ApiResponse<MonitorGroupSearchResponse>> searchMonitorGroupsWithHttpInfoAsync(MonitorsApi.SearchMonitorGroupsOptionalParameters parameters)

Monitors group search.

See searchMonitorGroupsWithHttpInfo(com.datadog.api.client.v1.api.MonitorsApi.SearchMonitorGroupsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<MonitorGroupSearchResponse>>

searchMonitors

public MonitorSearchResponse searchMonitors()
                                     throws ApiException

Monitors search.

See searchMonitorsWithHttpInfo(com.datadog.api.client.v1.api.MonitorsApi.SearchMonitorsOptionalParameters).

Returns:

MonitorSearchResponse

Throws:

ApiException - if fails to make API call

searchMonitorsAsync

public CompletableFuture<MonitorSearchResponse> searchMonitorsAsync()

Monitors search.

See searchMonitorsWithHttpInfoAsync(com.datadog.api.client.v1.api.MonitorsApi.SearchMonitorsOptionalParameters).

Returns:

CompletableFuture<MonitorSearchResponse>

searchMonitors

public MonitorSearchResponse searchMonitors(MonitorsApi.SearchMonitorsOptionalParameters parameters)
                                     throws ApiException

Monitors search.

See searchMonitorsWithHttpInfo(com.datadog.api.client.v1.api.MonitorsApi.SearchMonitorsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

MonitorSearchResponse

Throws:

ApiException - if fails to make API call

searchMonitorsAsync

public CompletableFuture<MonitorSearchResponse> searchMonitorsAsync(MonitorsApi.SearchMonitorsOptionalParameters parameters)

Monitors search.

See searchMonitorsWithHttpInfoAsync(com.datadog.api.client.v1.api.MonitorsApi.SearchMonitorsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<MonitorSearchResponse>

searchMonitorsWithHttpInfo

public ApiResponse<MonitorSearchResponse> searchMonitorsWithHttpInfo(MonitorsApi.SearchMonitorsOptionalParameters parameters)
                                                              throws ApiException

Search and filter your monitors details.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<MonitorSearchResponse>

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	-

searchMonitorsWithHttpInfoAsync

public CompletableFuture<ApiResponse<MonitorSearchResponse>> searchMonitorsWithHttpInfoAsync(MonitorsApi.SearchMonitorsOptionalParameters parameters)

Monitors search.

See searchMonitorsWithHttpInfo(com.datadog.api.client.v1.api.MonitorsApi.SearchMonitorsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<MonitorSearchResponse>>

updateMonitor

public Monitor updateMonitor(Long monitorId,
                             MonitorUpdateRequest body)
                      throws ApiException

Edit a monitor.

See updateMonitorWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.model.MonitorUpdateRequest).

Parameters:

monitorId - The ID of the monitor. (required)

body - Edit a monitor request body. (required)

Returns:

Monitor

Throws:

ApiException - if fails to make API call

updateMonitorAsync

public CompletableFuture<Monitor> updateMonitorAsync(Long monitorId,
                                                     MonitorUpdateRequest body)

Edit a monitor.

See updateMonitorWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v1.model.MonitorUpdateRequest).

Parameters:

monitorId - The ID of the monitor. (required)

body - Edit a monitor request body. (required)

Returns:

CompletableFuture<Monitor>

updateMonitorWithHttpInfo

public ApiResponse<Monitor> updateMonitorWithHttpInfo(Long monitorId,
                                                      MonitorUpdateRequest body)
                                               throws ApiException

Edit the specified monitor.

Parameters:

monitorId - The ID of the monitor. (required)

body - Edit a monitor request body. (required)

Returns:

ApiResponse<Monitor>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Authentication error	-
403	Forbidden	-
404	Monitor Not Found error	-
429	Too many requests	-

updateMonitorWithHttpInfoAsync

public CompletableFuture<ApiResponse<Monitor>> updateMonitorWithHttpInfoAsync(Long monitorId,
                                                                              MonitorUpdateRequest body)

Edit a monitor.

See updateMonitorWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.model.MonitorUpdateRequest).

Parameters:

monitorId - The ID of the monitor. (required)

body - Edit a monitor request body. (required)

Returns:

CompletableFuture<ApiResponse<Monitor>>

validateExistingMonitor

public Object validateExistingMonitor(Long monitorId,
                                      Monitor body)
                               throws ApiException

Validate an existing monitor.

See validateExistingMonitorWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.model.Monitor).

Parameters:

monitorId - The ID of the monitor (required)

body - Monitor request object (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

validateExistingMonitorAsync

public CompletableFuture<Object> validateExistingMonitorAsync(Long monitorId,
                                                              Monitor body)

Validate an existing monitor.

See validateExistingMonitorWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v1.model.Monitor).

Parameters:

monitorId - The ID of the monitor (required)

body - Monitor request object (required)

Returns:

CompletableFuture<Object>

validateExistingMonitorWithHttpInfo

public ApiResponse<Object> validateExistingMonitorWithHttpInfo(Long monitorId,
                                                               Monitor body)
                                                        throws ApiException

Validate the monitor provided in the request.

Parameters:

monitorId - The ID of the monitor (required)

body - Monitor request object (required)

Returns:

ApiResponse<Object>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

validateExistingMonitorWithHttpInfoAsync

public CompletableFuture<ApiResponse<Object>> validateExistingMonitorWithHttpInfoAsync(Long monitorId,
                                                                                       Monitor body)

Validate an existing monitor.

See validateExistingMonitorWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.model.Monitor).

Parameters:

monitorId - The ID of the monitor (required)

body - Monitor request object (required)

Returns:

CompletableFuture<ApiResponse<Object>>

validateMonitor

public Object validateMonitor(Monitor body)
                       throws ApiException

Validate a monitor.

See validateMonitorWithHttpInfo(com.datadog.api.client.v1.model.Monitor).

Parameters:

body - Monitor request object (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

validateMonitorAsync

public CompletableFuture<Object> validateMonitorAsync(Monitor body)

Validate a monitor.

See validateMonitorWithHttpInfoAsync(com.datadog.api.client.v1.model.Monitor).

Parameters:

body - Monitor request object (required)

Returns:

CompletableFuture<Object>

validateMonitorWithHttpInfo

public ApiResponse<Object> validateMonitorWithHttpInfo(Monitor body)
                                                throws ApiException

Validate the monitor provided in the request.

Note: Log monitors require an unscoped App Key.

Parameters:

body - Monitor request object (required)

Returns:

ApiResponse<Object>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

validateMonitorWithHttpInfoAsync

public CompletableFuture<ApiResponse<Object>> validateMonitorWithHttpInfoAsync(Monitor body)

Validate a monitor.

See validateMonitorWithHttpInfo(com.datadog.api.client.v1.model.Monitor).

Parameters:

body - Monitor request object (required)

Returns:

CompletableFuture<ApiResponse<Object>>