Protocol Buffers (Protobuf) Reader Parameters

Schema Options

This parameter determines whether or not the reader should use a .proto file to deserialize and map the binary file:

Yes (default) – This option forces the reader to use a .proto schema.

No – The reader will deserialize the binary into readable text. This is similar to the –- decode_raw option when using the Protobuf Compiler (Protoc).

This parameter is the file path to the .proto schema. Imports are recursively resolved and included in the Feature Type output.

Note  google/protobuf/go_features.proto and google/protobuf/java_features.proto are not currently supported. Use the Allow Incomplete Proto Schemas option to continue, or use an absolute path to these .proto files. All other Protobuf Well Known Types are supported.

This parameter asks for the message type to read. This is the same as -- decode=MESSAGE_TYPE when using the Protobuf Compiler (Protoc).

By default, the .proto schema parser expects a complete proto definition.

This option will suppress failures regarding missing Message definitions. Missing message definitions will be decoded raw into the _Unknown feature type.

Settings

This parameter will produce additional feature attributes related to the .proto file. Attributes prefixed with Protobuf_ are File level Options, attributes prefixed with an underscore are Message, Field, or Service related options.

Note  Custom Options are not yet supported.

Schema Attributes

Use this parameter to expose Format Attributes in FME Workbench when you create a workspace:

  • In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime.
  • In a non-dynamic scenario, this parameter allows you to expose additional attributes on multiple feature types. Click the browse button to view the available format attributes (which are different for each format) for the reader.