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 



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 888

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

#bucket ⇒ ::String 



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 888

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

#filename_prefix ⇒ ::String 



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 888

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

#filename_suffix ⇒ ::String 



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 888

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

#max_bytes ⇒ ::Integer 



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 888

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

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



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 888

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

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



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 888

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

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



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 888

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