Cloud PubSub V1 Client - Class AvroConfig (1.50.0)

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 message google.pubsub.v1.CloudStorageConfig.AvroConfig

Namespace

Google \ Cloud \ PubSub \ V1 \ CloudStorageConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ write_metadata bool

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.

getWriteMetadata

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
TypeDescription
bool

setWriteMetadata

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
NameDescription
var bool
Returns
TypeDescription
$this