Cloud PubSub V1 Client - Class StreamingPullResponse (1.40.1)

Version 1.40.1

• 2.8.1 (latest)
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.2
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.2
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.5
• 1.45.2
• 1.44.0
• 1.43.2
• 1.42.1
• 1.41.3
• 1.40.1
• 1.39.3

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ received_messages	array<Google\Cloud\PubSub\V1\ReceivedMessage> Received Pub/Sub messages. This will not be empty.
↳ acknowledge_confirmation	Google\Cloud\PubSub\V1\StreamingPullResponse\AcknowledgeConfirmation This field will only be set if enable_exactly_once_delivery is set to true.
↳ modify_ack_deadline_confirmation	Google\Cloud\PubSub\V1\StreamingPullResponse\ModifyAckDeadlineConfirmation This field will only be set if enable_exactly_once_delivery is set to true.
↳ subscription_properties	Google\Cloud\PubSub\V1\StreamingPullResponse\SubscriptionProperties Properties associated with this subscription.

getReceivedMessages

Received Pub/Sub messages. This will not be empty.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setReceivedMessages

Received Pub/Sub messages. This will not be empty.

Parameter
Name	Description
var	array<Google\Cloud\PubSub\V1\ReceivedMessage>

Returns
Type	Description
$this

getAcknowledgeConfirmation

This field will only be set if enable_exactly_once_delivery is set to true.

Returns
Type	Description
Google\Cloud\PubSub\V1\StreamingPullResponse\AcknowledgeConfirmation|null

hasAcknowledgeConfirmation

clearAcknowledgeConfirmation

setAcknowledgeConfirmation

This field will only be set if enable_exactly_once_delivery is set to true.

Parameter
Name	Description
var	Google\Cloud\PubSub\V1\StreamingPullResponse\AcknowledgeConfirmation

Returns
Type	Description
$this

getModifyAckDeadlineConfirmation

This field will only be set if enable_exactly_once_delivery is set to true.

Returns
Type	Description
Google\Cloud\PubSub\V1\StreamingPullResponse\ModifyAckDeadlineConfirmation|null

hasModifyAckDeadlineConfirmation

clearModifyAckDeadlineConfirmation

setModifyAckDeadlineConfirmation

This field will only be set if enable_exactly_once_delivery is set to true.

Parameter
Name	Description
var	Google\Cloud\PubSub\V1\StreamingPullResponse\ModifyAckDeadlineConfirmation

Returns
Type	Description
$this

getSubscriptionProperties

Properties associated with this subscription.

Returns
Type	Description
Google\Cloud\PubSub\V1\StreamingPullResponse\SubscriptionProperties|null

hasSubscriptionProperties

clearSubscriptionProperties

setSubscriptionProperties

Properties associated with this subscription.

Parameter
Name	Description
var	Google\Cloud\PubSub\V1\StreamingPullResponse\SubscriptionProperties

Returns
Type	Description
$this