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

Inherits:
Object
  • Object
show all
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 collapse

Instance Attribute Details

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

Returns If set, message data will be written to Cloud Storage in Avro format.

Returns:



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 781

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



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 781

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

#filename_prefix ⇒ ::String

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

Returns:



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 781

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

#filename_suffix ⇒ ::String

Returns User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".

Returns:



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 781

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

#max_bytes ⇒ ::Integer

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

    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.



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 781

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

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

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

    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.



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 781

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

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

Returns Output only. An output-only field that indicates whether or not the subscription can receive messages.

Returns:



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 781

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

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

Returns If set, message data will be written to Cloud Storage in text format.

Returns:



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 781

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