Globus Flows

class globus_sdk.FlowsClient(*, environment: Optional[str] = None, base_url: Optional[str] = None, authorizer: Optional[globus_sdk.authorizers.base.GlobusAuthorizer] = None, app_name: Optional[str] = None, transport_params: Optional[Dict[str, Any]] = None)[source]

Bases: globus_sdk.client.BaseClient

Client for the Globus Flows API.

Methods

list_flows(*, filter_role: Optional[str] = None, filter_fulltext: Optional[str] = None, query_params: Optional[Dict[str, Any]] = None) → globus_sdk.services.flows.response.IterableFlowsResponse[source]

List deployed Flows

Parameters

  • filter_role (str, optional) – A role name specifying the minimum permissions required for a Flow to be included in the response.

  • filter_fulltext (str, optional) – A string to use in a full-text search to filter results

  • query_params (dict, optional) – Any additional parameters to be passed through as query params.

Role Values

The valid values for role are, in order of precedence for filter_role:

  • flow_viewer

  • flow_starter

  • flow_administrator

  • flow_owner

For example, if flow_starter is specified then flows for which the user has the flow_starter, flow_administrator or flow_owner roles will be returned.

External Documentation

See List Flows in the API documentation for details.

Client Errors

When an error occurs, a FlowsClient will raise a FlowsAPIError.

class globus_sdk.FlowsAPIError(r: requests.models.Response, *args: Any, **kwargs: Any)[source]

Bases: globus_sdk.exc.api.GlobusAPIError

Error class to represent error responses from Flows.