ingestion_configs
Protocol buffer definition for ingestion_configs
sift/ingestion_configs/v2/ingestion_configs.proto
ChannelConfig
Field | Type | Label | Description |
---|---|---|---|
name | string | ||
unit | string | ||
description | 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 |
CreateIngestionConfigFlowsRequest
The request for a call to IngestionConfigService_CreateIngestionConfigFlows
to create ingestion config flows.
Field | Type | Label | Description |
---|---|---|---|
ingestion_config_id | string | ||
flows | FlowConfig | repeated | These flows must have unique names. If you try to send a flow with a name that already exists for an ingestion config, it will return an error. |
CreateIngestionConfigFlowsResponse
The result of a call to IngestionConfigService_CreateIngestionConfigFlows
.
CreateIngestionConfigRequest
The request for a call to IngestionConfigService_ListIngestionConfigs
to retrieve ingestion configs.
Field | Type | Label | Description |
---|---|---|---|
asset_name | string | ||
flows | FlowConfig | repeated | |
organization_id | string | ||
client_key | string | The client_key field is a user-defined string you can supply to uniquely identify an ingestion config (and retrieve it via GetIngestionConfig ). An error is returned if you try to create an ingestion config with a client_key that already exists. |
CreateIngestionConfigResponse
The result of a call to IngestionConfigService_CreateIngestionConfig
.
Field | Type | Label | Description |
---|---|---|---|
ingestion_config | IngestionConfig |
FlowConfig
Field | Type | Label | Description |
---|---|---|---|
name | string | ||
channels | ChannelConfig | repeated |
GetIngestionConfigRequest
The request for a call to IngestionConfigService_GetIngestionConfig
to retrieve an ingestion config.
Field | Type | Label | Description |
---|---|---|---|
ingestion_config_id | string |
GetIngestionConfigResponse
The result of a call to IngestionConfigService_GetIngestionConfig
.
Field | Type | Label | Description |
---|---|---|---|
ingestion_config | IngestionConfig |
IngestionConfig
ListIngestionConfigFlowsRequest
The request for a call to IngestionConfigService_ListIngestionConfigFlows
to retrieve ingestion config flows.
Field | Type | Label | Description |
---|---|---|---|
ingestion_config_id | string | ||
page_size | uint32 | The maximum number of ingestion config flows to return. The service may return fewer than this value. If unspecified, at most 50 ingestion config flows will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional. | |
page_token | string | A page token, received from a previous ListIngestionConfigFlows call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIngestionConfigFlows 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 flow_name , flow_id , 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. |
ListIngestionConfigFlowsResponse
The result of a call to IngestionConfigService_ListIngestionConfigFlows
.
Field | Type | Label | Description |
---|---|---|---|
flows | FlowConfig | repeated | |
next_page_token | string |
ListIngestionConfigsRequest
The request for a call to IngestionConfigService_ListIngestionConfigs
to retrieve ingestion configs.
Field | Type | Label | Description |
---|---|---|---|
page_size | uint32 | The maximum number of ingestion configs to return. The service may return fewer than this value. If unspecified, at most 50 ingestion configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional. | |
page_token | string | A page token, received from a previous ListIngestionConfigs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIngestionConfigs 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 ingestion_config_id , client_key , asset_id , 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. |
ListIngestionConfigsResponse
The result of a call to IngestionConfigService_ListIngestionConfigs
.
Field | Type | Label | Description |
---|---|---|---|
ingestion_configs | IngestionConfig | repeated | |
next_page_token | string |
IngestionConfigService
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetIngestionConfig | GetIngestionConfigRequest | GetIngestionConfigResponse | Retrieves an ingestion config. |
CreateIngestionConfig | CreateIngestionConfigRequest | CreateIngestionConfigResponse | Create an ingestion config. |
ListIngestionConfigs | ListIngestionConfigsRequest | ListIngestionConfigsResponse | List ingestion configs using an optional filter. |
CreateIngestionConfigFlows | CreateIngestionConfigFlowsRequest | CreateIngestionConfigFlowsResponse | Create ingestion config flows. |
ListIngestionConfigFlows | ListIngestionConfigFlowsRequest | ListIngestionConfigFlowsResponse | List ingestion config flows using an optional filter. |