Send feedback
Class AvroConfig (2.31.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
AvroConfig ( mapping = None , * , ignore_unknown_fields = False , ** kwargs )
Configuration for writing message data in Avro format.
Message payloads and metadata will be written to files as an
Avro binary.
Attributes
Name
Description
write_metadata
:noindex:
bool
Optional. When true, write the subscription name,
message_id, publish_time, attributes, and ordering_key as
additional fields in the output. The subscription name,
message_id, and publish_time fields are put in their own
fields while all other message properties other than data
(for example, an ordering_key, if present) are added as
entries in the attributes map.
use_topic_schema
:noindex:
bool
Optional. When true, the output Cloud Storage
file will be serialized using the topic schema,
if it exists.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class AvroConfig (2.31.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.31.0 (latest)](/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.30.0](/python/docs/reference/pubsub/2.30.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.29.1](/python/docs/reference/pubsub/2.29.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.28.0](/python/docs/reference/pubsub/2.28.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.27.3](/python/docs/reference/pubsub/2.27.3/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.26.1](/python/docs/reference/pubsub/2.26.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.25.2](/python/docs/reference/pubsub/2.25.2/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.23.1](/python/docs/reference/pubsub/2.23.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.22.0](/python/docs/reference/pubsub/2.22.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.21.5](/python/docs/reference/pubsub/2.21.5/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.20.3](/python/docs/reference/pubsub/2.20.3/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.19.8](/python/docs/reference/pubsub/2.19.8/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.18.4](/python/docs/reference/pubsub/2.18.4/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.17.1](/python/docs/reference/pubsub/2.17.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.16.1](/python/docs/reference/pubsub/2.16.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.15.2](/python/docs/reference/pubsub/2.15.2/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.14.1](/python/docs/reference/pubsub/2.14.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.13.12](/python/docs/reference/pubsub/2.13.12/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.12.1](/python/docs/reference/pubsub/2.12.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.11.1](/python/docs/reference/pubsub/2.11.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.10.0](/python/docs/reference/pubsub/2.10.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.9.0](/python/docs/reference/pubsub/2.9.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.8.0](/python/docs/reference/pubsub/2.8.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.7.1](/python/docs/reference/pubsub/2.7.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.6.1](/python/docs/reference/pubsub/2.6.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.5.0](/python/docs/reference/pubsub/2.5.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.4.2](/python/docs/reference/pubsub/2.4.2/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.3.0](/python/docs/reference/pubsub/2.3.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.2.0](/python/docs/reference/pubsub/2.2.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.1.0](/python/docs/reference/pubsub/2.1.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [2.0.0](/python/docs/reference/pubsub/2.0.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [1.7.2](/python/docs/reference/pubsub/1.7.2/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [1.6.1](/python/docs/reference/pubsub/1.6.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [1.5.0](/python/docs/reference/pubsub/1.5.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [1.4.3](/python/docs/reference/pubsub/1.4.3/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [1.3.1](/python/docs/reference/pubsub/1.3.1/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [1.2.0](/python/docs/reference/pubsub/1.2.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [1.1.0](/python/docs/reference/pubsub/1.1.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [1.0.2](/python/docs/reference/pubsub/1.0.2/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [0.45.0](/python/docs/reference/pubsub/0.45.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [0.44.0](/python/docs/reference/pubsub/0.44.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig)\n- [0.43.0](/python/docs/reference/pubsub/0.43.0/google.cloud.pubsub_v1.types.CloudStorageConfig.AvroConfig) \n\n AvroConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nConfiguration for writing message data in Avro format.\nMessage payloads and metadata will be written to files as an\nAvro binary."]]