Class: Google::Cloud::PubSub::V1::StreamingPullResponse

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

Overview

Response for the StreamingPull method. This response is used to stream messages from the server to the client.

Defined Under Namespace

Classes: AcknowledgeConfirmation, ModifyAckDeadlineConfirmation, SubscriptionProperties

Instance Attribute Summary collapse

Instance Attribute Details

#acknowledge_confirmation ⇒ ::Google::Cloud::PubSub::V1::StreamingPullResponse::AcknowledgeConfirmation

Returns Optional. This field will only be set if enable_exactly_once_delivery is set to true.

Returns:



1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1824

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

  # Acknowledgement IDs sent in one or more previous requests to acknowledge a
  # previously received message.
  # @!attribute [rw] ack_ids
  #   @return [::Array<::String>]
  #     Optional. Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were malformed or whose
  #     acknowledgement deadline has expired.
  # @!attribute [rw] unordered_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were out of order.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that failed processing with
  #     temporary issues.
  class AcknowledgeConfirmation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Acknowledgement IDs sent in one or more previous requests to modify the
  # deadline for a specific message.
  # @!attribute [rw] ack_ids
  #   @return [::Array<::String>]
  #     Optional. Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were malformed or whose
  #     acknowledgement deadline has expired.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that failed processing with
  #     temporary issues.
  class ModifyAckDeadlineConfirmation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Subscription properties sent as part of the response.
  # @!attribute [rw] exactly_once_delivery_enabled
  #   @return [::Boolean]
  #     Optional. True iff exactly once delivery is enabled for this
  #     subscription.
  # @!attribute [rw] message_ordering_enabled
  #   @return [::Boolean]
  #     Optional. True iff message ordering is enabled for this subscription.
  class SubscriptionProperties
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#modify_ack_deadline_confirmation ⇒ ::Google::Cloud::PubSub::V1::StreamingPullResponse::ModifyAckDeadlineConfirmation

Returns Optional. This field will only be set if enable_exactly_once_delivery is set to true.

Returns:



1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1824

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

  # Acknowledgement IDs sent in one or more previous requests to acknowledge a
  # previously received message.
  # @!attribute [rw] ack_ids
  #   @return [::Array<::String>]
  #     Optional. Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were malformed or whose
  #     acknowledgement deadline has expired.
  # @!attribute [rw] unordered_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were out of order.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that failed processing with
  #     temporary issues.
  class AcknowledgeConfirmation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Acknowledgement IDs sent in one or more previous requests to modify the
  # deadline for a specific message.
  # @!attribute [rw] ack_ids
  #   @return [::Array<::String>]
  #     Optional. Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were malformed or whose
  #     acknowledgement deadline has expired.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that failed processing with
  #     temporary issues.
  class ModifyAckDeadlineConfirmation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Subscription properties sent as part of the response.
  # @!attribute [rw] exactly_once_delivery_enabled
  #   @return [::Boolean]
  #     Optional. True iff exactly once delivery is enabled for this
  #     subscription.
  # @!attribute [rw] message_ordering_enabled
  #   @return [::Boolean]
  #     Optional. True iff message ordering is enabled for this subscription.
  class SubscriptionProperties
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#received_messages ⇒ ::Array<::Google::Cloud::PubSub::V1::ReceivedMessage>

Returns Optional. Received Pub/Sub messages. This will not be empty.

Returns:



1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1824

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

  # Acknowledgement IDs sent in one or more previous requests to acknowledge a
  # previously received message.
  # @!attribute [rw] ack_ids
  #   @return [::Array<::String>]
  #     Optional. Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were malformed or whose
  #     acknowledgement deadline has expired.
  # @!attribute [rw] unordered_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were out of order.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that failed processing with
  #     temporary issues.
  class AcknowledgeConfirmation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Acknowledgement IDs sent in one or more previous requests to modify the
  # deadline for a specific message.
  # @!attribute [rw] ack_ids
  #   @return [::Array<::String>]
  #     Optional. Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were malformed or whose
  #     acknowledgement deadline has expired.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that failed processing with
  #     temporary issues.
  class ModifyAckDeadlineConfirmation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Subscription properties sent as part of the response.
  # @!attribute [rw] exactly_once_delivery_enabled
  #   @return [::Boolean]
  #     Optional. True iff exactly once delivery is enabled for this
  #     subscription.
  # @!attribute [rw] message_ordering_enabled
  #   @return [::Boolean]
  #     Optional. True iff message ordering is enabled for this subscription.
  class SubscriptionProperties
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#subscription_properties ⇒ ::Google::Cloud::PubSub::V1::StreamingPullResponse::SubscriptionProperties

Returns Optional. Properties associated with this subscription.

Returns:



1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1824

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

  # Acknowledgement IDs sent in one or more previous requests to acknowledge a
  # previously received message.
  # @!attribute [rw] ack_ids
  #   @return [::Array<::String>]
  #     Optional. Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were malformed or whose
  #     acknowledgement deadline has expired.
  # @!attribute [rw] unordered_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were out of order.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that failed processing with
  #     temporary issues.
  class AcknowledgeConfirmation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Acknowledgement IDs sent in one or more previous requests to modify the
  # deadline for a specific message.
  # @!attribute [rw] ack_ids
  #   @return [::Array<::String>]
  #     Optional. Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that were malformed or whose
  #     acknowledgement deadline has expired.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgement IDs that failed processing with
  #     temporary issues.
  class ModifyAckDeadlineConfirmation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Subscription properties sent as part of the response.
  # @!attribute [rw] exactly_once_delivery_enabled
  #   @return [::Boolean]
  #     Optional. True iff exactly once delivery is enabled for this
  #     subscription.
  # @!attribute [rw] message_ordering_enabled
  #   @return [::Boolean]
  #     Optional. True iff message ordering is enabled for this subscription.
  class SubscriptionProperties
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end