This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
/
EntryOrBuilder.java
555 lines (537 loc) · 16.7 KB
/
EntryOrBuilder.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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
/*
* 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/datacatalog/v1/datacatalog.proto
package com.google.cloud.datacatalog.v1;
public interface EntryOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.datacatalog.v1.Entry)
com.google.protobuf.MessageOrBuilder {
/**
*
*
* <pre>
* The Data Catalog resource name of the entry in URL format. Example:
* * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
* Note that this Entry and its child resources may not actually be stored in
* the location in this name.
* </pre>
*
* <code>string name = 1 [(.google.api.resource_reference) = { ... }</code>
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
* <pre>
* The Data Catalog resource name of the entry in URL format. Example:
* * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
* Note that this Entry and its child resources may not actually be stored in
* the location in this name.
* </pre>
*
* <code>string name = 1 [(.google.api.resource_reference) = { ... }</code>
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
* <pre>
* The resource this metadata entry refers to.
* For Google Cloud Platform resources, `linked_resource` is the [full name of
* the
* resource](https://cloud.google.com/apis/design/resource_names#full_resource_name).
* For example, the `linked_resource` for a table resource from BigQuery is:
* * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
* Output only when Entry is of type in the EntryType enum. For entries with
* user_specified_type, this field is optional and defaults to an empty
* string.
* </pre>
*
* <code>string linked_resource = 9;</code>
*
* @return The linkedResource.
*/
java.lang.String getLinkedResource();
/**
*
*
* <pre>
* The resource this metadata entry refers to.
* For Google Cloud Platform resources, `linked_resource` is the [full name of
* the
* resource](https://cloud.google.com/apis/design/resource_names#full_resource_name).
* For example, the `linked_resource` for a table resource from BigQuery is:
* * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
* Output only when Entry is of type in the EntryType enum. For entries with
* user_specified_type, this field is optional and defaults to an empty
* string.
* </pre>
*
* <code>string linked_resource = 9;</code>
*
* @return The bytes for linkedResource.
*/
com.google.protobuf.ByteString getLinkedResourceBytes();
/**
*
*
* <pre>
* The type of the entry.
* Only used for Entries with types in the EntryType enum.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.EntryType type = 2;</code>
*
* @return Whether the type field is set.
*/
boolean hasType();
/**
*
*
* <pre>
* The type of the entry.
* Only used for Entries with types in the EntryType enum.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.EntryType type = 2;</code>
*
* @return The enum numeric value on the wire for type.
*/
int getTypeValue();
/**
*
*
* <pre>
* The type of the entry.
* Only used for Entries with types in the EntryType enum.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.EntryType type = 2;</code>
*
* @return The type.
*/
com.google.cloud.datacatalog.v1.EntryType getType();
/**
*
*
* <pre>
* Entry type if it does not fit any of the input-allowed values listed in
* `EntryType` enum above. When creating an entry, users should check the
* enum values first, if nothing matches the entry to be created, then
* provide a custom value, for example "my_special_type".
* `user_specified_type` strings must begin with a letter or underscore and
* can only contain letters, numbers, and underscores; are case insensitive;
* must be at least 1 character and at most 64 characters long.
* Currently, only FILESET enum value is allowed. All other entries created
* through Data Catalog must use `user_specified_type`.
* </pre>
*
* <code>string user_specified_type = 16;</code>
*
* @return Whether the userSpecifiedType field is set.
*/
boolean hasUserSpecifiedType();
/**
*
*
* <pre>
* Entry type if it does not fit any of the input-allowed values listed in
* `EntryType` enum above. When creating an entry, users should check the
* enum values first, if nothing matches the entry to be created, then
* provide a custom value, for example "my_special_type".
* `user_specified_type` strings must begin with a letter or underscore and
* can only contain letters, numbers, and underscores; are case insensitive;
* must be at least 1 character and at most 64 characters long.
* Currently, only FILESET enum value is allowed. All other entries created
* through Data Catalog must use `user_specified_type`.
* </pre>
*
* <code>string user_specified_type = 16;</code>
*
* @return The userSpecifiedType.
*/
java.lang.String getUserSpecifiedType();
/**
*
*
* <pre>
* Entry type if it does not fit any of the input-allowed values listed in
* `EntryType` enum above. When creating an entry, users should check the
* enum values first, if nothing matches the entry to be created, then
* provide a custom value, for example "my_special_type".
* `user_specified_type` strings must begin with a letter or underscore and
* can only contain letters, numbers, and underscores; are case insensitive;
* must be at least 1 character and at most 64 characters long.
* Currently, only FILESET enum value is allowed. All other entries created
* through Data Catalog must use `user_specified_type`.
* </pre>
*
* <code>string user_specified_type = 16;</code>
*
* @return The bytes for userSpecifiedType.
*/
com.google.protobuf.ByteString getUserSpecifiedTypeBytes();
/**
*
*
* <pre>
* Output only. This field indicates the entry's source system that Data
* Catalog integrates with, such as BigQuery or Pub/Sub.
* </pre>
*
* <code>
* .google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return Whether the integratedSystem field is set.
*/
boolean hasIntegratedSystem();
/**
*
*
* <pre>
* Output only. This field indicates the entry's source system that Data
* Catalog integrates with, such as BigQuery or Pub/Sub.
* </pre>
*
* <code>
* .google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return The enum numeric value on the wire for integratedSystem.
*/
int getIntegratedSystemValue();
/**
*
*
* <pre>
* Output only. This field indicates the entry's source system that Data
* Catalog integrates with, such as BigQuery or Pub/Sub.
* </pre>
*
* <code>
* .google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return The integratedSystem.
*/
com.google.cloud.datacatalog.v1.IntegratedSystem getIntegratedSystem();
/**
*
*
* <pre>
* This field indicates the entry's source system that Data Catalog does not
* integrate with. `user_specified_system` strings must begin with a letter
* or underscore and can only contain letters, numbers, and underscores; are
* case insensitive; must be at least 1 character and at most 64 characters
* long.
* </pre>
*
* <code>string user_specified_system = 18;</code>
*
* @return Whether the userSpecifiedSystem field is set.
*/
boolean hasUserSpecifiedSystem();
/**
*
*
* <pre>
* This field indicates the entry's source system that Data Catalog does not
* integrate with. `user_specified_system` strings must begin with a letter
* or underscore and can only contain letters, numbers, and underscores; are
* case insensitive; must be at least 1 character and at most 64 characters
* long.
* </pre>
*
* <code>string user_specified_system = 18;</code>
*
* @return The userSpecifiedSystem.
*/
java.lang.String getUserSpecifiedSystem();
/**
*
*
* <pre>
* This field indicates the entry's source system that Data Catalog does not
* integrate with. `user_specified_system` strings must begin with a letter
* or underscore and can only contain letters, numbers, and underscores; are
* case insensitive; must be at least 1 character and at most 64 characters
* long.
* </pre>
*
* <code>string user_specified_system = 18;</code>
*
* @return The bytes for userSpecifiedSystem.
*/
com.google.protobuf.ByteString getUserSpecifiedSystemBytes();
/**
*
*
* <pre>
* Specification that applies to a Cloud Storage fileset. This is only valid
* on entries of type FILESET.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;</code>
*
* @return Whether the gcsFilesetSpec field is set.
*/
boolean hasGcsFilesetSpec();
/**
*
*
* <pre>
* Specification that applies to a Cloud Storage fileset. This is only valid
* on entries of type FILESET.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;</code>
*
* @return The gcsFilesetSpec.
*/
com.google.cloud.datacatalog.v1.GcsFilesetSpec getGcsFilesetSpec();
/**
*
*
* <pre>
* Specification that applies to a Cloud Storage fileset. This is only valid
* on entries of type FILESET.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;</code>
*/
com.google.cloud.datacatalog.v1.GcsFilesetSpecOrBuilder getGcsFilesetSpecOrBuilder();
/**
*
*
* <pre>
* Specification that applies to a BigQuery table. This is only valid on
* entries of type `TABLE`.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12;</code>
*
* @return Whether the bigqueryTableSpec field is set.
*/
boolean hasBigqueryTableSpec();
/**
*
*
* <pre>
* Specification that applies to a BigQuery table. This is only valid on
* entries of type `TABLE`.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12;</code>
*
* @return The bigqueryTableSpec.
*/
com.google.cloud.datacatalog.v1.BigQueryTableSpec getBigqueryTableSpec();
/**
*
*
* <pre>
* Specification that applies to a BigQuery table. This is only valid on
* entries of type `TABLE`.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12;</code>
*/
com.google.cloud.datacatalog.v1.BigQueryTableSpecOrBuilder getBigqueryTableSpecOrBuilder();
/**
*
*
* <pre>
* Specification for a group of BigQuery tables with name pattern
* `[prefix]YYYYMMDD`. Context:
* https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
* </code>
*
* @return Whether the bigqueryDateShardedSpec field is set.
*/
boolean hasBigqueryDateShardedSpec();
/**
*
*
* <pre>
* Specification for a group of BigQuery tables with name pattern
* `[prefix]YYYYMMDD`. Context:
* https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
* </code>
*
* @return The bigqueryDateShardedSpec.
*/
com.google.cloud.datacatalog.v1.BigQueryDateShardedSpec getBigqueryDateShardedSpec();
/**
*
*
* <pre>
* Specification for a group of BigQuery tables with name pattern
* `[prefix]YYYYMMDD`. Context:
* https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15;
* </code>
*/
com.google.cloud.datacatalog.v1.BigQueryDateShardedSpecOrBuilder
getBigqueryDateShardedSpecOrBuilder();
/**
*
*
* <pre>
* Display information such as title and description. A short name to identify
* the entry, for example, "Analytics Data - Jan 2011". Default value is an
* empty string.
* </pre>
*
* <code>string display_name = 3;</code>
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
* <pre>
* Display information such as title and description. A short name to identify
* the entry, for example, "Analytics Data - Jan 2011". Default value is an
* empty string.
* </pre>
*
* <code>string display_name = 3;</code>
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
* <pre>
* Entry description, which can consist of several sentences or paragraphs
* that describe entry contents. Default value is an empty string.
* </pre>
*
* <code>string description = 4;</code>
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
* <pre>
* Entry description, which can consist of several sentences or paragraphs
* that describe entry contents. Default value is an empty string.
* </pre>
*
* <code>string description = 4;</code>
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
* <pre>
* Schema of the entry. An entry might not have any schema attached to it.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.Schema schema = 5;</code>
*
* @return Whether the schema field is set.
*/
boolean hasSchema();
/**
*
*
* <pre>
* Schema of the entry. An entry might not have any schema attached to it.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.Schema schema = 5;</code>
*
* @return The schema.
*/
com.google.cloud.datacatalog.v1.Schema getSchema();
/**
*
*
* <pre>
* Schema of the entry. An entry might not have any schema attached to it.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.Schema schema = 5;</code>
*/
com.google.cloud.datacatalog.v1.SchemaOrBuilder getSchemaOrBuilder();
/**
*
*
* <pre>
* Timestamps about the underlying resource, not about this Data Catalog
* entry. Output only when Entry is of type in the EntryType enum. For entries
* with user_specified_type, this field is optional and defaults to an empty
* timestamp.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;</code>
*
* @return Whether the sourceSystemTimestamps field is set.
*/
boolean hasSourceSystemTimestamps();
/**
*
*
* <pre>
* Timestamps about the underlying resource, not about this Data Catalog
* entry. Output only when Entry is of type in the EntryType enum. For entries
* with user_specified_type, this field is optional and defaults to an empty
* timestamp.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;</code>
*
* @return The sourceSystemTimestamps.
*/
com.google.cloud.datacatalog.v1.SystemTimestamps getSourceSystemTimestamps();
/**
*
*
* <pre>
* Timestamps about the underlying resource, not about this Data Catalog
* entry. Output only when Entry is of type in the EntryType enum. For entries
* with user_specified_type, this field is optional and defaults to an empty
* timestamp.
* </pre>
*
* <code>.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;</code>
*/
com.google.cloud.datacatalog.v1.SystemTimestampsOrBuilder getSourceSystemTimestampsOrBuilder();
public com.google.cloud.datacatalog.v1.Entry.EntryTypeCase getEntryTypeCase();
public com.google.cloud.datacatalog.v1.Entry.SystemCase getSystemCase();
public com.google.cloud.datacatalog.v1.Entry.TypeSpecCase getTypeSpecCase();
}