Cloud PubSub V1 Client - Class StreamingPullResponse (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
NameDescription
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.

Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setReceivedMessages

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

Generated from protobuf field repeated .google.pubsub.v1.ReceivedMessage received_messages = 1;

Parameter
NameDescription
var array<Google\Cloud\PubSub\V1\ReceivedMessage>
Returns
TypeDescription
$this

getAcknowledgeConfirmation

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

Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation acknowledge_confirmation = 5;

Returns
TypeDescription
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.

Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation acknowledge_confirmation = 5;

Parameter
NameDescription
var Google\Cloud\PubSub\V1\StreamingPullResponse\AcknowledgeConfirmation
Returns
TypeDescription
$this

getModifyAckDeadlineConfirmation

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

Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3;

Returns
TypeDescription
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.

Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3;

Parameter
NameDescription
var Google\Cloud\PubSub\V1\StreamingPullResponse\ModifyAckDeadlineConfirmation
Returns
TypeDescription
$this

getSubscriptionProperties

Properties associated with this subscription.

Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.SubscriptionProperties subscription_properties = 4;

Returns
TypeDescription
Google\Cloud\PubSub\V1\StreamingPullResponse\SubscriptionProperties|null

hasSubscriptionProperties

clearSubscriptionProperties

setSubscriptionProperties

Properties associated with this subscription.

Generated from protobuf field .google.pubsub.v1.StreamingPullResponse.SubscriptionProperties subscription_properties = 4;

Parameter
NameDescription
var Google\Cloud\PubSub\V1\StreamingPullResponse\SubscriptionProperties
Returns
TypeDescription
$this