Protocol Documentation

Table of Contents

delay_queue.proto

Top

[gRPC Service] DelayQueue

DelayQueue is a special kind of message queue, which lets you postpone the delivery of new messages to consumers.

Method NameRequest TypeResponse TypeDescription
PublishDelayMessage DelayMessageRequest DelayMessageResponse

Publish a delay message

DelayMessageRequest

DelayMessageRequest is the message to publish

FieldTypeLabelDescription
component_name string

Required. The name of the DelayQueue component

topic string

Required. The pubsub topic

data bytes

Required. The data which will be published to topic.

data_content_type string

The content type for the data (optional).

delay_in_seconds int32

The length of time, in seconds, for which the delivery of this messages is delayed. Default: 0.

metadata DelayMessageRequest.MetadataEntry repeated

The metadata passing to pub components metadata property: - key : the key of the message.

DelayMessageRequest.MetadataEntry

FieldTypeLabelDescription
key string

value string

DelayMessageResponse

DelayMessageResponse is the response

FieldTypeLabelDescription
message_id string

The message identifier

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)