Class: Google::Apis::PubsubV1::CloudStorageConfig

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 a Cloud Storage subscription.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CloudStorageConfig

Returns a new instance of CloudStorageConfig.



257
258
259
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 257

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

Instance Attribute Details

#avro_config ⇒ Google::Apis::PubsubV1::AvroConfig

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

Returns:



208
209
210
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 208

def avro_config
  @avro_config
end

#bucket ⇒ String

Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the bucket naming requirements. Corresponds to the JSON property bucket

Returns:

  • (String) 


216
217
218
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 216

def bucket
  @bucket
end

#filename_prefix ⇒ String

Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements. Corresponds to the JSON property filenamePrefix

Returns:

  • (String) 


222
223
224
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 222

def filename_prefix
  @filename_prefix
end

#filename_suffix ⇒ String

Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/". Corresponds to the JSON property filenameSuffix

Returns:

  • (String) 


229
230
231
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 229

def filename_suffix
  @filename_suffix
end

#max_bytes ⇒ Fixnum

Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit. Corresponds to the JSON property maxBytes

Returns:

  • (Fixnum) 


236
237
238
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 236

def max_bytes
  @max_bytes
end

#max_duration ⇒ String

Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline. Corresponds to the JSON property maxDuration

Returns:

  • (String) 


243
244
245
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 243

def max_duration
  @max_duration
end

#state ⇒ String

Output only. An output-only field that indicates whether or not the subscription can receive messages. Corresponds to the JSON property state

Returns:

  • (String) 


249
250
251
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 249

def state
  @state
end

#text_config ⇒ Google::Apis::PubsubV1::TextConfig

Configuration for writing message data in text format. Message payloads will be written to files as raw text, separated by a newline. Corresponds to the JSON property textConfig

Returns:



255
256
257
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 255

def text_config
  @text_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



262
263
264
265
266
267
268
269
270
271
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 262

def update!(**args)
  @avro_config = args[:avro_config] if args.key?(:avro_config)
  @bucket = args[:bucket] if args.key?(:bucket)
  @filename_prefix = args[:filename_prefix] if args.key?(:filename_prefix)
  @filename_suffix = args[:filename_suffix] if args.key?(:filename_suffix)
  @max_bytes = args[:max_bytes] if args.key?(:max_bytes)
  @max_duration = args[:max_duration] if args.key?(:max_duration)
  @state = args[:state] if args.key?(:state)
  @text_config = args[:text_config] if args.key?(:text_config)
end