Close httplib2 connections.
get(name, view=None, x__xgafv=None)
Gets a step entry.
Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.
Retrieves the next page of results.
close()
Close httplib2 connections.
get(name, view=None, x__xgafv=None)
Gets a step entry.
Args:
name: string, Required. The name of the step entry to retrieve. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry} (required)
view: string, Deprecated field.
Allowed values
EXECUTION_ENTRY_VIEW_UNSPECIFIED - The default/unset value.
EXECUTION_ENTRY_VIEW_BASIC - Include basic information in the step entries. All fields in StepEntry are returned except for variable_data.
EXECUTION_ENTRY_VIEW_DETAILED - Include all data.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An StepEntry contains debugging information for a step transition in a workflow execution.
"createTime": "A String", # Output only. The creation time of the step entry.
"entryId": "A String", # Output only. The numeric ID of this step entry, used for navigation.
"exception": { # Exception describes why the step entry failed. # Output only. The exception thrown by the step entry.
"payload": "A String", # Error message represented as a JSON string.
},
"name": "A String", # Output only. The full resource name of the step entry. Each step entry has a unique entry ID, which is a monotonically increasing counter. Step entry names have the format: `projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry}`.
"navigationInfo": { # NavigationInfo describes what steps if any come before or after this step, or what steps are parents or children of this step. # Output only. The NavigationInfo associated to this step.
"children": [ # Step entries that can be reached by "stepping into" e.g. a subworkflow call.
"A String",
],
"next": "A String", # The index of the next step in the current workflow, if any.
"parent": "A String", # The step entry, if any, that can be reached by "stepping out" of the current workflow being executed.
"previous": "A String", # The index of the previous step in the current workflow, if any.
},
"routine": "A String", # Output only. The name of the routine this step entry belongs to. A routine name is the subworkflow name defined in the YAML source code. The top level routine name is `main`.
"state": "A String", # Output only. The state of the step entry.
"step": "A String", # Output only. The name of the step this step entry belongs to.
"stepEntryMetadata": { # StepEntryMetadata contains metadata information about this step. # Output only. The StepEntryMetadata associated to this step.
"expectedIteration": "A String", # Expected iteration represents the expected number of iterations in the step's progress.
"progressNumber": "A String", # Progress number represents the current state of the current progress. eg: A step entry represents the 4th iteration in a progress of PROGRESS_TYPE_FOR. Note: This field is only populated when an iteration exists and the starting value is 1.
"progressType": "A String", # Progress type of this step entry.
"threadId": "A String", # Child thread id that this step entry belongs to.
},
"stepType": "A String", # Output only. The type of the step this step entry belongs to.
"updateTime": "A String", # Output only. The most recently updated time of the step entry.
"variableData": { # VariableData contains the variable data for this step. # Output only. The VariableData associated to this step.
"variables": { # Variables that are associated with this step.
"a_key": "",
},
},
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, skip=None, view=None, x__xgafv=None)
Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.
Args:
parent: string, Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} (required)
filter: string, Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `parent`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `createTime>"2023-08-01" AND state="FAILED"`
orderBy: string, Optional. Comma-separated list of fields that specify the ordering applied to the `[StepEntries.ListStepEntries]` results. By default the ordering is based on ascending `entryId`. The following fields are supported for ordering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-132.
pageSize: integer, Optional. Number of step entries to return per call. The default max is 1000.
pageToken: string, Optional. A page token, received from a previous `ListStepEntries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStepEntries` must match the call that provided the page token.
skip: integer, Optional. The number of step entries to skip. It can be used with or without a pageToken. If used with a pageToken, then it indicates the number of step entries to skip starting from the requested page.
view: string, Deprecated field.
Allowed values
EXECUTION_ENTRY_VIEW_UNSPECIFIED - The default/unset value.
EXECUTION_ENTRY_VIEW_BASIC - Include basic information in the step entries. All fields in StepEntry are returned except for variable_data.
EXECUTION_ENTRY_VIEW_DETAILED - Include all data.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ExecutionHistory.ListStepEntries.
"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the ListStepEntriesRequest.page_token field in the subsequent call to `ListStepEntries` method to retrieve the next page of results.
"stepEntries": [ # The list of entries.
{ # An StepEntry contains debugging information for a step transition in a workflow execution.
"createTime": "A String", # Output only. The creation time of the step entry.
"entryId": "A String", # Output only. The numeric ID of this step entry, used for navigation.
"exception": { # Exception describes why the step entry failed. # Output only. The exception thrown by the step entry.
"payload": "A String", # Error message represented as a JSON string.
},
"name": "A String", # Output only. The full resource name of the step entry. Each step entry has a unique entry ID, which is a monotonically increasing counter. Step entry names have the format: `projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry}`.
"navigationInfo": { # NavigationInfo describes what steps if any come before or after this step, or what steps are parents or children of this step. # Output only. The NavigationInfo associated to this step.
"children": [ # Step entries that can be reached by "stepping into" e.g. a subworkflow call.
"A String",
],
"next": "A String", # The index of the next step in the current workflow, if any.
"parent": "A String", # The step entry, if any, that can be reached by "stepping out" of the current workflow being executed.
"previous": "A String", # The index of the previous step in the current workflow, if any.
},
"routine": "A String", # Output only. The name of the routine this step entry belongs to. A routine name is the subworkflow name defined in the YAML source code. The top level routine name is `main`.
"state": "A String", # Output only. The state of the step entry.
"step": "A String", # Output only. The name of the step this step entry belongs to.
"stepEntryMetadata": { # StepEntryMetadata contains metadata information about this step. # Output only. The StepEntryMetadata associated to this step.
"expectedIteration": "A String", # Expected iteration represents the expected number of iterations in the step's progress.
"progressNumber": "A String", # Progress number represents the current state of the current progress. eg: A step entry represents the 4th iteration in a progress of PROGRESS_TYPE_FOR. Note: This field is only populated when an iteration exists and the starting value is 1.
"progressType": "A String", # Progress type of this step entry.
"threadId": "A String", # Child thread id that this step entry belongs to.
},
"stepType": "A String", # Output only. The type of the step this step entry belongs to.
"updateTime": "A String", # Output only. The most recently updated time of the step entry.
"variableData": { # VariableData contains the variable data for this step. # Output only. The VariableData associated to this step.
"variables": { # Variables that are associated with this step.
"a_key": "",
},
},
},
],
"totalSize": 42, # Indicates the total number of StepEntries that matched the request filter. For running executions, this number shows the number of StepEntries that are executed thus far.
}
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.