com.datadog.api.client.v1.api

Class MonitorsApi.ListMonitorsOptionalParameters

java.lang.Object

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

Enclosing class:

MonitorsApi

public static class MonitorsApi.ListMonitorsOptionalParameters
extends Object

Manage optional parameters to listMonitors.

Constructor Summary

Constructors

Constructor and Description
ListMonitorsOptionalParameters()

Method Summary

Modifier and Type	Method and Description
MonitorsApi.ListMonitorsOptionalParameters	groupStates(String groupStates) Set groupStates.
MonitorsApi.ListMonitorsOptionalParameters	idOffset(Long idOffset) Set idOffset.
MonitorsApi.ListMonitorsOptionalParameters	monitorTags(String monitorTags) Set monitorTags.
MonitorsApi.ListMonitorsOptionalParameters	name(String name) Set name.
MonitorsApi.ListMonitorsOptionalParameters	page(Long page) Set page.
MonitorsApi.ListMonitorsOptionalParameters	pageSize(Integer pageSize) Set pageSize.
MonitorsApi.ListMonitorsOptionalParameters	tags(String tags) Set tags.
MonitorsApi.ListMonitorsOptionalParameters	withDowntimes(Boolean withDowntimes) Set withDowntimes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListMonitorsOptionalParameters

public ListMonitorsOptionalParameters()

Method Detail

groupStates

public MonitorsApi.ListMonitorsOptionalParameters groupStates(String groupStates)

Set groupStates.

Parameters:

groupStates - When specified, shows additional information about the group states. Choose one or more from all, alert, warn, and no data. (optional)

Returns:

ListMonitorsOptionalParameters

name

public MonitorsApi.ListMonitorsOptionalParameters name(String name)

Set name.

Parameters:

name - A string to filter monitors by name. (optional)

Returns:

ListMonitorsOptionalParameters

tags

public MonitorsApi.ListMonitorsOptionalParameters tags(String tags)

Set tags.

Parameters:

tags - A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. For example, host:host0. (optional)

Returns:

ListMonitorsOptionalParameters

monitorTags

public MonitorsApi.ListMonitorsOptionalParameters monitorTags(String monitorTags)

Set monitorTags.

Parameters:

monitorTags - A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. Tags created in the Datadog UI automatically have the service key prepended. For example, service:my-app. (optional)

Returns:

ListMonitorsOptionalParameters

withDowntimes

public MonitorsApi.ListMonitorsOptionalParameters withDowntimes(Boolean withDowntimes)

Set withDowntimes.

Parameters:

withDowntimes - If this argument is set to true, then the returned data includes all current active downtimes for each monitor. (optional)

Returns:

ListMonitorsOptionalParameters

idOffset

public MonitorsApi.ListMonitorsOptionalParameters idOffset(Long idOffset)

Set idOffset.

Parameters:

idOffset - Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty. (optional)

Returns:

ListMonitorsOptionalParameters

page

public MonitorsApi.ListMonitorsOptionalParameters page(Long page)

Set page.

Parameters:

page - The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. (optional)

Returns:

ListMonitorsOptionalParameters

pageSize

public MonitorsApi.ListMonitorsOptionalParameters pageSize(Integer pageSize)

Set pageSize.

Parameters:

pageSize - The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a page_size limit. However, if page is specified and page_size is not, the argument defaults to 100. (optional, default to 100)

Returns:

ListMonitorsOptionalParameters