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 and is not guaranteed to be populated.

Returns:



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1960

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

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

  # Acknowledgment 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 acknowledgment IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgment IDs that were malformed or whose
  #     acknowledgment deadline has expired.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgment 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 and is not guaranteed to be populated.

Returns:



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1960

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

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

  # Acknowledgment 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 acknowledgment IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgment IDs that were malformed or whose
  #     acknowledgment deadline has expired.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgment 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.

Returns:



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1960

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

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

  # Acknowledgment 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 acknowledgment IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgment IDs that were malformed or whose
  #     acknowledgment deadline has expired.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgment 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:



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1960

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

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

  # Acknowledgment 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 acknowledgment IDs.
  # @!attribute [rw] invalid_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgment IDs that were malformed or whose
  #     acknowledgment deadline has expired.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     Optional. List of acknowledgment 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