# Analytics Hub V1 API - Class Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig (v0.19.0)

0.19.0 (latest) 0.18.0 0.17.0 0.16.1 0.15.0 0.14.0 0.13.1 0.12.0 0.11.1 0.10.0 0.9.0 0.8.1 0.7.0 0.6.0 0.5.2 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Analytics Hub V1 API class Google::Cloud::Bigquery::AnalyticsHub::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::Bigquery::AnalyticsHub::V1::CloudStorageConfig::AvroConfig

**Returns**

- ([::Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::AvroConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/latest/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)) --- Optional. If set, message data will be written to Cloud Storage in Avro format.


  Note: The following fields are mutually exclusive: `avro_config`, `text_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #avro_config=

    def avro_config=(value) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::AvroConfig

**Parameter**

- **value** ([::Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::AvroConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/latest/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)) --- Optional. If set, message data will be written to Cloud Storage in Avro format.


  Note: The following fields are mutually exclusive: `avro_config`, `text_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::AvroConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/latest/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-AvroConfig)) --- Optional. If set, message data will be written to Cloud Storage in Avro format.


  Note: The following fields are mutually exclusive: `avro_config`, `text_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #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](https://cloud.google.com/storage/docs/buckets#naming).

### #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](https://cloud.google.com/storage/docs/buckets#naming).
**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](https://cloud.google.com/storage/docs/buckets#naming).

### #filename_datetime_format

    def filename_datetime_format() -> ::String

**Returns**

- (::String) --- Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the [datetime format
  guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).

### #filename_datetime_format=

    def filename_datetime_format=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the [datetime format
  guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).
**Returns**

- (::String) --- Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the [datetime format
  guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).

### #filename_prefix

    def filename_prefix() -> ::String

**Returns**

- (::String) --- Optional. User-provided prefix for Cloud Storage filename. See the [object
  naming requirements](https://cloud.google.com/storage/docs/objects#naming).

### #filename_prefix=

    def filename_prefix=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. User-provided prefix for Cloud Storage filename. See the [object
  naming requirements](https://cloud.google.com/storage/docs/objects#naming).
**Returns**

- (::String) --- Optional. User-provided prefix for Cloud Storage filename. See the [object
  naming requirements](https://cloud.google.com/storage/docs/objects#naming).

### #filename_suffix

    def filename_suffix() -> ::String

**Returns**

- (::String) --- Optional. User-provided suffix for Cloud Storage filename. See the [object
  naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/".

### #filename_suffix=

    def filename_suffix=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. User-provided suffix for Cloud Storage filename. See the [object
  naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/".
**Returns**

- (::String) --- Optional. User-provided suffix for Cloud Storage filename. See the [object
  naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/".

### #max_bytes

    def max_bytes() -> ::Integer

**Returns**

- (::Integer) --- 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_bytes=

    def max_bytes=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- 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**

- (::Integer) --- 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_duration

    def max_duration() -> ::Google::Protobuf::Duration

**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/latest/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_duration=

    def max_duration=(value) -> ::Google::Protobuf::Duration

**Parameter**

- **value** ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/latest/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.
**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/latest/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_messages

    def max_messages() -> ::Integer

**Returns**

- (::Integer) --- Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.

### #max_messages=

    def max_messages=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- 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**

- (::Integer) --- 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

    def service_account_email() -> ::String

**Returns**

- (::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](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

### #service_account_email=

    def service_account_email=(value) -> ::String

**Parameter**

- **value** (::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](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
**Returns**

- (::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](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

### #text_config

    def text_config() -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::TextConfig

**Returns**

- ([::Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::TextConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/latest/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-TextConfig)) --- Optional. If set, message data will be written to Cloud Storage in text format.


  Note: The following fields are mutually exclusive: `text_config`, `avro_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #text_config=

    def text_config=(value) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::TextConfig

**Parameter**

- **value** ([::Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::TextConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/latest/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-TextConfig)) --- Optional. If set, message data will be written to Cloud Storage in text format.


  Note: The following fields are mutually exclusive: `text_config`, `avro_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::TextConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/latest/Google-Cloud-Bigquery-AnalyticsHub-V1-CloudStorageConfig-TextConfig)) --- Optional. If set, message data will be written to Cloud Storage in text format.


  Note: The following fields are mutually exclusive: `text_config`, `avro_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.