channel_schemas
Protocol buffer definition for channel_schemas
sift/channel_schemas/v1/channel_schemas.proto
BatchCreateChannelSchemasRequest
The request for a call to ChannelSchemaService_BatchCreateChannelSchemas
.
Field | Type | Label | Description |
---|---|---|---|
requests | CreateChannelSchemaRequest | repeated | Limit of 1000 channels schemas per batch |
asset_name | string | The asset to which the channel schemas belong (case-insensitive). If this field, and any of the child requests specify an asset, the assets must match. | |
organization_id | string | The organization to which the channel schemas belong. If this field, and any of the child requests specify an organization_id, the organization_ids must match. This field is optional if the caller belongs to a single organization. |
BatchCreateChannelSchemasResponse
The response of a call to ChannelSchemaService_BatchCreateChannelSchemas
.
CreateChannelSchemaRequest
The request for a call to ChannelSchemaService_CreateChannelSchema
.
Field | Type | Label | Description |
---|---|---|---|
component | string | The name of the component (case-insensitive). | |
channel | string | The name of the channel (case-insensitive). | |
unit | 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 | |
asset_name | string | The name of the asset (case-insensitive). | |
organization_id | string | This field is optional if the caller belongs to a single organization. |
CreateChannelSchemaResponse
The response of a call to ChannelSchemaService_CreateChannelSchema
.
ChannelSchemaService
Method Name | Request Type | Response Type | Description |
---|---|---|---|
CreateChannelSchema | CreateChannelSchemaRequest | CreateChannelSchemaResponse | Create a channel schema |
BatchCreateChannelSchemas | BatchCreateChannelSchemasRequest | BatchCreateChannelSchemasResponse | Create a batch of channel schemas |