package tika

Get desktop application:
View/edit binary Protocol Buffers messages

The Tika Grpc Service definition

• rpc SaveFetcher (SaveFetcherRequest, SaveFetcherReply)

  tika.proto:27

  Save a fetcher to the fetcher store.

  message SaveFetcherRequest

  tika.proto:64

  • string fetcher_id = 1

    A unique identifier for each fetcher. If this already exists, operation will overwrite existing.

  • string fetcher_class = 2

    The full java class name of the fetcher class. List of fetcher classes is found here: https://cwiki.apache.org/confluence/display/TIKA/tika-pipes

  • string fetcher_config_json = 3

    JSON string of the fetcher config object. To see the json schema from which to build this json, use the GetFetcherConfigJsonSchema rpc method.

  message SaveFetcherReply

  tika.proto:75

  • string fetcher_id = 1

    The fetcher_id that was saved.

• rpc GetFetcher (GetFetcherRequest, GetFetcherReply)

  tika.proto:31

  Get a fetcher's data from the fetcher store.

  message GetFetcherRequest

  tika.proto:111

  • string fetcher_id = 1

    ID of the fetcher for which to return config.

• rpc ListFetchers (ListFetchersRequest, ListFetchersReply)

  tika.proto:35

  List fetchers that are currently in the fetcher store.

  message ListFetchersRequest

  tika.proto:125

  • int32 page_number = 1

    List the fetchers starting at this page number

  • int32 num_fetchers_per_page = 2

    List this many fetchers per page.

  message ListFetchersReply

  tika.proto:132

  • repeated GetFetcherReply get_fetcher_replies = 1

    List of fetcher configs returned by the Lists Fetchers service.

• rpc DeleteFetcher (DeleteFetcherRequest, DeleteFetcherReply)

  tika.proto:39

  Delete a fetcher from the fetcher store.

  message DeleteFetcherRequest

  tika.proto:101

  • string fetcher_id = 1

    ID of the fetcher to delete.

  message DeleteFetcherReply

  tika.proto:106

  • bool success = 1

    Success if the fetcher was successfully removed from the fetch store.

• rpc FetchAndParse (FetchAndParseRequest, FetchAndParseReply)

  tika.proto:44

  Using a Fetcher in the fetcher store, send a FetchAndParse request. This will fetch, parse, and return the FetchParseTuple data output from Tika Pipes. This is a synchronous call that immediately returns 1 result.

• rpc FetchAndParseServerSideStreaming (FetchAndParseRequest, stream FetchAndParseReply)

  tika.proto:49

  Using a Fetcher in the fetcher store, send a FetchAndParse request. This will fetch, parse, and return the FetchParseTuple data output from Tika Pipes. This will stream the data from the server in response.

• rpc FetchAndParseBiDirectionalStreaming (stream FetchAndParseRequest, stream FetchAndParseReply)

  tika.proto:56

  Using a Fetcher in the fetcher store, send a FetchAndParse request. This will fetch, parse, and return the FetchParseTuple data output from Tika Pipes. This serves a bi-directional stream of fetch inputs and parsed outputs.

• rpc GetFetcherConfigJsonSchema (GetFetcherConfigJsonSchemaRequest, GetFetcherConfigJsonSchemaReply)

  tika.proto:61

  Get the Fetcher Config schema for a given fetcher class.

  message GetFetcherConfigJsonSchemaRequest

  tika.proto:137

  • string fetcher_class = 1

    The full java class name of the fetcher config for which to fetch json schema.

  message GetFetcherConfigJsonSchemaReply

  tika.proto:142

  • string fetcher_config_json_schema = 1

    The json schema that describes the fetcher config in string format.

Used as response type in: Tika.FetchAndParse, Tika.FetchAndParseBiDirectionalStreaming, Tika.FetchAndParseServerSideStreaming

• string fetch_key = 1

  Echoes the fetch_key that was sent in the request.

• map<string, string> fields = 2

  Metadata fields from the parse output.

• string status = 3

  The status from the message. See javadoc for org.apache.tika.pipes.PipesResult.STATUS for the list of status.

• string error_message = 4

  If there was an error, this will contain the error message.

Used as request type in: Tika.FetchAndParse, Tika.FetchAndParseBiDirectionalStreaming, Tika.FetchAndParseServerSideStreaming

• string fetcher_id = 1

  The ID of the fetcher in the fetcher store (previously saved by SaveFetcher) to use for the fetch.

• string fetch_key = 2

  The "Fetch Key" of the item that will be fetched.

• string additional_fetch_config_json = 3

  You can supply additional fetch configuration using this. Follows same fetch configuration json schema as the fetcher configuration.

Used as response type in: Tika.GetFetcher

Used as field type in: ListFetchersReply

• string fetcher_id = 1

  Echoes the ID of the fetcher being returned.

• string fetcher_class = 2

  The full Java class name of the Fetcher.

• map<string, string> params = 3

  The configuration parameters.