Cloud PubSub V1 Client - Class StreamingPullResponse (2.5.2)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ received_messages array<Google\Cloud\PubSub\V1\ReceivedMessage>

Optional. Received Pub/Sub messages. This will not be empty.
↳ acknowledge_confirmation Google\Cloud\PubSub\V1\StreamingPullResponse\AcknowledgeConfirmation

Optional. 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

Optional. This field will only be set if enable_exactly_once_delivery is set to true.
↳ subscription_properties Google\Cloud\PubSub\V1\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<Google\Cloud\PubSub\V1\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
Google\Cloud\PubSub\V1\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 Google\Cloud\PubSub\V1\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
Google\Cloud\PubSub\V1\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 Google\Cloud\PubSub\V1\StreamingPullResponse\ModifyAckDeadlineConfirmation
Returns
Type Description
$this

getSubscriptionProperties

Optional. Properties associated with this subscription.

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

hasSubscriptionProperties

clearSubscriptionProperties

setSubscriptionProperties

Optional. Properties associated with this subscription.

Parameter
Name Description
var Google\Cloud\PubSub\V1\StreamingPullResponse\SubscriptionProperties
Returns
Type Description
$this