Reference documentation and code samples for the Analytics Hub V1 API class Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::AvroConfig.
Configuration for writing message data in Avro format.
Message payloads and metadata will be written to files as an Avro binary.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#use_topic_schema
defuse_topic_schema()->::Boolean
Returns
(::Boolean) — Optional. When true, the output Cloud Storage file will be serialized
using the topic schema, if it exists.
#use_topic_schema=
defuse_topic_schema=(value)->::Boolean
Parameter
value (::Boolean) — Optional. When true, the output Cloud Storage file will be serialized
using the topic schema, if it exists.
Returns
(::Boolean) — Optional. When true, the output Cloud Storage file will be serialized
using the topic schema, if it exists.
#write_metadata
defwrite_metadata()->::Boolean
Returns
(::Boolean) — 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.
#write_metadata=
defwrite_metadata=(value)->::Boolean
Parameter
value (::Boolean) — 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
(::Boolean) — 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.
[[["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-09 UTC."],[],[],null,["# Analytics Hub V1 API - Class Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::AvroConfig (v0.13.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.1 (latest)](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/latest/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.13.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.13.0/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.12.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.12.0/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.11.1](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.11.1/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.10.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.10.0/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.9.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.9.0/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.8.1](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.8.1/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.7.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.7.0/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.6.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.6.0/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.5.2](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.5.2/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.4.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.4.0/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.3.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.3.0/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.2.1](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.2.1/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)\n- [0.1.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.1.0/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig) \nReference documentation and code samples for the Analytics Hub V1 API class Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::AvroConfig.\n\nConfiguration for writing message data in Avro format.\nMessage payloads and metadata will be written to files as an Avro binary. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #use_topic_schema\n\n def use_topic_schema() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.\n\n### #use_topic_schema=\n\n def use_topic_schema=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists. \n**Returns**\n\n- (::Boolean) --- Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.\n\n### #write_metadata\n\n def write_metadata() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- 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.\n\n### #write_metadata=\n\n def write_metadata=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- 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. \n**Returns**\n\n- (::Boolean) --- 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."]]
