ingestion_configs

Protocol buffer definition for ingestion_configs

sift/ingestion_configs/v1/ingestion_configs.proto

ChannelConfig

FieldTypeLabelDescription
namestring
componentstring
unitstring
descriptionstring
data_typesift.common.type.v1.ChannelDataType
enum_typessift.common.type.v1.ChannelEnumTyperepeated
bit_field_elementssift.common.type.v1.ChannelBitFieldElementrepeated

CreateIngestionConfigFlowsRequest

The request for a call to IngestionConfigService_CreateIngestionConfigFlows to create ingestion config flows.

FieldTypeLabelDescription
ingestion_config_idstring
flowsFlowConfigrepeatedThese 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.

FieldTypeLabelDescription
asset_namestring
flowsFlowConfigrepeated
organization_idstring
client_keystringThe 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.

FieldTypeLabelDescription
ingestion_configIngestionConfig

FlowConfig

FieldTypeLabelDescription
namestring
channelsChannelConfigrepeated

GetIngestionConfigRequest

The request for a call to IngestionConfigService_GetIngestionConfig to retrieve an ingestion config.

FieldTypeLabelDescription
ingestion_config_idstring

GetIngestionConfigResponse

The result of a call to IngestionConfigService_GetIngestionConfig.

FieldTypeLabelDescription
ingestion_configIngestionConfig

IngestionConfig

FieldTypeLabelDescription
ingestion_config_idstring
asset_idstring
client_keystring

ListIngestionConfigFlowsRequest

The request for a call to IngestionConfigService_ListIngestionConfigFlows to retrieve ingestion config flows.

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

FieldTypeLabelDescription
flowsFlowConfigrepeated
next_page_tokenstring

ListIngestionConfigsRequest

The request for a call to IngestionConfigService_ListIngestionConfigs to retrieve ingestion configs.

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

FieldTypeLabelDescription
ingestion_configsIngestionConfigrepeated
next_page_tokenstring

IngestionConfigService

Method NameRequest TypeResponse TypeDescription
GetIngestionConfigGetIngestionConfigRequestGetIngestionConfigResponseRetrieves an ingestion config.
CreateIngestionConfigCreateIngestionConfigRequestCreateIngestionConfigResponseCreate an ingestion config.
ListIngestionConfigsListIngestionConfigsRequestListIngestionConfigsResponseList ingestion configs using an optional filter.
CreateIngestionConfigFlowsCreateIngestionConfigFlowsRequestCreateIngestionConfigFlowsResponseCreate ingestion config flows.
ListIngestionConfigFlowsListIngestionConfigFlowsRequestListIngestionConfigFlowsResponseList ingestion config flows using an optional filter.

On this page