runs

sift/runs/v2/runs.proto

Field	Type	Label	Description
run_id	string		The ID of the run to associate the asset with.
asset_names	string	repeated	A list of asset names to automatically associate with the run. Any data that is received for these assets will automatically added to the run. This applies even if the run has concluded, so long as the new data contains timestamps that are between the `start_time` and `stop_time`. If any of the assets are already associated with a different run whose run period (the period between `start_time` and `end_time`) overlaps with the requested run period, an error will be returned.

The request of a call to RunService_CreateRuns to create a new run.

Field	Type	Label	Description
name	string		The name that will be assigned to the new run.
description	string		A description about the new run.
tags	string	repeated	Tags to associate with the new run.
start_time	google.protobuf.Timestamp		The time at which data ingestion begins for this new run. It must be before the `stop_time`, and it must be provided if a `stop_time` is provided. Important note: `start_time` will be automatically computed during data ingestion and will be set based on the timestamp of the data for this run.
stop_time	google.protobuf.Timestamp		The time at which data ingestion for this new run concludes. Important note: `stop_time` will be automatically computed during data ingestion and will be set based on the timestamp of the data for this run.
organization_id	string		An organization ID is only required if the user belongs to multiple organizations.
client_key	string	optional	An arbitrary user-chosen key that uniquely identifies this run. Optional, though it is recommended to provide.

The response of a call to RunService_CreateRuns containing the newly created run.

Field	Type	Label	Description
run	Run

The request for a call to RunService_DeleteRun.

Field	Type	Label	Description
run_id	string

The response of a call to RunService_DeleteRun.

The request for a call to RunService_GetRun to retrieve run.

Field	Type	Label	Description
run_id	string		The ID of the run to retrieve.

The response of a call to RunService_GetRun containing the requested run.

Field	Type	Label	Description
run	Run

The request for a call to RunService_ListRuns to retrieve runs.

Field	Type	Description
page_size	uint32	The maximum number of runs to return. The service may return fewer than this value. If unspecified, at most 50 runs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string	A page token, received from a previous `ListRuns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRuns` must match the call that provided the page token.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `run_id`, `organization_id`, `name`, `description`, `created_by_user_id`, `modified_by_user_id`, `created_date`, `modified_date`, `start_time`, `stop_time`, `client_key`, `is_pinned`, `asset_id`, `client_key`, and `asset_name`. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.
order_by	string	How to order the retrieved runs. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are `created_date`, `modified_date`, `start_time`, and `stop_time`. If left empty, items are ordered by `created_date` in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date"

The response of a call to RunService_ListRuns containing requested runs.

Field	Type	Label	Description
runs	Run	repeated
next_page_token	string

Field	Type	Label
run_id	string
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
created_by_user_id	string
modified_by_user_id	string
organization_id	string
start_time	google.protobuf.Timestamp	optional
stop_time	google.protobuf.Timestamp	optional
is_pinned	bool
name	string
description	string
tags	string	repeated
default_report_id	string
client_key	string	optional

The request for a call to RunService_StopRun to stop a run.

Field	Type	Label	Description
run_id	string

The response of a call to RunService_StopRun to stop a run.

The request for a call to RunService_UpdateRun to update an existing run.

Field	Type	Label	Description
run	Run		The run to update. The run's `run_id` field is used to identify the run to update and is required.
update_mask	google.protobuf.FieldMask		The list of fields to be updated. The fields available to be updated are `name`, `description`, `start_time`, `stop_time`, `is_pinned`, and `tags`. Important Note: When updating the `start_time`, please be aware that if a subsequent data ingestion commences for this run, the `start_time` will be automatically overwritten and set to the timestamp corresponding to the beginning of the latest run.

The response of a call to RunService_UpdateRun containing the updated run.

Field	Type	Label	Description
run	Run

Method Name	Request Type	Response Type	Description
GetRun	GetRunRequest	GetRunResponse	Retrieve a run.
ListRuns	ListRunsRequest	ListRunsResponse	Retrieve runs using an optional filter.
CreateRun	CreateRunRequest	CreateRunResponse	Create a run.
UpdateRun	UpdateRunRequest	UpdateRunResponse	Updates an existing run using using the list of fields specified in `update_mask`.
DeleteRun	DeleteRunRequest	DeleteRunResponse	Permanently delete a given run. In order for a run to be deleted it must have a set `stop_time`.
StopRun	StopRunRequest	StopRunResponse	Set the stop time of a run to the current time. To set the stop time of a run to an arbitrary time see `UpdateRun`.
CreateAutomaticRunAssociationForAssets	CreateAutomaticRunAssociationForAssetsRequest	CreateAutomaticRunAssociationForAssetsResponse	Associates a list of assets with a given run.