channels
Protocol buffer definition for channels
sift/channels/v2/channels.proto
Channel
| Field | Type | Label | Description |
|---|---|---|---|
| channel_id | string | ||
| name | string | ||
| component | string | ||
| asset_id | string | ||
| description | string | ||
| unit_id | string | ||
| created_date | google.protobuf.Timestamp | ||
| modified_date | google.protobuf.Timestamp | ||
| created_by_user_id | string | ||
| modified_by_user_id | string | ||
| organization_id | string | ||
| data_type | sift.common.type.v1.ChannelDataType | ||
| enum_types | sift.common.type.v1.ChannelEnumType | repeated | |
| bit_field_elements | sift.common.type.v1.ChannelBitFieldElement | repeated |
GetChannelRequest
The request for a call to ChannelService_GetChannel.
| Field | Type | Label | Description |
|---|---|---|---|
| channel_id | string |
GetChannelResponse
The response of a call to ChannelService_GetChannel.
| Field | Type | Label | Description |
|---|---|---|---|
| channel | Channel |
ListChannelsRequest
The request for a call to ChannelService_ListChannels to retrieve channels.
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of channels to return. The service may return fewer than this value. If unspecified, at most 50 channels will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000. Optional. | |
| page_token | string | A page token, received from a previous ListChannels call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListChannels 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 channel_id, asset_id, name, component, description, active, created_date, and modified_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 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" |
ListChannelsResponse
The result of a call to ChannelService_ListChannels.
ChannelService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetChannel | GetChannelRequest | GetChannelResponse | Retrieve a channel |
| ListChannels | ListChannelsRequest | ListChannelsResponse | Retrieve channels using an optional filter. |