calculated_channels

Services

RPC methods exposed by this API.

CalculatedChannelService

Method	Request	Response	Description
GetCalculatedChannel	GetCalculatedChannelRequest	GetCalculatedChannelResponse	Retrieve the latest version of a calculated channel
CreateCalculatedChannel	CreateCalculatedChannelRequest	CreateCalculatedChannelResponse	Create a calculated channel.
ListCalculatedChannels	ListCalculatedChannelsRequest	ListCalculatedChannelsResponse	Retrieve the latest versions of calculated channels based on an optional filter.
UpdateCalculatedChannel	UpdateCalculatedChannelRequest	UpdateCalculatedChannelResponse	Update and create a new version of a calculated channel.
ListCalculatedChannelVersions	ListCalculatedChannelVersionsRequest	ListCalculatedChannelVersionsResponse	List versions of a particular calculated channel with an optional filter.
ResolveCalculatedChannel	ResolveCalculatedChannelRequest	ResolveCalculatedChannelResponse	Resolve a calculated channel into an expression with references.
BatchResolveCalculatedChannels	BatchResolveCalculatedChannelsRequest	BatchResolveCalculatedChannelsResponse	Resolve a batch of calculated channels into expressions with references.
ListResolvedCalculatedChannels	ListResolvedCalculatedChannelsRequest	ListResolvedCalculatedChannelsResponse	Retrieve the latest versions of calculated channels based on an optional filter.
GetCalculatedChannelVersions	GetCalculatedChannelVersionsRequest	GetCalculatedChannelVersionsResponse	Retrieve calculated channel versions by their version IDs.
GetCalculatedChannelDependents	GetCalculatedChannelDependentsRequest	GetCalculatedChannelDependentsResponse	Retrieve calculated channels that depend on a given calculated channel.

Messages

Data models used across requests/responses.

BatchResolveCalculatedChannelsRequest

The request of a call to CalculatedChannelService_BatchResolveCalculatedChannels.

Field	Type	Label	Description
requests	ResolveCalculatedChannelRequest	repeated	All calculated channels to resolve.

BatchResolveCalculatedChannelsResponse

The response of a call to CalculatedChannelService_BatchResolveCalculatedChannels.

Field	Type	Label	Description
responses	ResolveCalculatedChannelResponse	repeated	All calculated channels that attempted resolution.

CalculatedChannel

Field	Type	Label	Description
calculated_channel_id	string
organization_id	string
client_key	string	optional
archived_date	google.protobuf.Timestamp	optional
version_id	string
version	uint32
name	string
description	string
change_message	string
user_notes	string
units	string	optional
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
calculated_channel_configuration	CalculatedChannelConfiguration
created_by_user_id	string
modified_by_user_id	string
function_dependencies	sift.common.type.v1.FunctionDependency	repeated
metadata	sift.metadata.v1.MetadataValue	repeated
is_archived	bool		Whether the calculated channel is archived. This is inferred from whether archived_date is set.
calculated_channel_dependencies	CalculatedChannelDependency	repeated	Calculated channels that this channel depends on.
folder_ids	string	repeated	Ids of the folders this calculated channel belongs to.

CalculatedChannelAbstractChannelReference

Field	Type	Description
channel_reference	string
channel_identifier	string	must use either a channel_identifier or a calculated_channel_reference, not both
oneof calculated_channel_reference. calculated_channel_version_id	string
oneof calculated_channel_reference. calculated_channel	sift.calculated_channels.v1.ExpressionRequest

CalculatedChannelAssetConfiguration

Field	Type	Label	Description
oneof asset_scope. all_assets	bool
oneof asset_scope. selection	CalculatedChannelAssetConfiguration.AssetSelection

CalculatedChannelAssetConfiguration.AssetSelection

Field	Type	Label	Description
asset_ids	string	repeated
tag_ids	string	repeated

CalculatedChannelConfiguration

