Class: Google::Cloud::PubSub::V1::CloudStorageConfig

Inherits:

Object

• Object
• Google::Cloud::PubSub::V1::CloudStorageConfig

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/pubsub/v1/pubsub.rb

Overview

Configuration for a Cloud Storage subscription.

Defined Under Namespace

Modules: State Classes: AvroConfig, TextConfig

Instance Attribute Summary

• #avro_config ⇒ ::Google::Cloud::PubSub::V1::CloudStorageConfig::AvroConfig

  Optional.

• #bucket ⇒ ::String

  Required.

• #filename_datetime_format ⇒ ::String

  Optional.

• #filename_prefix ⇒ ::String

  Optional.

• #filename_suffix ⇒ ::String

  Optional.

• #max_bytes ⇒ ::Integer

  Optional.

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

  Optional.

• #max_messages ⇒ ::Integer

  Optional.

• #service_account_email ⇒ ::String

  Optional.

• #state ⇒ ::Google::Cloud::PubSub::V1::CloudStorageConfig::State readonly

  Output only.

• #text_config ⇒ ::Google::Cloud::PubSub::V1::CloudStorageConfig::TextConfig

  Optional.

Instance Attribute Details

#avro_config ⇒ ::Google::Cloud::PubSub::V1::CloudStorageConfig::AvroConfig

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1616

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

  # Possible states for a Cloud Storage subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to Cloud Storage.
    ACTIVE = 1

    # Cannot write to the Cloud Storage bucket because of permission denied
    # errors.
    PERMISSION_DENIED = 2

    # Cannot write to the Cloud Storage bucket because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the destination because enforce_in_transit is set to true
    # and the destination locations are not in the allowed regions.
    IN_TRANSIT_LOCATION_RESTRICTION = 4

    # Cannot write to the Cloud Storage bucket due to an incompatibility
    # between the topic schema and subscription settings.
    SCHEMA_MISMATCH = 5
  end
end

#bucket ⇒ ::String

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1616

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

  # Possible states for a Cloud Storage subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to Cloud Storage.
    ACTIVE = 1

    # Cannot write to the Cloud Storage bucket because of permission denied
    # errors.
    PERMISSION_DENIED = 2

    # Cannot write to the Cloud Storage bucket because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the destination because enforce_in_transit is set to true
    # and the destination locations are not in the allowed regions.
    IN_TRANSIT_LOCATION_RESTRICTION = 4

    # Cannot write to the Cloud Storage bucket due to an incompatibility
    # between the topic schema and subscription settings.
    SCHEMA_MISMATCH = 5
  end
end

#filename_datetime_format ⇒ ::String

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1616

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

  # Possible states for a Cloud Storage subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to Cloud Storage.
    ACTIVE = 1

    # Cannot write to the Cloud Storage bucket because of permission denied
    # errors.
    PERMISSION_DENIED = 2

    # Cannot write to the Cloud Storage bucket because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the destination because enforce_in_transit is set to true
    # and the destination locations are not in the allowed regions.
    IN_TRANSIT_LOCATION_RESTRICTION = 4

    # Cannot write to the Cloud Storage bucket due to an incompatibility
    # between the topic schema and subscription settings.
    SCHEMA_MISMATCH = 5
  end
end

#filename_prefix ⇒ ::String

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1616

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

  # Possible states for a Cloud Storage subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to Cloud Storage.
    ACTIVE = 1

    # Cannot write to the Cloud Storage bucket because of permission denied
    # errors.
    PERMISSION_DENIED = 2

    # Cannot write to the Cloud Storage bucket because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the destination because enforce_in_transit is set to true
    # and the destination locations are not in the allowed regions.
    IN_TRANSIT_LOCATION_RESTRICTION = 4

    # Cannot write to the Cloud Storage bucket due to an incompatibility
    # between the topic schema and subscription settings.
    SCHEMA_MISMATCH = 5
  end
end

#filename_suffix ⇒ ::String

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1616

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

  # Possible states for a Cloud Storage subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to Cloud Storage.
    ACTIVE = 1

    # Cannot write to the Cloud Storage bucket because of permission denied
    # errors.
    PERMISSION_DENIED = 2

    # Cannot write to the Cloud Storage bucket because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the destination because enforce_in_transit is set to true
    # and the destination locations are not in the allowed regions.
    IN_TRANSIT_LOCATION_RESTRICTION = 4

    # Cannot write to the Cloud Storage bucket due to an incompatibility
    # between the topic schema and subscription settings.
    SCHEMA_MISMATCH = 5
  end
