Reference documentation and code samples for the Cloud PubSub V1 Client class StreamingPullResponse.
Response for the StreamingPull method. This response is used to stream
messages from the server to the client.
Generated from protobuf message google.pubsub.v1.StreamingPullResponse
Namespace
Google \ Cloud \ PubSub \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ received_messages |
array<ReceivedMessage>
Optional. Received Pub/Sub messages. This will not be empty. |
↳ acknowledge_confirmation |
StreamingPullResponse\AcknowledgeConfirmation
Optional. This field will only be set if |
↳ modify_ack_deadline_confirmation |
StreamingPullResponse\ModifyAckDeadlineConfirmation
Optional. This field will only be set if |
↳ subscription_properties |
StreamingPullResponse\SubscriptionProperties
Optional. Properties associated with this subscription. |
getReceivedMessages
Optional. Received Pub/Sub messages. This will not be empty.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setReceivedMessages
Optional. Received Pub/Sub messages. This will not be empty.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ReceivedMessage>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAcknowledgeConfirmation
Optional. This field will only be set if enable_exactly_once_delivery is
set to true.
| Returns | |
|---|---|
| Type | Description |
StreamingPullResponse\AcknowledgeConfirmation|null |
|
hasAcknowledgeConfirmation
clearAcknowledgeConfirmation
setAcknowledgeConfirmation
Optional. This field will only be set if enable_exactly_once_delivery is
set to true.
| Parameter | |
|---|---|
| Name | Description |
var |
StreamingPullResponse\AcknowledgeConfirmation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getModifyAckDeadlineConfirmation
Optional. This field will only be set if enable_exactly_once_delivery is
set to true.
| Returns | |
|---|---|
| Type | Description |
StreamingPullResponse\ModifyAckDeadlineConfirmation|null |
|
hasModifyAckDeadlineConfirmation
clearModifyAckDeadlineConfirmation
setModifyAckDeadlineConfirmation
Optional. This field will only be set if enable_exactly_once_delivery is
set to true.
| Parameter | |
|---|---|
| Name | Description |
var |
StreamingPullResponse\ModifyAckDeadlineConfirmation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubscriptionProperties
Optional. Properties associated with this subscription.
| Returns | |
|---|---|
| Type | Description |
StreamingPullResponse\SubscriptionProperties|null |
|
hasSubscriptionProperties
clearSubscriptionProperties
setSubscriptionProperties
Optional. Properties associated with this subscription.
| Parameter | |
|---|---|
| Name | Description |
var |
StreamingPullResponse\SubscriptionProperties
|
| Returns | |
|---|---|
| Type | Description |
$this |
|