Package com.datadog.api.client.v2.api
Class WorkflowAutomationApi.ListWorkflowsOptionalParameters
java.lang.Object
com.datadog.api.client.v2.api.WorkflowAutomationApi.ListWorkflowsOptionalParameters
- Enclosing class:
- WorkflowAutomationApi
Manage optional parameters to listWorkflows.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfilterIncludeSpecs(Boolean filterIncludeSpecs) Set filterIncludeSpecs.filterIncludeUnpublished(Boolean filterIncludeUnpublished) Set filterIncludeUnpublished.filterQuery(String filterQuery) Set filterQuery.filterTriggerIds(List<String> filterTriggerIds) Set filterTriggerIds.Set limit.Set page.Set sort.
-
Constructor Details
-
ListWorkflowsOptionalParameters
public ListWorkflowsOptionalParameters()
-
-
Method Details
-
limit
Set limit.- Parameters:
limit- The maximum number of workflows to return per page. (optional, default to 50)- Returns:
- ListWorkflowsOptionalParameters
-
page
Set page.- Parameters:
page- The page number to return, starting from 0. (optional, default to 0)- Returns:
- ListWorkflowsOptionalParameters
-
sort
Set sort.- Parameters:
sort- The sort order for the returned workflows. Provide a comma-separated list of fields, each optionally prefixed with-for descending order. Supported fields arename,createdAt,updatedAt,creatorName,ownerName, andlastExecutedAt. (optional)- Returns:
- ListWorkflowsOptionalParameters
-
filterQuery
Set filterQuery.- Parameters:
filterQuery- A search query used to filter the returned workflows. The query performs a case-insensitive substring match against each workflow's name, creator name, and handle. If the query contains a colon (for example,team:infra), the query is treated as akey:valuetag filter. (optional)- Returns:
- ListWorkflowsOptionalParameters
-
filterTriggerIds
public WorkflowAutomationApi.ListWorkflowsOptionalParameters filterTriggerIds(List<String> filterTriggerIds) Set filterTriggerIds.- Parameters:
filterTriggerIds- Filters the returned workflows by one or more trigger types, such asmonitor,schedule, orgithubWebhook. To specify the multiple types, repeat this parameter. (optional)- Returns:
- ListWorkflowsOptionalParameters
-
filterIncludeUnpublished
public WorkflowAutomationApi.ListWorkflowsOptionalParameters filterIncludeUnpublished(Boolean filterIncludeUnpublished) Set filterIncludeUnpublished.- Parameters:
filterIncludeUnpublished- Whether to include unpublished workflows in the response. (optional, default to false)- Returns:
- ListWorkflowsOptionalParameters
-
filterIncludeSpecs
public WorkflowAutomationApi.ListWorkflowsOptionalParameters filterIncludeSpecs(Boolean filterIncludeSpecs) Set filterIncludeSpecs.- Parameters:
filterIncludeSpecs- Whether to include the full spec of each workflow in the response. Whenfalse(the default), each workflow'sspecis returned asnull. (optional, default to false)- Returns:
- ListWorkflowsOptionalParameters
-