end

#max_bytes ⇒ ::Integer

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1616

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

  # Possible states for a Cloud Storage subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to Cloud Storage.
    ACTIVE = 1

    # Cannot write to the Cloud Storage bucket because of permission denied
    # errors.
    PERMISSION_DENIED = 2

    # Cannot write to the Cloud Storage bucket because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the destination because enforce_in_transit is set to true
    # and the destination locations are not in the allowed regions.
    IN_TRANSIT_LOCATION_RESTRICTION = 4

    # Cannot write to the Cloud Storage bucket due to an incompatibility
    # between the topic schema and subscription settings.
    SCHEMA_MISMATCH = 5
  end
end

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

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1616

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

  # Possible states for a Cloud Storage subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to Cloud Storage.
    ACTIVE = 1

    # Cannot write to the Cloud Storage bucket because of permission denied
    # errors.
    PERMISSION_DENIED = 2

    # Cannot write to the Cloud Storage bucket because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the destination because enforce_in_transit is set to true
    # and the destination locations are not in the allowed regions.
    IN_TRANSIT_LOCATION_RESTRICTION = 4

    # Cannot write to the Cloud Storage bucket due to an incompatibility
    # between the topic schema and subscription settings.
    SCHEMA_MISMATCH = 5
  end
end

#max_messages ⇒ ::Integer

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1616

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

  # Possible states for a Cloud Storage subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to Cloud Storage.
    ACTIVE = 1

    # Cannot write to the Cloud Storage bucket because of permission denied
    # errors.
    PERMISSION_DENIED = 2

    # Cannot write to the Cloud Storage bucket because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the destination because enforce_in_transit is set to true
    # and the destination locations are not in the allowed regions.
    IN_TRANSIT_LOCATION_RESTRICTION = 4

    # Cannot write to the Cloud Storage bucket due to an incompatibility
    # between the topic schema and subscription settings.
    SCHEMA_MISMATCH = 5
  end
end

#service_account_email ⇒ ::String

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1616

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

  # Possible states for a Cloud Storage subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to Cloud Storage.
    ACTIVE = 1

    # Cannot write to the Cloud Storage bucket because of permission denied
    # errors.
    PERMISSION_DENIED = 2

    # Cannot write to the Cloud Storage bucket because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the destination because enforce_in_transit is set to true
    # and the destination locations are not in the allowed regions.
    IN_TRANSIT_LOCATION_RESTRICTION = 4

    # Cannot write to the Cloud Storage bucket due to an incompatibility
    # between the topic schema and subscription settings.
    SCHEMA_MISMATCH = 5
  end
end

#state ⇒ ::Google::Cloud::PubSub::V1::CloudStorageConfig::State (readonly)

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1616

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

  # Possible states for a Cloud Storage subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to Cloud Storage.
    ACTIVE = 1

    # Cannot write to the Cloud Storage bucket because of permission denied
    # errors.
    PERMISSION_DENIED = 2

    # Cannot write to the Cloud Storage bucket because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the destination because enforce_in_transit is set to true
    # and the destination locations are not in the allowed regions.
    IN_TRANSIT_LOCATION_RESTRICTION = 4

    # Cannot write to the Cloud Storage bucket due to an incompatibility
    # between the topic schema and subscription settings.
    SCHEMA_MISMATCH = 5
  end
end

#text_config ⇒ ::Google::Cloud::PubSub::V1::CloudStorageConfig::TextConfig

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1616

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

  # Possible states for a Cloud Storage subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to Cloud Storage.
    ACTIVE = 1

    # Cannot write to the Cloud Storage bucket because of permission denied
    # errors.
    PERMISSION_DENIED = 2

    # Cannot write to the Cloud Storage bucket because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the destination because enforce_in_transit is set to true
    # and the destination locations are not in the allowed regions.
    IN_TRANSIT_LOCATION_RESTRICTION = 4

    # Cannot write to the Cloud Storage bucket due to an incompatibility
    # between the topic schema and subscription settings.
    SCHEMA_MISMATCH = 5
  end
end