Cloud PubSub V1 Client - Class PubsubMessage (1.44.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class PubsubMessage.

A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute.

Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See quotas and limits for more information about message limits.

Generated from protobuf message google.pubsub.v1.PubsubMessage

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ data`	`string` The message data field. If this field is empty, the message must contain at least one attribute.
`↳ attributes`	`array\|Google\Protobuf\Internal\MapField` Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.
`↳ message_id`	`string` ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
`↳ publish_time`	`Google\Protobuf\Timestamp` The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
`↳ ordering_key`	`string` If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` must specify the same `ordering_key` value. For more information, see ordering messages.

getData

The message data field. If this field is empty, the message must contain at least one attribute.

Returns
Type	Description
`string`

setData

The message data field. If this field is empty, the message must contain at least one attribute.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAttributes

Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setAttributes

Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getMessageId

ID of this message, assigned by the server when the message is published.

Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by the publisher in a Publish call.

Returns
Type	Description
`string`

setMessageId

ID of this message, assigned by the server when the message is published.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPublishTime

The time at which the message was published, populated by the server when it receives the Publish call. It must not be populated by the publisher in a Publish call.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasPublishTime

clearPublishTime

setPublishTime

The time at which the message was published, populated by the server when it receives the Publish call. It must not be populated by the publisher in a Publish call.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getOrderingKey

If non-empty, identifies related messages for which publish order should be respected. If a Subscription has enable_message_ordering set to true, messages published with the same non-empty ordering_key value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All PubsubMessages published in a given PublishRequest must specify the same ordering_key value.

For more information, see ordering messages.

Returns
Type	Description
`string`

setOrderingKey

For more information, see ordering messages.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`