Workflow Executions API . projects . locations . workflows . executions . callbacks

Instance Methods

close()

Close httplib2 connections.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Returns a list of active callbacks that belong to the execution with the given name. The returned callbacks are ordered by callback ID.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns a list of active callbacks that belong to the execution with the given name. The returned callbacks are ordered by callback ID.

Args:
  parent: string, Required. Name of the execution for which the callbacks should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} (required)
  pageSize: integer, Maximum number of callbacks to return per call. The default value is 100 and is also the maximum value.
  pageToken: string, A page token, received from a previous `ListCallbacks` call. Provide this to retrieve the subsequent page. Note that pagination is applied to dynamic data. The list of callbacks returned can change between page requests if callbacks are created or deleted.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # RPC response object for the ListCallbacks method.
  "callbacks": [ # The callbacks which match the request.
    { # An instance of a Callback created by an execution.
      "availablePayloads": [ # Output only. The payloads received by the callback that have not been processed by a waiting execution step.
        "A String",
      ],
      "method": "A String", # Output only. The method accepted by the callback. For example: GET, POST, PUT.
      "name": "A String", # Output only. The resource name of the callback. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/callback/{callback}
      "waiters": "A String", # Output only. Number of execution steps waiting on this callback.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.