Reference documentation and code samples for the Cloud PubSub V1 Client class AvroConfig.
Configuration for writing message data in Avro format.
Message payloads and metadata will be written to files as an Avro binary.
Generated from protobuf messagegoogle.pubsub.v1.CloudStorageConfig.AvroConfig
Namespace
Google \ Cloud \ PubSub \ V1 \ CloudStorageConfig
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ write_metadata
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
bool
Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.
getWriteMetadata
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.
Returns
Type
Description
bool
setWriteMetadata
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.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getUseTopicSchema
Optional. When true, the output Cloud Storage file will be serialized
using the topic schema, if it exists.
Returns
Type
Description
bool
setUseTopicSchema
Optional. When true, the output Cloud Storage file will be serialized
using the topic schema, if it exists.
[[["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-09-04 UTC."],[],[],null,["# Cloud PubSub V1 Client - Class AvroConfig (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.CloudStorageConfig.AvroConfig)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.CloudStorageConfig.AvroConfig)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.CloudStorageConfig.AvroConfig)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.CloudStorageConfig.AvroConfig)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.CloudStorageConfig.AvroConfig)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.CloudStorageConfig.AvroConfig)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.CloudStorageConfig.AvroConfig)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.CloudStorageConfig.AvroConfig)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.CloudStorageConfig.AvroConfig)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.CloudStorageConfig.AvroConfig)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.CloudStorageConfig.AvroConfig)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.CloudStorageConfig.AvroConfig)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.CloudStorageConfig.AvroConfig)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.CloudStorageConfig.AvroConfig)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.CloudStorageConfig.AvroConfig)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.CloudStorageConfig.AvroConfig)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.CloudStorageConfig.AvroConfig)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.CloudStorageConfig.AvroConfig)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.CloudStorageConfig.AvroConfig)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.CloudStorageConfig.AvroConfig)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.CloudStorageConfig.AvroConfig)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.CloudStorageConfig.AvroConfig)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.CloudStorageConfig.AvroConfig)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.CloudStorageConfig.AvroConfig)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.CloudStorageConfig.AvroConfig)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.CloudStorageConfig.AvroConfig) \nReference documentation and code samples for the Cloud PubSub V1 Client class AvroConfig.\n\nConfiguration for writing message data in Avro format.\n\nMessage payloads and metadata will be written to files as an Avro binary.\n\nGenerated from protobuf message `google.pubsub.v1.CloudStorageConfig.AvroConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1 \\\\ CloudStorageConfig\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getWriteMetadata\n\nOptional. When true, write the subscription name, message_id,\npublish_time, attributes, and ordering_key as additional fields in the\noutput. The subscription name, message_id, and publish_time fields are\nput in their own fields while all other message properties other than\ndata (for example, an ordering_key, if present) are added as entries in\nthe attributes map.\n\n### setWriteMetadata\n\nOptional. When true, write the subscription name, message_id,\npublish_time, attributes, and ordering_key as additional fields in the\noutput. The subscription name, message_id, and publish_time fields are\nput in their own fields while all other message properties other than\ndata (for example, an ordering_key, if present) are added as entries in\nthe attributes map.\n\n### getUseTopicSchema\n\nOptional. When true, the output Cloud Storage file will be serialized\nusing the topic schema, if it exists.\n\n### setUseTopicSchema\n\nOptional. When true, the output Cloud Storage file will be serialized\nusing the topic schema, if it exists."]]
