SubscriptionCloudStorageConfig class
Constructors
-
SubscriptionCloudStorageConfig({Input<SubscriptionCloudStorageConfigAvroConfig?>? avroConfig, required Input<String> bucket, Input<String?>? filenameDatetimeFormat, Input<String?>? filenamePrefix, Input<String?>? filenameSuffix, Input<int?>? maxBytes, Input<String?>? maxDuration, Input<int?>? maxMessages, Input<String?>? serviceAccountEmail, Input<String?>? state, Input<SubscriptionCloudStorageConfigTextConfig?>? textConfig})
-
Creates a new SubscriptionCloudStorageConfig.
avroConfig If set, message data will be written to Cloud Storage in Avro format.
bucket 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://".
filenameDatetimeFormat User-provided format string specifying how to represent datetimes in Cloud Storage filenames.
filenamePrefix User-provided prefix for Cloud Storage filename.
filenameSuffix User-provided suffix for Cloud Storage filename. Must not end in "/".
maxBytes The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB.
maxDuration The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes.
maxMessages The maximum messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
serviceAccountEmail The service account to use to write to Cloud Storage. If not specified, the Pub/Sub
state (Output)
textConfig If set, message data will be written to Cloud Storage in text format.
const
-
SubscriptionCloudStorageConfig.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
avroConfig
→ Input<SubscriptionCloudStorageConfigAvroConfig?>?
-
If set, message data will be written to Cloud Storage in Avro format.
Structure is documented below.
final
-
bucket
→ Input<String>
-
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://".
final
-
filenameDatetimeFormat
→ Input<String?>?
-
User-provided format string specifying how to represent datetimes in Cloud Storage filenames.
final
-
filenamePrefix
→ Input<String?>?
-
User-provided prefix for Cloud Storage filename.
final
-
filenameSuffix
→ Input<String?>?
-
User-provided suffix for Cloud Storage filename. Must not end in "/".
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
maxBytes
→ Input<int?>?
-
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 maxBytes limit may be exceeded in cases where messages are larger than the limit.
final
-
maxDuration
→ Input<String?>?
-
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.
A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
final
-
maxMessages
→ Input<int?>?
-
The maximum messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
serviceAccountEmail
→ Input<String?>?
-
The service account to use to write to Cloud Storage. If not specified, the Pub/Sub
service agent,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
final
-
state
→ Input<String?>?
-
(Output)
An output-only field that indicates whether or not the subscription can receive messages.
final
-
textConfig
→ Input<SubscriptionCloudStorageConfigTextConfig?>?
-
If set, message data will be written to Cloud Storage in text format.
Structure is documented below.
final
