panel_configuration

sift/panel_configurations/v1/panel_configuration.proto

Services

RPC methods exposed by this API.

PanelConfigurationService

Method	Request	Response	Description
GetPanelConfiguration	GetPanelConfigurationRequest	GetPanelConfigurationResponse	Retrieves a panel configuration.
ListPanelConfigurations	ListPanelConfigurationsRequest	ListPanelConfigurationsResponse	Retrieves panel configurations using an optional filter.
CreatePanelConfiguration	CreatePanelConfigurationRequest	CreatePanelConfigurationResponse	Creates a panel configuration.
UpdatePanelConfiguration	UpdatePanelConfigurationRequest	UpdatePanelConfigurationResponse	Updates an existing panel configuration using using the list of fields specified in update_mask.

Messages

Data models used across requests/responses.

ChannelConfigurations

Field	Type	Label	Description
name	string
type	PlottedChannelType
color	string
channel_settings	google.protobuf.Struct
bit_field_index	int32	optional	bitfield
bit_field_element	sift.common.type.v1.ChannelBitFieldElement	optional
expression	string	optional	temporary calculated channel
expression_channel_references	sift.calculated_channels.v2.CalculatedChannelAbstractChannelReference	repeated
data_type	sift.common.type.v1.ChannelDataType	optional

CreatePanelConfigurationRequest

Field	Type	Label	Description
name	string
channel_configurations	ChannelConfigurations	repeated
chart_settings	google.protobuf.Struct	optional
metadata	sift.metadata.v1.MetadataValue	repeated

CreatePanelConfigurationResponse

Field	Type	Label	Description
panel_configuration	PanelConfiguration

GetPanelConfigurationRequest

Field	Type	Label	Description
panel_configuration_id	string

GetPanelConfigurationResponse

Field	Type	Label	Description
panel_configuration	PanelConfiguration

ListPanelConfigurationsRequest

Field	Type	Label	Description
page_size	uint32		The maximum number of panel configurations to return. The service may return fewer than this value. If unspecified, at most 50 panel configurations 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 ListPanelConfigurations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPanelConfigurations 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’, ‘created_date’, ‘modified_date’, ‘is_archived’, and metadata. Metadata can be used in filters by using metadata.{metadata_key_name} as the field name. Folder membership is filterable via the folders and activeFolders fields. Both contain the ids of the folders the panel configuration belongs to; activeFolders excludes archived folders. Use "<folder_id>" in folders to return panel configurations in the given folder, and size(activeFolders) == 0 to return uncategorized panel configurations (panel configurations whose only memberships are in archived folders count as uncategorized). For further information about how to use CELs, please refer to this guide.
order_by	string		How to order the retrieved panel configurations. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are name. If left empty, items are ordered by name in ascending order (alphabetical). For more information about the format of this field, read this Example: “name”
run_ids	string	repeated
asset_ids	string	repeated

ListPanelConfigurationsResponse

Field	Type	Label	Description
panel_configurations	PanelConfiguration	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.

PanelConfiguration

Field	Type	Label	Description
panel_configuration_id	string
version_id	string
version	uint32
change_message	string
name	string
channel_configurations	ChannelConfigurations	repeated
chart_settings	google.protobuf.Struct	optional
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
archived_date	google.protobuf.Timestamp
created_by_user_id	string
modified_by_user_id	string
is_archived	bool
metadata	sift.metadata.v1.MetadataValue	repeated
folder_ids	string	repeated	Ids of the folders this panel configuration belongs to.

UpdatePanelConfigurationRequest

The request for a call to PanelConfigurationService_UpdatePanelConfiguration to update a panel configuration. Updating a panel configuration creates a new version of the panel configuration, leaving the previous untouched. If no update is deemed necessary, then the the current version is returned. Use is_archived to archive/unarchive a panel configuration.

Field	Type	Label	Description
panel_configuration	PanelConfiguration		The panel configuration to update.
update_mask	google.protobuf.FieldMask		The list of fields to be updated. The fields available to be updated are name, channel_configurations, chart_settings, is_archived, and metadata.

UpdatePanelConfigurationResponse

Field	Type	Label	Description
panel_configuration	PanelConfiguration

Enums

Allowed constant values used in message fields.

PlottedChannelType

Name	Number	Description
PLOTTED_CHANNEL_TYPE_UNSPECIFIED	0	Deprecated.
PLOTTED_CHANNEL_TYPE_REGULAR	1
PLOTTED_CHANNEL_TYPE_CALCULATED_CHANNEL	2
PLOTTED_CHANNEL_TYPE_BIT_FIELD_ELEMENT	3
PLOTTED_CHANNEL_TYPE_ENUM	4