Field	Type	Label	Description
asset_configuration	CalculatedChannelAssetConfiguration
query_configuration	CalculatedChannelQueryConfiguration

CalculatedChannelDependency

A dependency on another calculated channel.

Field	Type	Label	Description
calculated_channel_version_id	string

CalculatedChannelQueryConfiguration

Field	Type	Label	Description
oneof query. sel	CalculatedChannelQueryConfiguration.Sel

CalculatedChannelQueryConfiguration.Sel

Sift Expression Language.

Field	Type	Label	Description
expression	string
expression_channel_references	CalculatedChannelAbstractChannelReference	repeated

CalculatedChannelResolution

Field	Type	Label	Description
calculated_channel	CalculatedChannel	optional	The calculated channel resolved.
resolved	ResolvedCalculatedChannel	repeated	All resolved calculated channels.
unresolved	UnresolvedCalculatedChannel	repeated	All assets with any issues in resolution.

CalculatedChannelValidationResult

Field	Type	Label	Description
asset_id	string
asset_name	string	optional	Only included if asset was named in the request
tag_names	string	repeated	Includes all tags that have this asset
missing_channels	string	repeated	Names of the channels that asset does not have

CreateCalculatedChannelRequest

Field	Type	Label
name	string
description	string
user_notes	string
units	string	optional
client_key	string	optional
calculated_channel_configuration	CalculatedChannelConfiguration
metadata	sift.metadata.v1.MetadataValue	repeated

CreateCalculatedChannelResponse

Field	Type	Label	Description
calculated_channel	CalculatedChannel
inapplicable_assets	CalculatedChannelValidationResult	repeated

GetCalculatedChannelDependentsRequest

The request for a call to CalculatedChannelService_GetCalculatedChannelDependents to retrieve calculated channels that depend on a given calculated channel.

Field	Type	Label	Description
oneof calculated_channel. calculated_channel_id	string
oneof calculated_channel. calculated_channel_version_id	string

GetCalculatedChannelDependentsResponse

The response of a call to CalculatedChannelService_GetCalculatedChannelDependents.

Field	Type	Label	Description
calculated_channels	CalculatedChannel	repeated
rules	sift.rules.v1.Rule	repeated

GetCalculatedChannelRequest

The request for a call to CalculatedChannelService_GetCalculatedChannel to retrieve the latest version of a calculated channel. If calculated_channel_id is provided then all other arguments will be ignored. The argument calculated_channel_id should not be used together with client_key. The organization_id argument is only required if using client_key and the user belongs to multiple organizations.

Field	Type	Label	Description
calculated_channel_id	string
client_key	string
organization_id	string
calculated_channel_version_id	string

GetCalculatedChannelResponse

Field	Type	Label	Description
calculated_channel	CalculatedChannel

GetCalculatedChannelVersionsRequest

The request for a call to CalculatedChannelService_GetCalculatedChannelVersions to retrieve versions of calculated channels by their version IDs.

Field	Type	Label	Description
calculated_channel_version_ids	string	repeated

GetCalculatedChannelVersionsResponse

The response of a call to CalculatedChannelService_GetCalculatedChannelVersions.

Field	Type	Label	Description
calculated_channels	CalculatedChannel	repeated

ListCalculatedChannelVersionsRequest

The request for a call to CalculatedChannelService_ListCalculatedChannelVersions to retrieve versions of a particular calculated channel. If calculated_channel_id is provided then client_key is ignored.

