/
PubsubMessageOrBuilder.java
216 lines (209 loc) · 6.68 KB
/
PubsubMessageOrBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/pubsub/v1/pubsub.proto
package com.google.pubsub.v1;
public interface PubsubMessageOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.pubsub.v1.PubsubMessage)
com.google.protobuf.MessageOrBuilder {
/**
*
*
* <pre>
* The message data field. If this field is empty, the message must contain
* at least one attribute.
* </pre>
*
* <code>bytes data = 1;</code>
*
* @return The data.
*/
com.google.protobuf.ByteString getData();
/**
*
*
* <pre>
* 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.
* </pre>
*
* <code>map<string, string> attributes = 2;</code>
*/
int getAttributesCount();
/**
*
*
* <pre>
* 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.
* </pre>
*
* <code>map<string, string> attributes = 2;</code>
*/
boolean containsAttributes(java.lang.String key);
/** Use {@link #getAttributesMap()} instead. */
@java.lang.Deprecated
java.util.Map<java.lang.String, java.lang.String> getAttributes();
/**
*
*
* <pre>
* 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.
* </pre>
*
* <code>map<string, string> attributes = 2;</code>
*/
java.util.Map<java.lang.String, java.lang.String> getAttributesMap();
/**
*
*
* <pre>
* 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.
* </pre>
*
* <code>map<string, string> attributes = 2;</code>
*/
java.lang.String getAttributesOrDefault(java.lang.String key, java.lang.String defaultValue);
/**
*
*
* <pre>
* 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.
* </pre>
*
* <code>map<string, string> attributes = 2;</code>
*/
java.lang.String getAttributesOrThrow(java.lang.String key);
/**
*
*
* <pre>
* 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.
* </pre>
*
* <code>string message_id = 3;</code>
*
* @return The messageId.
*/
java.lang.String getMessageId();
/**
*
*
* <pre>
* 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.
* </pre>
*
* <code>string message_id = 3;</code>
*
* @return The bytes for messageId.
*/
com.google.protobuf.ByteString getMessageIdBytes();
/**
*
*
* <pre>
* 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.
* </pre>
*
* <code>.google.protobuf.Timestamp publish_time = 4;</code>
*
* @return Whether the publishTime field is set.
*/
boolean hasPublishTime();
/**
*
*
* <pre>
* 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.
* </pre>
*
* <code>.google.protobuf.Timestamp publish_time = 4;</code>
*
* @return The publishTime.
*/
com.google.protobuf.Timestamp getPublishTime();
/**
*
*
* <pre>
* 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.
* </pre>
*
* <code>.google.protobuf.Timestamp publish_time = 4;</code>
*/
com.google.protobuf.TimestampOrBuilder getPublishTimeOrBuilder();
/**
*
*
* <pre>
* 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.
* <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
* API might be changed in backward-incompatible ways and is not recommended
* for production use. It is not subject to any SLA or deprecation policy.
* </pre>
*
* <code>string ordering_key = 5;</code>
*
* @return The orderingKey.
*/
java.lang.String getOrderingKey();
/**
*
*
* <pre>
* 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.
* <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
* API might be changed in backward-incompatible ways and is not recommended
* for production use. It is not subject to any SLA or deprecation policy.
* </pre>
*
* <code>string ordering_key = 5;</code>
*
* @return The bytes for orderingKey.
*/
com.google.protobuf.ByteString getOrderingKeyBytes();
}