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:



1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1107

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.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     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>]
  #     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] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     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]
  #     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:



1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1107

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.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     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>]
  #     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] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     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]
  #     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:



1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1107

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.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     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>]
  #     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] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     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]
  #     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:



1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1107

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.
  # @!attribute [rw] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     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>]
  #     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] temporary_failed_ack_ids
  #   @return [::Array<::String>]
  #     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]
  #     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