Package com.datadog.api.client.v1.api
Class MonitorsApi.ListMonitorsOptionalParameters
java.lang.Object
com.datadog.api.client.v1.api.MonitorsApi.ListMonitorsOptionalParameters
- Enclosing class:
- MonitorsApi
Manage optional parameters to listMonitors.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongroupStates(String groupStates) Set groupStates.Set idOffset.monitorTags(String monitorTags) Set monitorTags.Set name.Set page.Set pageSize.Set tags.withDowntimes(Boolean withDowntimes) Set withDowntimes.
-
Constructor Details
-
ListMonitorsOptionalParameters
public ListMonitorsOptionalParameters()
-
-
Method Details
-
groupStates
Set groupStates.- Parameters:
groupStates- When specified, shows additional information about the group states. Choose one or more fromall,alert,warn, andno data. (optional)- Returns:
- ListMonitorsOptionalParameters
-
name
Set name.- Parameters:
name- A string to filter monitors by name. (optional)- Returns:
- ListMonitorsOptionalParameters
-
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
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
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
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
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
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 apage_sizelimit. However, if page is specified andpage_sizeis not, the argument defaults to 100. (optional, default to 100)- Returns:
- ListMonitorsOptionalParameters
-