/
ReadSessionOrBuilder.java
422 lines (409 loc) · 12.1 KB
/
ReadSessionOrBuilder.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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
/*
* 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/cloud/bigquery/storage/v1/stream.proto
package com.google.cloud.bigquery.storage.v1;
public interface ReadSessionOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.bigquery.storage.v1.ReadSession)
com.google.protobuf.MessageOrBuilder {
/**
*
*
* <pre>
* Output only. Unique identifier for the session, in the form
* `projects/{project_id}/locations/{location}/sessions/{session_id}`.
* </pre>
*
* <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
* <pre>
* Output only. Unique identifier for the session, in the form
* `projects/{project_id}/locations/{location}/sessions/{session_id}`.
* </pre>
*
* <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
* <pre>
* Output only. Time at which the session becomes invalid. After this time, subsequent
* requests to read this Session will return errors. The expire_time is
* automatically assigned and currently cannot be specified or updated.
* </pre>
*
* <code>.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return Whether the expireTime field is set.
*/
boolean hasExpireTime();
/**
*
*
* <pre>
* Output only. Time at which the session becomes invalid. After this time, subsequent
* requests to read this Session will return errors. The expire_time is
* automatically assigned and currently cannot be specified or updated.
* </pre>
*
* <code>.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return The expireTime.
*/
com.google.protobuf.Timestamp getExpireTime();
/**
*
*
* <pre>
* Output only. Time at which the session becomes invalid. After this time, subsequent
* requests to read this Session will return errors. The expire_time is
* automatically assigned and currently cannot be specified or updated.
* </pre>
*
* <code>.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*/
com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder();
/**
*
*
* <pre>
* Immutable. Data format of the output data.
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];
* </code>
*
* @return The enum numeric value on the wire for dataFormat.
*/
int getDataFormatValue();
/**
*
*
* <pre>
* Immutable. Data format of the output data.
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];
* </code>
*
* @return The dataFormat.
*/
com.google.cloud.bigquery.storage.v1.DataFormat getDataFormat();
/**
*
*
* <pre>
* Output only. Avro schema.
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return Whether the avroSchema field is set.
*/
boolean hasAvroSchema();
/**
*
*
* <pre>
* Output only. Avro schema.
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return The avroSchema.
*/
com.google.cloud.bigquery.storage.v1.AvroSchema getAvroSchema();
/**
*
*
* <pre>
* Output only. Avro schema.
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*/
com.google.cloud.bigquery.storage.v1.AvroSchemaOrBuilder getAvroSchemaOrBuilder();
/**
*
*
* <pre>
* Output only. Arrow schema.
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return Whether the arrowSchema field is set.
*/
boolean hasArrowSchema();
/**
*
*
* <pre>
* Output only. Arrow schema.
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return The arrowSchema.
*/
com.google.cloud.bigquery.storage.v1.ArrowSchema getArrowSchema();
/**
*
*
* <pre>
* Output only. Arrow schema.
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*/
com.google.cloud.bigquery.storage.v1.ArrowSchemaOrBuilder getArrowSchemaOrBuilder();
/**
*
*
* <pre>
* Immutable. Table that this ReadSession is reading from, in the form
* `projects/{project_id}/datasets/{dataset_id}/tables/{table_id}`
* </pre>
*
* <code>
* string table = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
* </code>
*
* @return The table.
*/
java.lang.String getTable();
/**
*
*
* <pre>
* Immutable. Table that this ReadSession is reading from, in the form
* `projects/{project_id}/datasets/{dataset_id}/tables/{table_id}`
* </pre>
*
* <code>
* string table = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
* </code>
*
* @return The bytes for table.
*/
com.google.protobuf.ByteString getTableBytes();
/**
*
*
* <pre>
* Optional. Any modifiers which are applied when reading from the specified table.
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];
* </code>
*
* @return Whether the tableModifiers field is set.
*/
boolean hasTableModifiers();
/**
*
*
* <pre>
* Optional. Any modifiers which are applied when reading from the specified table.
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];
* </code>
*
* @return The tableModifiers.
*/
com.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers getTableModifiers();
/**
*
*
* <pre>
* Optional. Any modifiers which are applied when reading from the specified table.
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];
* </code>
*/
com.google.cloud.bigquery.storage.v1.ReadSession.TableModifiersOrBuilder
getTableModifiersOrBuilder();
/**
*
*
* <pre>
* Optional. Read options for this session (e.g. column selection, filters).
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];
* </code>
*
* @return Whether the readOptions field is set.
*/
boolean hasReadOptions();
/**
*
*
* <pre>
* Optional. Read options for this session (e.g. column selection, filters).
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];
* </code>
*
* @return The readOptions.
*/
com.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions getReadOptions();
/**
*
*
* <pre>
* Optional. Read options for this session (e.g. column selection, filters).
* </pre>
*
* <code>
* .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];
* </code>
*/
com.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptionsOrBuilder
getReadOptionsOrBuilder();
/**
*
*
* <pre>
* Output only. A list of streams created with the session.
* At least one stream is created with the session. In the future, larger
* request_stream_count values *may* result in this list being unpopulated,
* in that case, the user will need to use a List method to get the streams
* instead, which is not yet available.
* </pre>
*
* <code>
* repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*/
java.util.List<com.google.cloud.bigquery.storage.v1.ReadStream> getStreamsList();
/**
*
*
* <pre>
* Output only. A list of streams created with the session.
* At least one stream is created with the session. In the future, larger
* request_stream_count values *may* result in this list being unpopulated,
* in that case, the user will need to use a List method to get the streams
* instead, which is not yet available.
* </pre>
*
* <code>
* repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*/
com.google.cloud.bigquery.storage.v1.ReadStream getStreams(int index);
/**
*
*
* <pre>
* Output only. A list of streams created with the session.
* At least one stream is created with the session. In the future, larger
* request_stream_count values *may* result in this list being unpopulated,
* in that case, the user will need to use a List method to get the streams
* instead, which is not yet available.
* </pre>
*
* <code>
* repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*/
int getStreamsCount();
/**
*
*
* <pre>
* Output only. A list of streams created with the session.
* At least one stream is created with the session. In the future, larger
* request_stream_count values *may* result in this list being unpopulated,
* in that case, the user will need to use a List method to get the streams
* instead, which is not yet available.
* </pre>
*
* <code>
* repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*/
java.util.List<? extends com.google.cloud.bigquery.storage.v1.ReadStreamOrBuilder>
getStreamsOrBuilderList();
/**
*
*
* <pre>
* Output only. A list of streams created with the session.
* At least one stream is created with the session. In the future, larger
* request_stream_count values *may* result in this list being unpopulated,
* in that case, the user will need to use a List method to get the streams
* instead, which is not yet available.
* </pre>
*
* <code>
* repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*/
com.google.cloud.bigquery.storage.v1.ReadStreamOrBuilder getStreamsOrBuilder(int index);
/**
*
*
* <pre>
* Output only. An estimate on the number of bytes this session will scan when
* all streams are completely consumed. This estimate is based on
* metadata from the table which might be incomplete or stale.
* </pre>
*
* <code>int64 estimated_total_bytes_scanned = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return The estimatedTotalBytesScanned.
*/
long getEstimatedTotalBytesScanned();
public com.google.cloud.bigquery.storage.v1.ReadSession.SchemaCase getSchemaCase();
}