Class: Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/bigquery/analyticshub/v1/pubsub.rb

Overview

Configuration for a Cloud Storage subscription.

Defined Under Namespace

Classes: AvroConfig, TextConfig

Instance Attribute Summary collapse

Instance Attribute Details

#avro_config ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::AvroConfig

Returns 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:



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/pubsub.rb', line 447

class CloudStorageConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for writing message data in text format.
  # Message payloads will be written to files as raw text, separated by a
  # newline.
  class TextConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for writing message data in Avro format.
  # Message payloads and metadata will be written to files as an Avro binary.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, write the subscription name, message_id,
  #     publish_time, attributes, and ordering_key as additional fields in the
  #     output. The subscription name, message_id, and publish_time fields are
  #     put in their own fields while all other message properties other than
  #     data (for example, an ordering_key, if present) are added as entries in
  #     the attributes map.
  # @!attribute [rw] use_topic_schema
  #   @return [::Boolean]
  #     Optional. When true, the output Cloud Storage file will be serialized
  #     using the topic schema, if it exists.
  class AvroConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#bucket ⇒ ::String

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



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/pubsub.rb', line 447

class CloudStorageConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for writing message data in text format.
  # Message payloads will be written to files as raw text, separated by a
  # newline.
  class TextConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for writing message data in Avro format.
  # Message payloads and metadata will be written to files as an Avro binary.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, write the subscription name, message_id,
  #     publish_time, attributes, and ordering_key as additional fields in the
  #     output. The subscription name, message_id, and publish_time fields are
  #     put in their own fields while all other message properties other than
  #     data (for example, an ordering_key, if present) are added as entries in
  #     the attributes map.
  # @!attribute [rw] use_topic_schema
  #   @return [::Boolean]
  #     Optional. When true, the output Cloud Storage file will be serialized
  #     using the topic schema, if it exists.
  class AvroConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#filename_datetime_format ⇒ ::String

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



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/pubsub.rb', line 447

class CloudStorageConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for writing message data in text format.
  # Message payloads will be written to files as raw text, separated by a
  # newline.
  class TextConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for writing message data in Avro format.
  # Message payloads and metadata will be written to files as an Avro binary.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, write the subscription name, message_id,
  #     publish_time, attributes, and ordering_key as additional fields in the
  #     output. The subscription name, message_id, and publish_time fields are
  #     put in their own fields while all other message properties other than
  #     data (for example, an ordering_key, if present) are added as entries in
  #     the attributes map.
  # @!attribute [rw] use_topic_schema
  #   @return [::Boolean]
  #     Optional. When true, the output Cloud Storage file will be serialized
  #     using the topic schema, if it exists.
  class AvroConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#filename_prefix ⇒ ::String

Returns Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.

Returns:



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/pubsub.rb', line 447

class CloudStorageConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for writing message data in text format.
  # Message payloads will be written to files as raw text, separated by a
  # newline.
  class TextConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for writing message data in Avro format.
  # Message payloads and metadata will be written to files as an Avro binary.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, write the subscription name, message_id,
  #     publish_time, attributes, and ordering_key as additional fields in the
  #     output. The subscription name, message_id, and publish_time fields are
  #     put in their own fields while all other message properties other than
  #     data (for example, an ordering_key, if present) are added as entries in
  #     the attributes map.
  # @!attribute [rw] use_topic_schema
  #   @return [::Boolean]
  #     Optional. When true, the output Cloud Storage file will be serialized
  #     using the topic schema, if it exists.
  class AvroConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#filename_suffix ⇒ ::String

Returns 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 "/".



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/pubsub.rb', line 447

class CloudStorageConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for writing message data in text format.
  # Message payloads will be written to files as raw text, separated by a
  # newline.
  class TextConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for writing message data in Avro format.
  # Message payloads and metadata will be written to files as an Avro binary.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, write the subscription name, message_id,
  #     publish_time, attributes, and ordering_key as additional fields in the
  #     output. The subscription name, message_id, and publish_time fields are
  #     put in their own fields while all other message properties other than
  #     data (for example, an ordering_key, if present) are added as entries in
  #     the attributes map.
  # @!attribute [rw] use_topic_schema
  #   @return [::Boolean]
  #     Optional. When true, the output Cloud Storage file will be serialized
  #     using the topic schema, if it exists.
  class AvroConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#max_bytes ⇒ ::Integer

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



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/pubsub.rb', line 447

class CloudStorageConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for writing message data in text format.
  # Message payloads will be written to files as raw text, separated by a
  # newline.
  class TextConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for writing message data in Avro format.
  # Message payloads and metadata will be written to files as an Avro binary.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, write the subscription name, message_id,
  #     publish_time, attributes, and ordering_key as additional fields in the
  #     output. The subscription name, message_id, and publish_time fields are
  #     put in their own fields while all other message properties other than
  #     data (for example, an ordering_key, if present) are added as entries in
  #     the attributes map.
  # @!attribute [rw] use_topic_schema
  #   @return [::Boolean]
  #     Optional. When true, the output Cloud Storage file will be serialized
  #     using the topic schema, if it exists.
  class AvroConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#max_duration ⇒ ::Google::Protobuf::Duration

Returns 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) —

    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.



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/pubsub.rb', line 447

class CloudStorageConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for writing message data in text format.
  # Message payloads will be written to files as raw text, separated by a
  # newline.
  class TextConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for writing message data in Avro format.
  # Message payloads and metadata will be written to files as an Avro binary.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, write the subscription name, message_id,
  #     publish_time, attributes, and ordering_key as additional fields in the
  #     output. The subscription name, message_id, and publish_time fields are
  #     put in their own fields while all other message properties other than
  #     data (for example, an ordering_key, if present) are added as entries in
  #     the attributes map.
  # @!attribute [rw] use_topic_schema
  #   @return [::Boolean]
  #     Optional. When true, the output Cloud Storage file will be serialized
  #     using the topic schema, if it exists.
  class AvroConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#max_messages ⇒ ::Integer

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



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/pubsub.rb', line 447

class CloudStorageConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for writing message data in text format.
  # Message payloads will be written to files as raw text, separated by a
  # newline.
  class TextConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for writing message data in Avro format.
  # Message payloads and metadata will be written to files as an Avro binary.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, write the subscription name, message_id,
  #     publish_time, attributes, and ordering_key as additional fields in the
  #     output. The subscription name, message_id, and publish_time fields are
  #     put in their own fields while all other message properties other than
  #     data (for example, an ordering_key, if present) are added as entries in
  #     the attributes map.
  # @!attribute [rw] use_topic_schema
  #   @return [::Boolean]
  #     Optional. When true, the output Cloud Storage file will be serialized
  #     using the topic schema, if it exists.
  class AvroConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_account_email ⇒ ::String

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



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/pubsub.rb', line 447

class CloudStorageConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for writing message data in text format.
  # Message payloads will be written to files as raw text, separated by a
  # newline.
  class TextConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for writing message data in Avro format.
  # Message payloads and metadata will be written to files as an Avro binary.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, write the subscription name, message_id,
  #     publish_time, attributes, and ordering_key as additional fields in the
  #     output. The subscription name, message_id, and publish_time fields are
  #     put in their own fields while all other message properties other than
  #     data (for example, an ordering_key, if present) are added as entries in
  #     the attributes map.
  # @!attribute [rw] use_topic_schema
  #   @return [::Boolean]
  #     Optional. When true, the output Cloud Storage file will be serialized
  #     using the topic schema, if it exists.
  class AvroConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#text_config ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::CloudStorageConfig::TextConfig

Returns 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:



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/pubsub.rb', line 447

class CloudStorageConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for writing message data in text format.
  # Message payloads will be written to files as raw text, separated by a
  # newline.
  class TextConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for writing message data in Avro format.
  # Message payloads and metadata will be written to files as an Avro binary.
  # @!attribute [rw] write_metadata
  #   @return [::Boolean]
  #     Optional. When true, write the subscription name, message_id,
  #     publish_time, attributes, and ordering_key as additional fields in the
  #     output. The subscription name, message_id, and publish_time fields are
  #     put in their own fields while all other message properties other than
  #     data (for example, an ordering_key, if present) are added as entries in
  #     the attributes map.
  # @!attribute [rw] use_topic_schema
  #   @return [::Boolean]
  #     Optional. When true, the output Cloud Storage file will be serialized
  #     using the topic schema, if it exists.
  class AvroConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end