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:



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1464

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:



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1464

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:



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1464

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:



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1464

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