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 This field will only be set if enable_exactly_once_delivery is set to true.

Returns:



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
935
936
937
938
939
940
941
942
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 896

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>]
  #     Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were malformed or whose acknowledgement
  #     deadline has expired.
  # @!attribute [rw] unordered_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were out of order.
  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>]
  #     Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were malformed or whose acknowledgement
  #     deadline has expired.
  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]
  #     True iff exactly once delivery is enabled for this subscription.
  # @!attribute [rw] message_ordering_enabled
  #   @return [::Boolean]
  #     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 This field will only be set if enable_exactly_once_delivery is set to true.

Returns:



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
935
936
937
938
939
940
941
942
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 896

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>]
  #     Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were malformed or whose acknowledgement
  #     deadline has expired.
  # @!attribute [rw] unordered_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were out of order.
  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>]
  #     Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were malformed or whose acknowledgement
  #     deadline has expired.
  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]
  #     True iff exactly once delivery is enabled for this subscription.
  # @!attribute [rw] message_ordering_enabled
  #   @return [::Boolean]
  #     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 Received Pub/Sub messages. This will not be empty.

Returns:



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
935
936
937
938
939
940
941
942
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 896

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>]
  #     Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were malformed or whose acknowledgement
  #     deadline has expired.
  # @!attribute [rw] unordered_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were out of order.
  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>]
  #     Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were malformed or whose acknowledgement
  #     deadline has expired.
  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]
  #     True iff exactly once delivery is enabled for this subscription.
  # @!attribute [rw] message_ordering_enabled
  #   @return [::Boolean]
  #     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 Properties associated with this subscription.

Returns:



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
935
936
937
938
939
940
941
942
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 896

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>]
  #     Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were malformed or whose acknowledgement
  #     deadline has expired.
  # @!attribute [rw] unordered_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were out of order.
  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>]
  #     Successfully processed acknowledgement IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     List of acknowledgement IDs that were malformed or whose acknowledgement
  #     deadline has expired.
  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]
  #     True iff exactly once delivery is enabled for this subscription.
  # @!attribute [rw] message_ordering_enabled
  #   @return [::Boolean]
  #     True iff message ordering is enabled for this subscription.
  class SubscriptionProperties
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end