views

Protocol buffer definition for views

sift/views/v1/views.proto

CreateViewRequest

FieldTypeLabelDescription
viewView

CreateViewResponse

FieldTypeLabelDescription
viewView

DeleteViewRequest

FieldTypeLabelDescription
view_idstring

DeleteViewResponse

GetViewRequest

FieldTypeLabelDescription
view_idstring

GetViewResponse

FieldTypeLabelDescription
viewView

ListApplicableViewsRequest

FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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_idsstringrepeated
run_idsstringrepeated

ListApplicableViewsResponse

FieldTypeLabelDescription
viewsViewrepeated
next_page_tokenstringA token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListViewsRequest

FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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.
filterstringA 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

FieldTypeLabelDescription
viewsViewrepeated
next_page_tokenstringA token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

PinViewRequest

FieldTypeLabelDescription
view_idstring

PinViewResponse

UnpinViewRequest

FieldTypeLabelDescription
view_idstring

UnpinViewResponse

UpdateViewRequest

FieldTypeLabelDescription
viewView
update_maskgoogle.protobuf.FieldMaskThe list of fields to update.

UpdateViewResponse

FieldTypeLabelDescription
viewView

View

FieldTypeLabelDescription
view_idstring
namestring
axis_groupsView.AxisGroups
channelsView.Channelrepeated
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp
created_by_user_idstring
organization_idstring
modified_by_user_idstring
is_pinnedbool

View.AxisGroups

FieldTypeLabelDescription
leftstringrepeated
rightstringrepeated

View.Channel

FieldTypeLabelDescription
namestring
componentstring
data_typestring
axis_groupstring
bit_field_namesstringrepeated
calculated_channel_configView.Channel.CalculatedChannelConfigoptional

View.Channel.CalculatedChannelConfig

FieldTypeLabelDescription
channel_keystring
channel_referencesView.Channel.CalculatedChannelConfig.ChannelReferencesEntryrepeated
expressionstring
unitstring

View.Channel.CalculatedChannelConfig.ChannelReference

FieldTypeLabelDescription
namestring
componentstring

View.Channel.CalculatedChannelConfig.ChannelReferencesEntry

ViewService

Method NameRequest TypeResponse TypeDescription
GetViewGetViewRequestGetViewResponseRetrieves a view.
CreateViewCreateViewRequestCreateViewResponseCreates a view.
UpdateViewUpdateViewRequestUpdateViewResponseUpdates an existing view using using the list of fields specified in update_mask.
ListViewsListViewsRequestListViewsResponseRetrieves views using an optional filter.
ListApplicableViewsListApplicableViewsRequestListApplicableViewsResponseLists views that apply to assets/runs.
DeleteViewDeleteViewRequestDeleteViewResponseDeletes a view.
PinViewPinViewRequestPinViewResponsePins a view.
UnpinViewUnpinViewRequestUnpinViewResponseUnpins a view.

On this page