Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::CloudStorageConfig (v1.5.0)

Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::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::PubSub::V1::CloudStorageConfig::AvroConfig
Returns

#avro_config=

def avro_config=(value) -> ::Google::Cloud::PubSub::V1::CloudStorageConfig::AvroConfig
Parameter
Returns

#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.

#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.
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.

#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.

#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.
Returns
  • (::String) — Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.

#filename_prefix

def filename_prefix() -> ::String
Returns

#filename_prefix=

def filename_prefix=(value) -> ::String
Parameter
Returns

#filename_suffix

def filename_suffix() -> ::String
Returns
  • (::String) — Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. 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. Must not end in "/".
Returns
  • (::String) — Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. 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) — 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 acknowledgement deadline.

#max_duration=

def max_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — 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 acknowledgement deadline.
Returns
  • (::Google::Protobuf::Duration) — 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 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, 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, 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, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

#state

def state() -> ::Google::Cloud::PubSub::V1::CloudStorageConfig::State
Returns

#text_config

def text_config() -> ::Google::Cloud::PubSub::V1::CloudStorageConfig::TextConfig
Returns

#text_config=

def text_config=(value) -> ::Google::Cloud::PubSub::V1::CloudStorageConfig::TextConfig
Parameter
Returns