Class: Google::Apis::PubsubV1::AvroConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/pubsub_v1/classes.rb,
lib/google/apis/pubsub_v1/representations.rb,
lib/google/apis/pubsub_v1/representations.rb

Overview

Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AvroConfig

Returns a new instance of AvroConfig.



60
61
62
# File 'lib/google/apis/pubsub_v1/classes.rb', line 60

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#write_metadataBoolean Also known as: write_metadata?

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. Corresponds to the JSON property writeMetadata

Returns:

  • (Boolean)


57
58
59
# File 'lib/google/apis/pubsub_v1/classes.rb', line 57

def 
  @write_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



65
66
67
# File 'lib/google/apis/pubsub_v1/classes.rb', line 65

def update!(**args)
  @write_metadata = args[:write_metadata] if args.key?(:write_metadata)
end