Field	Type	Description
calculated_channel_id	string
client_key	string
page_size	uint32	The maximum number of calculated channel versions to return. The service may return fewer than this value. If unspecified, at most 50 calculated channels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListCalculatedChannelVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCalculatedChannelVersions` must match the call that provided the page token. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `calculated_channel_id`, `organization_id`, `client_key`, `name`, `description`, `asset_id`, `asset_name`, `tag_id`, `tag_name`, `version`, `units`, `calculated_channel_version_id`, `created_date`, `modified_date`, `created_by_user_id`, `modified_by_user_id`, `is_archived`, and `archived_date`. 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.
organization_id	string	This field is only required if your user belongs to multiple organizations.
order_by	string	How to order the retrieved calculated channel versions. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are ‘version’, `created_date`, `modified_date`, `name`, `description`, `units`, and `archived_date`. 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”.

ListCalculatedChannelVersionsResponse

The response of a call to CalculatedChannelService_ListCalculatedChannelVersions.

Field	Type	Label	Description
calculated_channel_versions	CalculatedChannel	repeated
next_page_token	string

ListCalculatedChannelsRequest

The request for a call to CalculatedChannelService_ListCalculatedChannels to retrieve latest versions of calculated channels.

Field	Type	Description
page_size	uint32	The maximum number of calculated channels to return. The service may return fewer than this value. If unspecified, at most 50 calculated channels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListCalculatedChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCalculatedChannels` must match the call that provided the page token. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `calculated_channel_id`, `organization_id`, `client_key`, `name`, `description`, `asset_id`, `asset_name`, `tag_id`, `tag_name`, `units`, `calculated_channel_version_id`, `created_date`, `modified_date`, `created_by_user_id`, `modified_by_user_id`, `is_archived`, and `archived_date`. Folder membership is filterable via the `folders` and `activeFolders` fields. Both contain the ids of the folders the calculated channel belongs to; `activeFolders` excludes archived folders. Use `"<folder_id>" in folders` to return calculated channels in the given folder, and `size(activeFolders) == 0` to return uncategorized calculated channels (calculated channels whose only memberships are in archived folders count as uncategorized). 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.
organization_id	string	This field is only required if your user belongs to multiple organizations.
order_by	string	How to order the retrieved calculated channels. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are `created_date`, `modified_date`, `name`, `description`, `units`, and `archived_date`. If left empty, items are ordered by `created_date` in descending order (newest-first). For more information about the format of this field, read this Example: “created_date desc,modified_date”

ListCalculatedChannelsResponse

The response of a call to CalculatedChannelService_ListCalculatedChannels.

Field	Type	Label	Description
calculated_channels	CalculatedChannel	repeated
next_page_token	string

ListResolvedCalculatedChannelsRequest

