Class Message (2.16.6)

Message objects provide a simple interface for users to get message data and acknowledge the message.

Package

@google-cloud/pubsub!

Constructors

(constructor)(sub, { ackId, message, deliveryAttempt })

  constructor 
 ( 
 sub 
 : 
  
 Subscriber 
 , 
  
 { 
  
 ackId 
 , 
  
 message 
 , 
  
 deliveryAttempt 
  
 } 
 : 
  
 google 
 . 
 pubsub 
 . 
 v1 
 . 
 IReceivedMessage 
 ); 
 

Constructs a new instance of the Message class

Parameters
Name Description
sub Subscriber

The parent subscriber.

{ ackId, message, deliveryAttempt } google.pubsub.v1.IReceivedMessage

Properties

ackId

  ackId 
 : 
  
 string 
 ; 
 
Property Value
Type Description
string

attributes

  attributes 
 : 
  
 { 
  
 [ 
 key 
 : 
  
 string 
 ] 
 : 
  
 string 
 ; 
  
 }; 
 
Property Value
Type Description
{ [key: string]: string; }

data

  data 
 : 
  
 Buffer 
 ; 
 
Property Value
Type Description
Buffer

deliveryAttempt

  deliveryAttempt 
 : 
  
 number 
 ; 
 
Property Value
Type Description
number

id

  id 
 : 
  
 string 
 ; 
 
Property Value
Type Description
string

length

  get 
  
 length 
 () 
 : 
  
 number 
 ; 
 

The length of the message data.

{number}

Property Value
Type Description
number

orderingKey

  orderingKey 
 ?: 
  
 string 
 ; 
 
Property Value
Type Description
string

publishTime

  publishTime 
 : 
  
 PreciseDate 
 ; 
 
Property Value
Type Description
PreciseDate

received

  received 
 : 
  
 number 
 ; 
 
Property Value
Type Description
number

Methods

ack()

  ack 
 () 
 : 
  
 void 
 ; 
 

Acknowledges the message.

Returns
Type Description
void

modAck(deadline)

  modAck 
 ( 
 deadline 
 : 
  
 number 
 ) 
 : 
  
 void 
 ; 
 

Modifies the ack deadline.

Parameter
Name Description
deadline number

The number of seconds to extend the deadline.

Returns
Type Description
void

nack()

  nack 
 () 
 : 
  
 void 
 ; 
 

Removes the message from our inventory and schedules it to be redelivered.

Returns
Type Description
void
Design a Mobile Site
View Site in Mobile | Classic
Share by: