Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 Client class CloudStorageConfig.
Configuration for a Cloud Storage subscription.
Generated from protobuf message google.cloud.bigquery.analyticshub.v1.CloudStorageConfig
Namespace
Google \ Cloud \ BigQuery \ AnalyticsHub \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ text_config
CloudStorageConfig\TextConfig
Optional. If set, message data will be written to Cloud Storage in text format.
↳ avro_config
CloudStorageConfig\AvroConfig
Optional. If set, message data will be written to Cloud Storage in Avro format.
↳ 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
string
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements .
↳ filename_suffix
string
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements . Must not end in "/".
↳ filename_datetime_format
string
Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance .
↳ max_duration
Google\Protobuf\Duration
Optional. File batching settings. If no max_duration setting is specified, a max_duration of 5 minutes will be set by default. max_duration is required regardless of whether other file batching settings are specified. 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
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.
↳ 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 have iam.serviceAccounts.actAs
permission on the service account. If not specified, the Pub/Sub service agent
, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
getTextConfig
Optional. If set, message data will be written to Cloud Storage in text format.
hasTextConfig
setTextConfig
Optional. If set, message data will be written to Cloud Storage in text format.
$this
getAvroConfig
Optional. If set, message data will be written to Cloud Storage in Avro format.
hasAvroConfig
setAvroConfig
Optional. If set, message data will be written to Cloud Storage in Avro format.
$this
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
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements .
string
setFilenamePrefix
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements .
var
string
$this
getFilenameSuffix
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements .
Must not end in "/".
string
setFilenameSuffix
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements .
Must not end in "/".
var
string
$this
getFilenameDatetimeFormat
Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance .
string
setFilenameDatetimeFormat
Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance .
var
string
$this
getMaxDuration
Optional. File batching settings.
If no max_duration setting is specified, a max_duration of 5 minutes will be set by default. max_duration is required regardless of whether other file batching settings are specified. 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
Optional. File batching settings.
If no max_duration setting is specified, a max_duration of 5 minutes will be set by default. max_duration is required regardless of whether other file batching settings are specified. 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
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.
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.
var
int|string
$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.
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.
var
int|string
$this
getServiceAccountEmail
Optional. The service account to use to write to Cloud Storage. The
subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs
permission on the service account. If not
specified, the Pub/Sub service agent
,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
string
setServiceAccountEmail
Optional. The service account to use to write to Cloud Storage. The
subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs
permission on the service account. If not
specified, the Pub/Sub service agent
,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
var
string
$this
getOutputFormat
string
