Reference documentation and code samples for the Cloud PubSub V1 Client class CloudStorageConfig.
Configuration for a Cloud Storage subscription.
Generated from protobuf message google.pubsub.v1.CloudStorageConfig
Namespace
Google \ Cloud \ PubSub \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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 .
↳ filename_prefix
↳ filename_suffix
string
User-provided suffix for Cloud Storage filename. See the object naming requirements . Must not end in "/".
↳ text_config
Google\Cloud\PubSub\V1\CloudStorageConfig\TextConfig
If set, message data will be written to Cloud Storage in text format.
↳ avro_config
Google\Cloud\PubSub\V1\CloudStorageConfig\AvroConfig
If set, message data will be written to Cloud Storage in Avro format.
↳ max_duration
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_bytes
int|string
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.
↳ state
int
Output only. An output-only field that indicates whether or not the subscription can receive messages.
getBucket
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 .
string
setBucket
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 .
var
string
$this
getFilenamePrefix
User-provided prefix for Cloud Storage filename. See the object naming requirements .
string
setFilenamePrefix
User-provided prefix for Cloud Storage filename. See the object naming requirements .
var
string
$this
getFilenameSuffix
User-provided suffix for Cloud Storage filename. See the object naming requirements . Must not end in "/".
string
setFilenameSuffix
User-provided suffix for Cloud Storage filename. See the object naming requirements . Must not end in "/".
var
string
$this
getTextConfig
If set, message data will be written to Cloud Storage in text format.
hasTextConfig
setTextConfig
If set, message data will be written to Cloud Storage in text format.
$this
getAvroConfig
If set, message data will be written to Cloud Storage in Avro format.
hasAvroConfig
setAvroConfig
If set, message data will be written to Cloud Storage in Avro format.
$this
getMaxDuration
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.
hasMaxDuration
clearMaxDuration
setMaxDuration
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.
$this
getMaxBytes
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.
int|string
setMaxBytes
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.
var
int|string
$this
getState
Output only. An output-only field that indicates whether or not the subscription can receive messages.
int
setState
Output only. An output-only field that indicates whether or not the subscription can receive messages.
var
int
$this
getOutputFormat
string
