calculated_channels

Protocol buffer definition for calculated_channels

sift/calculated_channels/v2/calculated_channels.proto

BatchResolveCalculatedChannelsRequest

The request of a call to CalculatedChannelService_BatchResolveCalculatedChannels.

FieldTypeLabelDescription
requestsResolveCalculatedChannelRequestrepeatedAll calculated channels to resolve.

BatchResolveCalculatedChannelsResponse

The response of a call to CalculatedChannelService_BatchResolveCalculatedChannels.

FieldTypeLabelDescription
responsesResolveCalculatedChannelResponserepeatedAll calculated channels that attempted resolution.

CalculatedChannel

FieldTypeLabelDescription
calculated_channel_idstring
organization_idstring
client_keystringoptional
archived_dategoogle.protobuf.Timestampoptional
version_idstring
versionuint32
namestring
descriptionstring
change_messagestring
user_notesstring
unitsstringoptional
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp
calculated_channel_configurationCalculatedChannelConfiguration
created_by_user_idstring
modified_by_user_idstring

CalculatedChannelAbstractChannelReference

FieldTypeLabelDescription
channel_referencestring
channel_identifierstring

CalculatedChannelAssetConfiguration

FieldTypeLabelDescription
all_assetsbool
selectionCalculatedChannelAssetConfiguration.AssetSelection

CalculatedChannelAssetConfiguration.AssetSelection

FieldTypeLabelDescription
asset_idsstringrepeated
tag_idsstringrepeated

CalculatedChannelConfiguration

FieldTypeLabelDescription
asset_configurationCalculatedChannelAssetConfiguration
query_configurationCalculatedChannelQueryConfiguration

CalculatedChannelQueryConfiguration

FieldTypeLabelDescription
selCalculatedChannelQueryConfiguration.Sel

CalculatedChannelQueryConfiguration.Sel

Sift Expression Language.

FieldTypeLabelDescription
expressionstring
expression_channel_referencesCalculatedChannelAbstractChannelReferencerepeated

CalculatedChannelValidationResult

FieldTypeLabelDescription
asset_idstring
asset_namestringoptionalOnly included if asset was named in the request
tag_namesstringrepeatedIncludes all tags that have this asset
missing_channelsstringrepeatedNames of the channels that asset does not have

CreateCalculatedChannelRequest

FieldTypeLabelDescription
namestring
descriptionstring
user_notesstring
unitsstringoptional
client_keystringoptional
calculated_channel_configurationCalculatedChannelConfiguration

CreateCalculatedChannelResponse

FieldTypeLabelDescription
calculated_channelCalculatedChannel
inapplicable_assetsCalculatedChannelValidationResultrepeated

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.

FieldTypeLabelDescription
calculated_channel_idstring
client_keystring
organization_idstring

GetCalculatedChannelResponse

FieldTypeLabelDescription
calculated_channelCalculatedChannel

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.

FieldTypeLabelDescription
calculated_channel_idstring
client_keystring
page_sizeuint32The 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_tokenstringA 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.
filterstringA Common Expression Language (CEL) filter string. Available fields to filter by are calculated_channel_id, client_key, name, asset_id, asset_name, tag_id, tag_name, version, 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_idstringThis field is only required if your user belongs to multiple organizations.
order_bystringHow to order the retrieved calculated channel versions. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date, modified_date, and version. 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_ListCalculatedChannelVersionsResponse.

FieldTypeLabelDescription
calculated_channel_versionsCalculatedChannelrepeated
next_page_tokenstring

ListCalculatedChannelsRequest

The request for a call to CalculatedChannelService_ListCalculatedChannels to retrieve lateset vesrions of calculated channels.

FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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.
filterstringA Common Expression Language (CEL) filter string. Available fields to filter by are calculated_channel_id, client_key, name, asset_id, asset_name, tag_id, tag_name, version, 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_idstringThis field is only required if your user belongs to multiple organizations.
order_bystringHow 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 ascending order (oldest-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_ListCalculatedChannelsResponse.

FieldTypeLabelDescription
calculated_channelsCalculatedChannelrepeated
next_page_tokenstring

ResolveCalculatedChannelRequest

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

  1. 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.
  2. 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.
FieldTypeLabelDescription
calculated_channel_idsift.common.type.v1.ResourceIdentifierThe calculated channel to resolve.
calculated_channel_configurationCalculatedChannelConfigurationA configuration for the calculated channel to resolve.
organization_idstringThis field is only required if your user belongs to multiple organizations.
assetssift.common.type.v1.NamedResourcesAssets to be included or filtered through. See above.
runsift.common.type.v1.ResourceIdentifieroptionalRun to get assets to be included or filtered through. See above.

ResolveCalculatedChannelResponse

The response of a call to CalculatedChannelService_ResolveCalculatedChannel.

FieldTypeLabelDescription
calculated_channel_idsift.common.type.v1.ResourceIdentifieroptionalIf provided in the request, the calculated channel resolved.
resolvedResolveCalculatedChannelResponse.ResolvedCalculatedChannelrepeatedAll resolved calculated channels.
unresolvedResolveCalculatedChannelResponse.UnresolvedCalculatedChannelrepeatedAll assets with any issues in resolution.

ResolveCalculatedChannelResponse.ResolvedCalculatedChannel

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

FieldTypeLabelDescription
asset_namestringThe name of the specific asset that was resolved.
expression_requestsift.calculated_channels.v1.ExpressionRequestThe expression resolved including channel references.
output_data_typesift.common.type.v1.ChannelDataType

ResolveCalculatedChannelResponse.UnresolvedCalculatedChannel

Any failure in resolution.

FieldTypeLabelDescription
asset_namestringThe name of the specific asset that was not resolved.
error_messagestring

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.

FieldTypeLabelDescription
calculated_channelCalculatedChannelThe calculated channel to update.
update_maskgoogle.protobuf.FieldMaskThe list of fields to be updated. The fields available to be updated are name, description, units, query_configuration, archived_date, and asset_configuration.
user_notesstringoptionalOptional user notes to describe changes.

UpdateCalculatedChannelResponse

The response of a call to CalculatedChannelService_UpdateCalculatedChannel.

FieldTypeLabelDescription
calculated_channelCalculatedChannel
inapplicable_assetsCalculatedChannelValidationResultrepeated

CalculatedChannelService

Method NameRequest TypeResponse TypeDescription
GetCalculatedChannelGetCalculatedChannelRequestGetCalculatedChannelResponseRetrieve the latest version of a calculated channel
CreateCalculatedChannelCreateCalculatedChannelRequestCreateCalculatedChannelResponseCreate a calculated channel.
ListCalculatedChannelsListCalculatedChannelsRequestListCalculatedChannelsResponseRetrieve the latest versions of calculated channels based on an optional filter.
UpdateCalculatedChannelUpdateCalculatedChannelRequestUpdateCalculatedChannelResponseUpdate and create a new version of a calculated channel.
ListCalculatedChannelVersionsListCalculatedChannelVersionsRequestListCalculatedChannelVersionsResponseList versions of a particular calculated channel with an optional filter.
ResolveCalculatedChannelResolveCalculatedChannelRequestResolveCalculatedChannelResponseResolve a calculated channel into an expression with references.
BatchResolveCalculatedChannelsBatchResolveCalculatedChannelsRequestBatchResolveCalculatedChannelsResponseResolve a batch of calculated channels into expressions with references.