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 \ CloudStorageConfigMethods
__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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|