views
Protocol buffer definition for views
sift/views/v1/views.proto
CreateViewRequest
Field | Type | Label | Description |
---|---|---|---|
view | View |
CreateViewResponse
Field | Type | Label | Description |
---|---|---|---|
view | View |
DeleteViewRequest
Field | Type | Label | Description |
---|---|---|---|
view_id | string |
DeleteViewResponse
GetViewRequest
Field | Type | Label | Description |
---|---|---|---|
view_id | string |
GetViewResponse
Field | Type | Label | Description |
---|---|---|---|
view | View |
ListApplicableViewsRequest
Field | Type | Label | Description |
---|---|---|---|
page_size | uint32 | The maximum number of views to return. The service may return fewer than this value. If unspecified, at most 50 views 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 ListApplicableViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListApplicableViews must match the call that provided the page token. | |
asset_ids | string | repeated | |
run_ids | string | repeated |
ListApplicableViewsResponse
Field | Type | Label | Description |
---|---|---|---|
views | View | repeated | |
next_page_token | string | A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. |
ListViewsRequest
Field | Type | Label | Description |
---|---|---|---|
page_size | uint32 | The maximum number of views to return. The service may return fewer than this value. If unspecified, at most 50 views 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 ListViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListViews must match the call that provided the page token. | |
filter | string | A Common Expression Language (CEL) filter string Available fields to filter by are 'name', 'createdDate', and 'modifiedDate'. 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. |
ListViewsResponse
Field | Type | Label | Description |
---|---|---|---|
views | View | repeated | |
next_page_token | string | A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. |
PinViewRequest
Field | Type | Label | Description |
---|---|---|---|
view_id | string |
PinViewResponse
UnpinViewRequest
Field | Type | Label | Description |
---|---|---|---|
view_id | string |
UnpinViewResponse
UpdateViewRequest
Field | Type | Label | Description |
---|---|---|---|
view | View | ||
update_mask | google.protobuf.FieldMask | The list of fields to update. |
UpdateViewResponse
Field | Type | Label | Description |
---|---|---|---|
view | View |
View
Field | Type | Label | Description |
---|---|---|---|
view_id | string | ||
name | string | ||
axis_groups | View.AxisGroups | ||
channels | View.Channel | repeated | |
created_date | google.protobuf.Timestamp | ||
modified_date | google.protobuf.Timestamp | ||
created_by_user_id | string | ||
organization_id | string | ||
modified_by_user_id | string | ||
is_pinned | bool |
View.AxisGroups
View.Channel
Field | Type | Label | Description |
---|---|---|---|
name | string | ||
component | string | ||
data_type | string | ||
axis_group | string | ||
bit_field_names | string | repeated | |
calculated_channel_config | View.Channel.CalculatedChannelConfig | optional |
View.Channel.CalculatedChannelConfig
Field | Type | Label | Description |
---|---|---|---|
channel_key | string | ||
channel_references | View.Channel.CalculatedChannelConfig.ChannelReferencesEntry | repeated | |
expression | string | ||
unit | string |
View.Channel.CalculatedChannelConfig.ChannelReference
View.Channel.CalculatedChannelConfig.ChannelReferencesEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | View.Channel.CalculatedChannelConfig.ChannelReference |
ViewService
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetView | GetViewRequest | GetViewResponse | Retrieves a view. |
CreateView | CreateViewRequest | CreateViewResponse | Creates a view. |
UpdateView | UpdateViewRequest | UpdateViewResponse | Updates an existing view using using the list of fields specified in update_mask . |
ListViews | ListViewsRequest | ListViewsResponse | Retrieves views using an optional filter. |
ListApplicableViews | ListApplicableViewsRequest | ListApplicableViewsResponse | Lists views that apply to assets/runs. |
DeleteView | DeleteViewRequest | DeleteViewResponse | Deletes a view. |
PinView | PinViewRequest | PinViewResponse | Pins a view. |
UnpinView | UnpinViewRequest | UnpinViewResponse | Unpins a view. |