Reference documentation and code samples for the Cloud PubSub V1 Client class CloudStorageConfig.
Configuration for a Cloud Storage subscription.
Generated from protobuf messagegoogle.pubsub.v1.CloudStorageConfig
Namespace
Google \ Cloud \ PubSub \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
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 thebucket naming requirements.
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 acknowledgment deadline.
↳ max_bytes
int|string
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.
↳ max_messages
int|string
Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
↳ state
int
Output only. An output-only field that indicates whether or not the subscription can receive messages.
↳ service_account_email
string
Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must haveiam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Subservice agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
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 thebucket naming
requirements.
Returns
Type
Description
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 thebucket naming
requirements.
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 acknowledgment deadline.
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 acknowledgment deadline.
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.
Returns
Type
Description
int|string
setMaxBytes
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.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getMaxMessages
Optional. The maximum number of messages that can be written to a Cloud
Storage file before a new file is created. Min 1000 messages.
Returns
Type
Description
int|string
setMaxMessages
Optional. The maximum number of messages that can be written to a Cloud
Storage file before a new file is created. Min 1000 messages.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getState
Output only. An output-only field that indicates whether or not the
subscription can receive messages.
Returns
Type
Description
int
setState
Output only. An output-only field that indicates whether or not the
subscription can receive messages.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getServiceAccountEmail
Optional. The service account to use to write to Cloud Storage. The
subscription creator or updater that specifies this field must haveiam.serviceAccounts.actAspermission on the service account. If not
specified, the Pub/Subservice agent,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
Returns
Type
Description
string
setServiceAccountEmail
Optional. The service account to use to write to Cloud Storage. The
subscription creator or updater that specifies this field must haveiam.serviceAccounts.actAspermission on the service account. If not
specified, the Pub/Subservice agent,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud PubSub V1 Client - Class CloudStorageConfig (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.CloudStorageConfig)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.CloudStorageConfig)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.CloudStorageConfig)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.CloudStorageConfig)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.CloudStorageConfig)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.CloudStorageConfig)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.CloudStorageConfig)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.CloudStorageConfig)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.CloudStorageConfig)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.CloudStorageConfig)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.CloudStorageConfig)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.CloudStorageConfig)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.CloudStorageConfig)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.CloudStorageConfig)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.CloudStorageConfig)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.CloudStorageConfig)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.CloudStorageConfig)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.CloudStorageConfig)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.CloudStorageConfig)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.CloudStorageConfig)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.CloudStorageConfig)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.CloudStorageConfig)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.CloudStorageConfig)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.CloudStorageConfig)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.CloudStorageConfig)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.CloudStorageConfig) \nReference documentation and code samples for the Cloud PubSub V1 Client class CloudStorageConfig.\n\nConfiguration for a Cloud Storage subscription.\n\nGenerated from protobuf message `google.pubsub.v1.CloudStorageConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBucket\n\nRequired. User-provided name for the Cloud Storage bucket.\n\nThe bucket must be created by the user. The bucket name must be without\nany prefix like \"gs://\". See the [bucket naming\nrequirements](https://cloud.google.com/storage/docs/buckets#naming).\n\n### setBucket\n\nRequired. User-provided name for the Cloud Storage bucket.\n\nThe bucket must be created by the user. The bucket name must be without\nany prefix like \"gs://\". See the [bucket naming\nrequirements](https://cloud.google.com/storage/docs/buckets#naming).\n\n### getFilenamePrefix\n\nOptional. User-provided prefix for Cloud Storage filename. See the [object\nnaming requirements](https://cloud.google.com/storage/docs/objects#naming).\n\n### setFilenamePrefix\n\nOptional. User-provided prefix for Cloud Storage filename. See the [object\nnaming requirements](https://cloud.google.com/storage/docs/objects#naming).\n\n### getFilenameSuffix\n\nOptional. User-provided suffix for Cloud Storage filename. See the [object\nnaming requirements](https://cloud.google.com/storage/docs/objects#naming).\n\nMust not end in \"/\".\n\n### setFilenameSuffix\n\nOptional. User-provided suffix for Cloud Storage filename. See the [object\nnaming requirements](https://cloud.google.com/storage/docs/objects#naming).\n\nMust not end in \"/\".\n\n### getFilenameDatetimeFormat\n\nOptional. User-provided format string specifying how to represent datetimes\nin Cloud Storage filenames. See the [datetime format\nguidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).\n\n### setFilenameDatetimeFormat\n\nOptional. User-provided format string specifying how to represent datetimes\nin Cloud Storage filenames. See the [datetime format\nguidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).\n\n### getTextConfig\n\nOptional. If set, message data will be written to Cloud Storage in text\nformat.\n\n### hasTextConfig\n\n### setTextConfig\n\nOptional. If set, message data will be written to Cloud Storage in text\nformat.\n\n### getAvroConfig\n\nOptional. If set, message data will be written to Cloud Storage in Avro\nformat.\n\n### hasAvroConfig\n\n### setAvroConfig\n\nOptional. If set, message data will be written to Cloud Storage in Avro\nformat.\n\n### getMaxDuration\n\nOptional. The maximum duration that can elapse before a new Cloud Storage\nfile is created. Min 1 minute, max 10 minutes, default 5 minutes. May not\nexceed the subscription's acknowledgment deadline.\n\n### hasMaxDuration\n\n### clearMaxDuration\n\n### setMaxDuration\n\nOptional. The maximum duration that can elapse before a new Cloud Storage\nfile is created. Min 1 minute, max 10 minutes, default 5 minutes. May not\nexceed the subscription's acknowledgment deadline.\n\n### getMaxBytes\n\nOptional. The maximum bytes that can be written to a Cloud Storage file\nbefore a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may\nbe exceeded in cases where messages are larger than the limit.\n\n### setMaxBytes\n\nOptional. The maximum bytes that can be written to a Cloud Storage file\nbefore a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may\nbe exceeded in cases where messages are larger than the limit.\n\n### getMaxMessages\n\nOptional. The maximum number of messages that can be written to a Cloud\nStorage file before a new file is created. Min 1000 messages.\n\n### setMaxMessages\n\nOptional. The maximum number of messages that can be written to a Cloud\nStorage file before a new file is created. Min 1000 messages.\n\n### getState\n\nOutput only. An output-only field that indicates whether or not the\nsubscription can receive messages.\n\n### setState\n\nOutput only. An output-only field that indicates whether or not the\nsubscription can receive messages.\n\n### getServiceAccountEmail\n\nOptional. The service account to use to write to Cloud Storage. The\nsubscription creator or updater that specifies this field must have\n`iam.serviceAccounts.actAs` permission on the service account. If not\nspecified, the Pub/Sub\n[service agent](https://cloud.google.com/iam/docs/service-agents),\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.\n\n### setServiceAccountEmail\n\nOptional. The service account to use to write to Cloud Storage. The\nsubscription creator or updater that specifies this field must have\n`iam.serviceAccounts.actAs` permission on the service account. If not\nspecified, the Pub/Sub\n[service agent](https://cloud.google.com/iam/docs/service-agents),\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.\n\n### getOutputFormat"]]