Field	Type	Description
asset_id	string	Assets or runs to get the resolved calculated channels for. At least one asset or run must be provided.
run_id	string
page_size	uint32	The maximum number of calculated channels to return. The service may return fewer than this value. If unspecified, at most 50 calculated channels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListCalculatedChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCalculatedChannels` must match the call that provided the page token. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `calculated_channel_id`, `organization_id`, `client_key`, `name`, `description`, `asset_id`, `asset_name`, `tag_id`, `tag_name`, `version`, `units`, `calculated_channel_version_id`, `created_date`, `modified_date`, `created_by_user_id`, `modified_by_user_id`, `is_archived`, and `archived_date`. 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 calculated channels. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are `created_date` and `modified_date`. If left empty, items are ordered by `created_date` in descending order (newest-first). For more information about the format of this field, read this Example: “created_date desc,modified_date”

ListResolvedCalculatedChannelsResponse

Field	Type	Label	Description
calculated_channel_resolutions	CalculatedChannelResolution	repeated
next_page_token	string

ResolveCalculatedChannelRequest

The request for a call to CalculatedChannelService_ResolveCalculatedChannel to get the all possible calculated channels.

If the calculated channel has a selection of assets and tags then those assets will be used as a base and then filtered down by the given assets and assets from the run.
If the calculated channel is enabled for all assets then: a) If the request has run and assets from the run will be used as a base and then filtered down by the given assets. b) If the request has run and no assets then those assets will be used. c) If the request has only assets then those assets will be used. The organization_id argument is only required if using client_key and the user belongs to multiple organizations.

Field	Type	Label	Description
oneof calculated_channel. identifier	sift.common.type.v1.ResourceIdentifier		The calculated channel to resolve.
oneof calculated_channel. calculated_channel_configuration	CalculatedChannelConfiguration		A configuration for the calculated channel to resolve.
organization_id	string		This field is only required if your user belongs to multiple organizations.
assets	sift.common.type.v1.NamedResources		Assets to be included or filtered through. See above.
run	sift.common.type.v1.ResourceIdentifier	optional	Run to get assets to be included or filtered through. See above.

ResolveCalculatedChannelResponse

The response of a call to CalculatedChannelService_ResolveCalculatedChannel.

Field	Type	Label	Description
calculated_channel_id	string	optional	If provided in the request, the calculated channel resolved.
resolved	ResolvedCalculatedChannel	repeated	All resolved calculated channels.
unresolved	UnresolvedCalculatedChannel	repeated	All assets with any issues in resolution.

ResolvedCalculatedChannel

A specific calculated channel including the asset and exact channels to query.

Field	Type	Description
asset_name	string	The name of the specific asset that was resolved.
expression_request	sift.calculated_channels.v1.ExpressionRequest	The expression resolved including channel references.
output_data_type	sift.common.type.v1.ChannelDataType
asset_id	string

UnresolvedCalculatedChannel

Any failure in resolution.

Field	Type	Label	Description
asset_name	string		The name of the specific asset that was not resolved.
error_message	string

UpdateCalculatedChannelRequest

The request for a call to CalculatedChannelService_UpdateCalculatedChannel to update a calculated channel. Updating a calculated channel creates a new version of the calculated channel, leaving the previous untouched. If no update is deemed necessary, then the the current version is returned. To archive calculated channel, specify archived_date in the update mask as well as a non-null value for archived_date in the calculated_channel object. To unarchive a calculated channel, specify archived_date in the update mask and a null value for archived_date in the calculated_channel object.

Field	Type	Label	Description
calculated_channel	CalculatedChannel		The calculated channel to update.
update_mask	google.protobuf.FieldMask		The list of fields to be updated. The fields available to be updated are `name`, `description`, `units`, `metadata`, `query_configuration`, `archived_date`, `is_archived`, and `asset_configuration`.
user_notes	string	optional	Optional user notes to describe changes.

UpdateCalculatedChannelResponse

The response of a call to CalculatedChannelService_UpdateCalculatedChannel.

Field	Type	Label	Description
calculated_channel	CalculatedChannel
inapplicable_assets	CalculatedChannelValidationResult	repeated

Enums

Allowed constant values used in message fields.

​Services

​CalculatedChannelService

​Messages

​BatchResolveCalculatedChannelsRequest

​BatchResolveCalculatedChannelsResponse

​CalculatedChannel

​CalculatedChannelAbstractChannelReference

​CalculatedChannelAssetConfiguration

​CalculatedChannelAssetConfiguration.AssetSelection

​CalculatedChannelConfiguration

​CalculatedChannelDependency

​CalculatedChannelQueryConfiguration

​CalculatedChannelQueryConfiguration.Sel

​CalculatedChannelResolution

​CalculatedChannelValidationResult

​CreateCalculatedChannelRequest

​CreateCalculatedChannelResponse

​GetCalculatedChannelDependentsRequest

​GetCalculatedChannelDependentsResponse

​GetCalculatedChannelRequest

​GetCalculatedChannelResponse

​GetCalculatedChannelVersionsRequest

​GetCalculatedChannelVersionsResponse

​ListCalculatedChannelVersionsRequest

​ListCalculatedChannelVersionsResponse

​ListCalculatedChannelsRequest

​ListCalculatedChannelsResponse

​ListResolvedCalculatedChannelsRequest

​ListResolvedCalculatedChannelsResponse

​ResolveCalculatedChannelRequest

​ResolveCalculatedChannelResponse

​ResolvedCalculatedChannel

​UnresolvedCalculatedChannel

​UpdateCalculatedChannelRequest

​UpdateCalculatedChannelResponse

​Enums