calculated_channels
Protocol buffer definition for calculated_channels
sift/calculated_channels/v2/calculated_channels.proto
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 |
CalculatedChannelAbstractChannelReference
CalculatedChannelAssetConfiguration
Field | Type | Label | Description |
---|---|---|---|
all_assets | bool | ||
selection | CalculatedChannelAssetConfiguration.AssetSelection |
CalculatedChannelAssetConfiguration.AssetSelection
CalculatedChannelConfiguration
Field | Type | Label | Description |
---|---|---|---|
asset_configuration | CalculatedChannelAssetConfiguration | ||
query_configuration | CalculatedChannelQueryConfiguration |
CalculatedChannelQueryConfiguration
Field | Type | Label | Description |
---|---|---|---|
sel | CalculatedChannelQueryConfiguration.Sel |
CalculatedChannelQueryConfiguration.Sel
Sift Expression Language.
Field | Type | Label | Description |
---|---|---|---|
expression | string | ||
expression_channel_references | CalculatedChannelAbstractChannelReference | repeated |
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 | Description |
---|---|---|---|
name | string | ||
description | string | ||
user_notes | string | ||
units | string | optional | |
client_key | string | optional | |
calculated_channel_configuration | CalculatedChannelConfiguration |
CreateCalculatedChannelResponse
Field | Type | Label | Description |
---|---|---|---|
calculated_channel | CalculatedChannel | ||
inapplicable_assets | CalculatedChannelValidationResult | 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.
GetCalculatedChannelResponse
Field | Type | Label | Description |
---|---|---|---|
calculated_channel | CalculatedChannel |
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 | Label | 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 , 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_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 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
.
Field | Type | Label | Description |
---|---|---|---|
calculated_channel_versions | CalculatedChannel | repeated | |
next_page_token | string |
ListCalculatedChannelsRequest
The request for a call to CalculatedChannelService_ListCalculatedChannels
to retrieve lateset vesrions of calculated channels.
Field | Type | Label | 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 , 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_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 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
.
Field | Type | Label | Description |
---|---|---|---|
calculated_channels | CalculatedChannel | 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 usingclient_key
and the user belongs to multiple organizations.
Field | Type | Label | Description |
---|---|---|---|
calculated_channel_id | sift.common.type.v1.ResourceIdentifier | The calculated channel to resolve. | |
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 | sift.common.type.v1.ResourceIdentifier | optional | If provided in the request, the calculated channel resolved. |
resolved | ResolveCalculatedChannelResponse.ResolvedCalculatedChannel | repeated | All resolved calculated channels. |
unresolved | ResolveCalculatedChannelResponse.UnresolvedCalculatedChannel | repeated | All assets with any issues in resolution. |
ResolveCalculatedChannelResponse.ResolvedCalculatedChannel
A specific calculated channel including the asset and exact channels to query.
Field | Type | Label | 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 |
ResolveCalculatedChannelResponse.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 , query_configuration , archived_date , 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 |
CalculatedChannelService
Method Name | Request Type | Response Type | 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. |