Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::CloudStorageConfig.
Configuration for a Cloud Storage subscription.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#avro_config
def avro_config() -> ::Google::Cloud::PubSub::V1::CloudStorageConfig::AvroConfig
Returns
- (::Google::Cloud::PubSub::V1::CloudStorageConfig::AvroConfig) — If set, message data will be written to Cloud Storage in Avro format.
#avro_config=
def avro_config=(value) -> ::Google::Cloud::PubSub::V1::CloudStorageConfig::AvroConfig
Parameter
- value (::Google::Cloud::PubSub::V1::CloudStorageConfig::AvroConfig) — If set, message data will be written to Cloud Storage in Avro format.
Returns
- (::Google::Cloud::PubSub::V1::CloudStorageConfig::AvroConfig) — If set, message data will be written to Cloud Storage in Avro format.
#bucket
def bucket() -> ::String
Returns
- (::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.
#bucket=
def bucket=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.
#filename_prefix
def filename_prefix() -> ::String
Returns
- (::String) — User-provided prefix for Cloud Storage filename. See the object naming requirements.
#filename_prefix=
def filename_prefix=(value) -> ::String
Parameter
- value (::String) — User-provided prefix for Cloud Storage filename. See the object naming requirements.
Returns
- (::String) — User-provided prefix for Cloud Storage filename. See the object naming requirements.
#filename_suffix
def filename_suffix() -> ::String
Returns
- (::String) — User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
#filename_suffix=
def filename_suffix=(value) -> ::String
Parameter
- value (::String) — User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
Returns
- (::String) — User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
#max_bytes
def max_bytes() -> ::Integer
Returns
- (::Integer) — 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.
#max_bytes=
def max_bytes=(value) -> ::Integer
Parameter
- value (::Integer) — 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.
Returns
- (::Integer) — 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.
#max_duration
def max_duration() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — 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.
#max_duration=
def max_duration=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::Google::Protobuf::Duration) — 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.
Returns
- (::Google::Protobuf::Duration) — 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.
#state
def state() -> ::Google::Cloud::PubSub::V1::CloudStorageConfig::State
Returns
- (::Google::Cloud::PubSub::V1::CloudStorageConfig::State) — Output only. An output-only field that indicates whether or not the subscription can receive messages.
#text_config
def text_config() -> ::Google::Cloud::PubSub::V1::CloudStorageConfig::TextConfig
Returns
- (::Google::Cloud::PubSub::V1::CloudStorageConfig::TextConfig) — If set, message data will be written to Cloud Storage in text format.
#text_config=
def text_config=(value) -> ::Google::Cloud::PubSub::V1::CloudStorageConfig::TextConfig
Parameter
- value (::Google::Cloud::PubSub::V1::CloudStorageConfig::TextConfig) — If set, message data will be written to Cloud Storage in text format.
Returns
- (::Google::Cloud::PubSub::V1::CloudStorageConfig::TextConfig) — If set, message data will be written to Cloud Storage in text format.