com.datadog.api.client.v2.api

Class WorkflowAutomationApi.ListWorkflowsOptionalParameters

java.lang.Object

com.datadog.api.client.v2.api.WorkflowAutomationApi.ListWorkflowsOptionalParameters

Enclosing class:

WorkflowAutomationApi

public static class WorkflowAutomationApi.ListWorkflowsOptionalParameters
extends Object

Manage optional parameters to listWorkflows.

Constructor Summary

Constructors

Constructor and Description
ListWorkflowsOptionalParameters()

Method Summary

Modifier and Type	Method and Description
WorkflowAutomationApi.ListWorkflowsOptionalParameters	filterIncludeSpecs(Boolean filterIncludeSpecs) Set filterIncludeSpecs.
WorkflowAutomationApi.ListWorkflowsOptionalParameters	filterIncludeUnpublished(Boolean filterIncludeUnpublished) Set filterIncludeUnpublished.
WorkflowAutomationApi.ListWorkflowsOptionalParameters	filterQuery(String filterQuery) Set filterQuery.
WorkflowAutomationApi.ListWorkflowsOptionalParameters	filterTriggerIds(List<String> filterTriggerIds) Set filterTriggerIds.
WorkflowAutomationApi.ListWorkflowsOptionalParameters	limit(Long limit) Set limit.
WorkflowAutomationApi.ListWorkflowsOptionalParameters	page(Long page) Set page.
WorkflowAutomationApi.ListWorkflowsOptionalParameters	sort(String sort) Set sort.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListWorkflowsOptionalParameters

public ListWorkflowsOptionalParameters()

Method Detail

limit

public WorkflowAutomationApi.ListWorkflowsOptionalParameters limit(Long limit)

Set limit.

Parameters:

limit - The maximum number of workflows to return per page. (optional, default to 50)

Returns:

ListWorkflowsOptionalParameters

page

public WorkflowAutomationApi.ListWorkflowsOptionalParameters page(Long page)

Set page.

Parameters:

page - The page number to return, starting from 0. (optional, default to 0)

Returns:

ListWorkflowsOptionalParameters

sort

public WorkflowAutomationApi.ListWorkflowsOptionalParameters sort(String 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 are name, createdAt, updatedAt, creatorName, ownerName, and lastExecutedAt. (optional)

Returns:

ListWorkflowsOptionalParameters

filterQuery

public WorkflowAutomationApi.ListWorkflowsOptionalParameters filterQuery(String 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 a key:value tag 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 as monitor, schedule, or githubWebhook. 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. When false (the default), each workflow's spec is returned as null. (optional, default to false)

Returns:

ListWorkflowsOptionalParameters