Runs
Personal Access Token.
A successful response.
Run represents a single execution instance of code in the Jeeves platform. Contains the executable code, metadata, and current execution state.
The timestamp when this run was created. Set automatically when the run is first submitted to the system.
The timestamp when this run was updated. Set automatically when the run is updated.
AutomationStage represents the publication stage of an automation. This enum is shared across services that manage or execute automations.
- AUTOMATION_STAGE_UNSPECIFIED: Automation stage is not specified.
- AUTOMATION_STAGE_DRAFT: Automation is in draft stage and can be modified.
- AUTOMATION_STAGE_PUBLISHED: Automation is published and immutable, ready for execution.
AUTOMATION_STAGE_UNSPECIFIEDPossible values: The version of the automation stage at the time this run was created.
An unexpected error response.
Personal Access Token.
The maximum number of runs to return in a single response. The service may return fewer than this value. If unspecified or 0, at most 10 runs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. If negative, an INVALID_ARGUMENT error will be returned.
A page token received from a previous ListRuns call.
Provide this to retrieve the subsequent page of results.
When paginating, all other parameters provided to ListRuns must match
the call that provided the page token.
Filter expression for filtering runs. Follows the structured syntax defined in AIP-160.
Supported fields for filtering:
- create_time: The timestamp when the run was created (google.protobuf.Timestamp)
Supported operators:
- Comparison: =, !=, <, >, <=, >=
- Logical: AND, OR, NOT, -
Examples:
- Filter runs created after a specific date (start_date): "create_time >= "2024-01-01T00:00:00Z""
- Filter runs created before a specific date (end_date): "create_time <= "2024-12-31T23:59:59Z""
- Filter runs within a date range (start_date and end_date): "create_time >= "2024-01-01T00:00:00Z" AND create_time <= "2024-12-31T23:59:59Z""
- Complex filter with multiple date ranges: "(create_time >= "2024-01-01T00:00:00Z" AND create_time <= "2024-06-30T23:59:59Z") OR create_time >= "2024-07-01T00:00:00Z""
Timestamps must be in RFC-3339 format (e.g., "2024-01-01T00:00:00Z"). If an invalid filter expression is provided, the API will return INVALID_ARGUMENT.
A successful response.
Response message for ListRuns method. Contains a paginated list of runs and pagination metadata.
A token that can be sent as page_token to retrieve the next page.
If this field is omitted, there are no subsequent pages.
An unexpected error response.
Personal Access Token.
Request message for PauseRun method. Specifies which run to pause by its unique identifier.
The reason for pausing the run.
A successful response.
Run represents a single execution instance of code in the Jeeves platform. Contains the executable code, metadata, and current execution state.
The timestamp when this run was created. Set automatically when the run is first submitted to the system.
The timestamp when this run was updated. Set automatically when the run is updated.
AutomationStage represents the publication stage of an automation. This enum is shared across services that manage or execute automations.
- AUTOMATION_STAGE_UNSPECIFIED: Automation stage is not specified.
- AUTOMATION_STAGE_DRAFT: Automation is in draft stage and can be modified.
- AUTOMATION_STAGE_PUBLISHED: Automation is published and immutable, ready for execution.
AUTOMATION_STAGE_UNSPECIFIEDPossible values: The version of the automation stage at the time this run was created.
An unexpected error response.
Personal Access Token.
Request message for ContinueRun method. Specifies which run to resume by its unique identifier.
A successful response.
Run represents a single execution instance of code in the Jeeves platform. Contains the executable code, metadata, and current execution state.
The timestamp when this run was created. Set automatically when the run is first submitted to the system.
The timestamp when this run was updated. Set automatically when the run is updated.
AutomationStage represents the publication stage of an automation. This enum is shared across services that manage or execute automations.
- AUTOMATION_STAGE_UNSPECIFIED: Automation stage is not specified.
- AUTOMATION_STAGE_DRAFT: Automation is in draft stage and can be modified.
- AUTOMATION_STAGE_PUBLISHED: Automation is published and immutable, ready for execution.
AUTOMATION_STAGE_UNSPECIFIEDPossible values: The version of the automation stage at the time this run was created.
An unexpected error response.
Personal Access Token.
A successful response.
Response message for QueryAutomationRunAggregates method. Contains statistics for each automation in the workspace.
An unexpected error response.
Personal Access Token.
Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
Time zone for date aggregation. Format: IANA timezone identifier (e.g., "America/New_York", "UTC", "Europe/London")
Filter expression for filtering runs included in the aggregation. Follows the structured syntax defined in AIP-160.
Supported fields for filtering:
- automation_id: The unique identifier of the automation (string)
Supported operators:
- Comparison: =
- Logical: OR
Examples:
- Filter by specific automation: "automation_id = "789""
- Filter by multiple automations: "automation_id = "789" OR automation_id = "790""
If an invalid filter expression is provided, the API will return INVALID_ARGUMENT.
A successful response.
Response message for QueryDailyRunAggregates method. Contains daily run statistics as a list of entries.
An unexpected error response.
Personal Access Token.
A successful response.
GetExecutionOutputsResponse contains the outputs from a completed execution.
An unexpected error response.
Personal Access Token.
Maximum number of run events to return in a single response.
The service may return fewer events than requested, but will never return more. This can happen when:
- The run has fewer total events than requested
- Internal chunking limits are reached
- The remaining events don't fit in the response size limit
Valid range: 1-1000 events Default: 100 events if unspecified Values above 1000 are automatically capped at 1000 Negative values result in an INVALID_ARGUMENT error
Pagination token from a previous ListRunEvents response.
Provide the next_page_token value from a previous response to
continue retrieving the next set of events. Leave empty or unset
for the first page of results.
The token is opaque and should not be parsed or modified by clients.
Filter expression to narrow down which events are returned.
The filter string follows the AIP-160 filtering syntax (https://google.aip.dev/160).
Supported fields for filtering:
- node_kind: Filter execution journal events by the kind/type of node. Only execution journal events with matching node_kind are returned. Example: node_kind = "FunctionCall"
When empty or unset, all events for the specified run are returned.
Example filters: node_kind = "FunctionCall" node_kind = "Assignment"
A successful response.
Response message for the ListRunEvents RPC.
Contains a page of run events in chronological order, along with pagination information for retrieving additional events. Events are sorted by their occurrence time, providing a complete timeline of the run's execution.
The response may contain fewer events than requested if:
- The run has fewer remaining events than the page size
- This is the final page of results
- Response size limits are reached
Pagination token for retrieving the next page of events.
Include this token as the page_token in a subsequent ListRunEvents
request to retrieve the next set of events. The token maintains
cursor position and ensures consistent pagination even if new
events are added to the run.
When this field is empty or omitted:
- This is the final page of results
- All events for the run have been retrieved
- No further pagination requests are needed
The token is opaque. Do not attempt to parse, modify, or reuse tokens across different parent resources or request parameters.
An unexpected error response.
Last updated
Was this helpful?