1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/datacatalog/v1/datacatalog.proto 18 19 package com.google.cloud.datacatalog.v1; 20 21 public interface EntryOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.datacatalog.v1.Entry) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Output only. The resource name of an entry in URL format. 31 * Note: The entry itself and its child resources might not be 32 * stored in the location specified in its name. 33 * </pre> 34 * 35 * <code> 36 * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 37 * </code> 38 * 39 * @return The name. 40 */ getName()41 java.lang.String getName(); 42 /** 43 * 44 * 45 * <pre> 46 * Output only. The resource name of an entry in URL format. 47 * Note: The entry itself and its child resources might not be 48 * stored in the location specified in its name. 49 * </pre> 50 * 51 * <code> 52 * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 53 * </code> 54 * 55 * @return The bytes for name. 56 */ getNameBytes()57 com.google.protobuf.ByteString getNameBytes(); 58 59 /** 60 * 61 * 62 * <pre> 63 * The resource this metadata entry refers to. 64 * For Google Cloud Platform resources, `linked_resource` is the 65 * [Full Resource Name] 66 * (https://cloud.google.com/apis/design/resource_names#full_resource_name). 67 * For example, the `linked_resource` for a table resource from BigQuery is: 68 * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` 69 * Output only when the entry is one of the types in the `EntryType` enum. 70 * For entries with a `user_specified_type`, this field is optional and 71 * defaults to an empty string. 72 * The resource string must contain only letters (a-z, A-Z), numbers (0-9), 73 * underscores (_), periods (.), colons (:), slashes (/), dashes (-), 74 * and hashes (#). 75 * The maximum size is 200 bytes when encoded in UTF-8. 76 * </pre> 77 * 78 * <code>string linked_resource = 9;</code> 79 * 80 * @return The linkedResource. 81 */ getLinkedResource()82 java.lang.String getLinkedResource(); 83 /** 84 * 85 * 86 * <pre> 87 * The resource this metadata entry refers to. 88 * For Google Cloud Platform resources, `linked_resource` is the 89 * [Full Resource Name] 90 * (https://cloud.google.com/apis/design/resource_names#full_resource_name). 91 * For example, the `linked_resource` for a table resource from BigQuery is: 92 * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` 93 * Output only when the entry is one of the types in the `EntryType` enum. 94 * For entries with a `user_specified_type`, this field is optional and 95 * defaults to an empty string. 96 * The resource string must contain only letters (a-z, A-Z), numbers (0-9), 97 * underscores (_), periods (.), colons (:), slashes (/), dashes (-), 98 * and hashes (#). 99 * The maximum size is 200 bytes when encoded in UTF-8. 100 * </pre> 101 * 102 * <code>string linked_resource = 9;</code> 103 * 104 * @return The bytes for linkedResource. 105 */ getLinkedResourceBytes()106 com.google.protobuf.ByteString getLinkedResourceBytes(); 107 108 /** 109 * 110 * 111 * <pre> 112 * Fully qualified name (FQN) of the resource. Set automatically for entries 113 * representing resources from synced systems. Settable only during creation 114 * and read-only afterwards. Can be used for search and lookup of the entries. 115 * FQNs take two forms: 116 * * For non-regionalized resources: 117 * `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` 118 * * For regionalized resources: 119 * `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` 120 * Example for a DPMS table: 121 * `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}` 122 * </pre> 123 * 124 * <code>string fully_qualified_name = 29;</code> 125 * 126 * @return The fullyQualifiedName. 127 */ getFullyQualifiedName()128 java.lang.String getFullyQualifiedName(); 129 /** 130 * 131 * 132 * <pre> 133 * Fully qualified name (FQN) of the resource. Set automatically for entries 134 * representing resources from synced systems. Settable only during creation 135 * and read-only afterwards. Can be used for search and lookup of the entries. 136 * FQNs take two forms: 137 * * For non-regionalized resources: 138 * `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` 139 * * For regionalized resources: 140 * `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` 141 * Example for a DPMS table: 142 * `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}` 143 * </pre> 144 * 145 * <code>string fully_qualified_name = 29;</code> 146 * 147 * @return The bytes for fullyQualifiedName. 148 */ getFullyQualifiedNameBytes()149 com.google.protobuf.ByteString getFullyQualifiedNameBytes(); 150 151 /** 152 * 153 * 154 * <pre> 155 * The type of the entry. 156 * Only used for entries with types listed in the `EntryType` enum. 157 * Currently, only `FILESET` enum value is allowed. All other entries 158 * created in Data Catalog must use the `user_specified_type`. 159 * </pre> 160 * 161 * <code>.google.cloud.datacatalog.v1.EntryType type = 2;</code> 162 * 163 * @return Whether the type field is set. 164 */ hasType()165 boolean hasType(); 166 /** 167 * 168 * 169 * <pre> 170 * The type of the entry. 171 * Only used for entries with types listed in the `EntryType` enum. 172 * Currently, only `FILESET` enum value is allowed. All other entries 173 * created in Data Catalog must use the `user_specified_type`. 174 * </pre> 175 * 176 * <code>.google.cloud.datacatalog.v1.EntryType type = 2;</code> 177 * 178 * @return The enum numeric value on the wire for type. 179 */ getTypeValue()180 int getTypeValue(); 181 /** 182 * 183 * 184 * <pre> 185 * The type of the entry. 186 * Only used for entries with types listed in the `EntryType` enum. 187 * Currently, only `FILESET` enum value is allowed. All other entries 188 * created in Data Catalog must use the `user_specified_type`. 189 * </pre> 190 * 191 * <code>.google.cloud.datacatalog.v1.EntryType type = 2;</code> 192 * 193 * @return The type. 194 */ getType()195 com.google.cloud.datacatalog.v1.EntryType getType(); 196 197 /** 198 * 199 * 200 * <pre> 201 * Custom entry type that doesn't match any of the values allowed for input 202 * and listed in the `EntryType` enum. 203 * When creating an entry, first check the type values in the enum. 204 * If there are no appropriate types for the new entry, 205 * provide a custom value, for example, `my_special_type`. 206 * The `user_specified_type` string has the following limitations: 207 * * Is case insensitive. 208 * * Must begin with a letter or underscore. 209 * * Can only contain letters, numbers, and underscores. 210 * * Must be at least 1 character and at most 64 characters long. 211 * </pre> 212 * 213 * <code>string user_specified_type = 16;</code> 214 * 215 * @return Whether the userSpecifiedType field is set. 216 */ hasUserSpecifiedType()217 boolean hasUserSpecifiedType(); 218 /** 219 * 220 * 221 * <pre> 222 * Custom entry type that doesn't match any of the values allowed for input 223 * and listed in the `EntryType` enum. 224 * When creating an entry, first check the type values in the enum. 225 * If there are no appropriate types for the new entry, 226 * provide a custom value, for example, `my_special_type`. 227 * The `user_specified_type` string has the following limitations: 228 * * Is case insensitive. 229 * * Must begin with a letter or underscore. 230 * * Can only contain letters, numbers, and underscores. 231 * * Must be at least 1 character and at most 64 characters long. 232 * </pre> 233 * 234 * <code>string user_specified_type = 16;</code> 235 * 236 * @return The userSpecifiedType. 237 */ getUserSpecifiedType()238 java.lang.String getUserSpecifiedType(); 239 /** 240 * 241 * 242 * <pre> 243 * Custom entry type that doesn't match any of the values allowed for input 244 * and listed in the `EntryType` enum. 245 * When creating an entry, first check the type values in the enum. 246 * If there are no appropriate types for the new entry, 247 * provide a custom value, for example, `my_special_type`. 248 * The `user_specified_type` string has the following limitations: 249 * * Is case insensitive. 250 * * Must begin with a letter or underscore. 251 * * Can only contain letters, numbers, and underscores. 252 * * Must be at least 1 character and at most 64 characters long. 253 * </pre> 254 * 255 * <code>string user_specified_type = 16;</code> 256 * 257 * @return The bytes for userSpecifiedType. 258 */ getUserSpecifiedTypeBytes()259 com.google.protobuf.ByteString getUserSpecifiedTypeBytes(); 260 261 /** 262 * 263 * 264 * <pre> 265 * Output only. Indicates the entry's source system that Data Catalog 266 * integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. 267 * </pre> 268 * 269 * <code> 270 * .google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; 271 * </code> 272 * 273 * @return Whether the integratedSystem field is set. 274 */ hasIntegratedSystem()275 boolean hasIntegratedSystem(); 276 /** 277 * 278 * 279 * <pre> 280 * Output only. Indicates the entry's source system that Data Catalog 281 * integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. 282 * </pre> 283 * 284 * <code> 285 * .google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; 286 * </code> 287 * 288 * @return The enum numeric value on the wire for integratedSystem. 289 */ getIntegratedSystemValue()290 int getIntegratedSystemValue(); 291 /** 292 * 293 * 294 * <pre> 295 * Output only. Indicates the entry's source system that Data Catalog 296 * integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. 297 * </pre> 298 * 299 * <code> 300 * .google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; 301 * </code> 302 * 303 * @return The integratedSystem. 304 */ getIntegratedSystem()305 com.google.cloud.datacatalog.v1.IntegratedSystem getIntegratedSystem(); 306 307 /** 308 * 309 * 310 * <pre> 311 * Indicates the entry's source system that Data Catalog doesn't 312 * automatically integrate with. 313 * The `user_specified_system` string has the following limitations: 314 * * Is case insensitive. 315 * * Must begin with a letter or underscore. 316 * * Can only contain letters, numbers, and underscores. 317 * * Must be at least 1 character and at most 64 characters long. 318 * </pre> 319 * 320 * <code>string user_specified_system = 18;</code> 321 * 322 * @return Whether the userSpecifiedSystem field is set. 323 */ hasUserSpecifiedSystem()324 boolean hasUserSpecifiedSystem(); 325 /** 326 * 327 * 328 * <pre> 329 * Indicates the entry's source system that Data Catalog doesn't 330 * automatically integrate with. 331 * The `user_specified_system` string has the following limitations: 332 * * Is case insensitive. 333 * * Must begin with a letter or underscore. 334 * * Can only contain letters, numbers, and underscores. 335 * * Must be at least 1 character and at most 64 characters long. 336 * </pre> 337 * 338 * <code>string user_specified_system = 18;</code> 339 * 340 * @return The userSpecifiedSystem. 341 */ getUserSpecifiedSystem()342 java.lang.String getUserSpecifiedSystem(); 343 /** 344 * 345 * 346 * <pre> 347 * Indicates the entry's source system that Data Catalog doesn't 348 * automatically integrate with. 349 * The `user_specified_system` string has the following limitations: 350 * * Is case insensitive. 351 * * Must begin with a letter or underscore. 352 * * Can only contain letters, numbers, and underscores. 353 * * Must be at least 1 character and at most 64 characters long. 354 * </pre> 355 * 356 * <code>string user_specified_system = 18;</code> 357 * 358 * @return The bytes for userSpecifiedSystem. 359 */ getUserSpecifiedSystemBytes()360 com.google.protobuf.ByteString getUserSpecifiedSystemBytes(); 361 362 /** 363 * 364 * 365 * <pre> 366 * Specification that applies to a relational database system. Only settable 367 * when `user_specified_system` is equal to `SQL_DATABASE` 368 * </pre> 369 * 370 * <code>.google.cloud.datacatalog.v1.SqlDatabaseSystemSpec sql_database_system_spec = 39;</code> 371 * 372 * @return Whether the sqlDatabaseSystemSpec field is set. 373 */ hasSqlDatabaseSystemSpec()374 boolean hasSqlDatabaseSystemSpec(); 375 /** 376 * 377 * 378 * <pre> 379 * Specification that applies to a relational database system. Only settable 380 * when `user_specified_system` is equal to `SQL_DATABASE` 381 * </pre> 382 * 383 * <code>.google.cloud.datacatalog.v1.SqlDatabaseSystemSpec sql_database_system_spec = 39;</code> 384 * 385 * @return The sqlDatabaseSystemSpec. 386 */ getSqlDatabaseSystemSpec()387 com.google.cloud.datacatalog.v1.SqlDatabaseSystemSpec getSqlDatabaseSystemSpec(); 388 /** 389 * 390 * 391 * <pre> 392 * Specification that applies to a relational database system. Only settable 393 * when `user_specified_system` is equal to `SQL_DATABASE` 394 * </pre> 395 * 396 * <code>.google.cloud.datacatalog.v1.SqlDatabaseSystemSpec sql_database_system_spec = 39;</code> 397 */ 398 com.google.cloud.datacatalog.v1.SqlDatabaseSystemSpecOrBuilder getSqlDatabaseSystemSpecOrBuilder()399 getSqlDatabaseSystemSpecOrBuilder(); 400 401 /** 402 * 403 * 404 * <pre> 405 * Specification that applies to Looker sysstem. Only settable when 406 * `user_specified_system` is equal to `LOOKER` 407 * </pre> 408 * 409 * <code>.google.cloud.datacatalog.v1.LookerSystemSpec looker_system_spec = 40;</code> 410 * 411 * @return Whether the lookerSystemSpec field is set. 412 */ hasLookerSystemSpec()413 boolean hasLookerSystemSpec(); 414 /** 415 * 416 * 417 * <pre> 418 * Specification that applies to Looker sysstem. Only settable when 419 * `user_specified_system` is equal to `LOOKER` 420 * </pre> 421 * 422 * <code>.google.cloud.datacatalog.v1.LookerSystemSpec looker_system_spec = 40;</code> 423 * 424 * @return The lookerSystemSpec. 425 */ getLookerSystemSpec()426 com.google.cloud.datacatalog.v1.LookerSystemSpec getLookerSystemSpec(); 427 /** 428 * 429 * 430 * <pre> 431 * Specification that applies to Looker sysstem. Only settable when 432 * `user_specified_system` is equal to `LOOKER` 433 * </pre> 434 * 435 * <code>.google.cloud.datacatalog.v1.LookerSystemSpec looker_system_spec = 40;</code> 436 */ getLookerSystemSpecOrBuilder()437 com.google.cloud.datacatalog.v1.LookerSystemSpecOrBuilder getLookerSystemSpecOrBuilder(); 438 439 /** 440 * 441 * 442 * <pre> 443 * Specification that applies to a Cloud Storage fileset. Valid only 444 * for entries with the `FILESET` type. 445 * </pre> 446 * 447 * <code>.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;</code> 448 * 449 * @return Whether the gcsFilesetSpec field is set. 450 */ hasGcsFilesetSpec()451 boolean hasGcsFilesetSpec(); 452 /** 453 * 454 * 455 * <pre> 456 * Specification that applies to a Cloud Storage fileset. Valid only 457 * for entries with the `FILESET` type. 458 * </pre> 459 * 460 * <code>.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;</code> 461 * 462 * @return The gcsFilesetSpec. 463 */ getGcsFilesetSpec()464 com.google.cloud.datacatalog.v1.GcsFilesetSpec getGcsFilesetSpec(); 465 /** 466 * 467 * 468 * <pre> 469 * Specification that applies to a Cloud Storage fileset. Valid only 470 * for entries with the `FILESET` type. 471 * </pre> 472 * 473 * <code>.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;</code> 474 */ getGcsFilesetSpecOrBuilder()475 com.google.cloud.datacatalog.v1.GcsFilesetSpecOrBuilder getGcsFilesetSpecOrBuilder(); 476 477 /** 478 * 479 * 480 * <pre> 481 * Output only. Specification that applies to a BigQuery table. Valid only 482 * for entries with the `TABLE` type. 483 * </pre> 484 * 485 * <code> 486 * .google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 487 * </code> 488 * 489 * @return Whether the bigqueryTableSpec field is set. 490 */ hasBigqueryTableSpec()491 boolean hasBigqueryTableSpec(); 492 /** 493 * 494 * 495 * <pre> 496 * Output only. Specification that applies to a BigQuery table. Valid only 497 * for entries with the `TABLE` type. 498 * </pre> 499 * 500 * <code> 501 * .google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 502 * </code> 503 * 504 * @return The bigqueryTableSpec. 505 */ getBigqueryTableSpec()506 com.google.cloud.datacatalog.v1.BigQueryTableSpec getBigqueryTableSpec(); 507 /** 508 * 509 * 510 * <pre> 511 * Output only. Specification that applies to a BigQuery table. Valid only 512 * for entries with the `TABLE` type. 513 * </pre> 514 * 515 * <code> 516 * .google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 517 * </code> 518 */ getBigqueryTableSpecOrBuilder()519 com.google.cloud.datacatalog.v1.BigQueryTableSpecOrBuilder getBigqueryTableSpecOrBuilder(); 520 521 /** 522 * 523 * 524 * <pre> 525 * Output only. Specification for a group of BigQuery tables with 526 * the `[prefix]YYYYMMDD` name pattern. 527 * For more information, see [Introduction to partitioned tables] 528 * (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). 529 * </pre> 530 * 531 * <code> 532 * .google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 533 * </code> 534 * 535 * @return Whether the bigqueryDateShardedSpec field is set. 536 */ hasBigqueryDateShardedSpec()537 boolean hasBigqueryDateShardedSpec(); 538 /** 539 * 540 * 541 * <pre> 542 * Output only. Specification for a group of BigQuery tables with 543 * the `[prefix]YYYYMMDD` name pattern. 544 * For more information, see [Introduction to partitioned tables] 545 * (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). 546 * </pre> 547 * 548 * <code> 549 * .google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 550 * </code> 551 * 552 * @return The bigqueryDateShardedSpec. 553 */ getBigqueryDateShardedSpec()554 com.google.cloud.datacatalog.v1.BigQueryDateShardedSpec getBigqueryDateShardedSpec(); 555 /** 556 * 557 * 558 * <pre> 559 * Output only. Specification for a group of BigQuery tables with 560 * the `[prefix]YYYYMMDD` name pattern. 561 * For more information, see [Introduction to partitioned tables] 562 * (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). 563 * </pre> 564 * 565 * <code> 566 * .google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 567 * </code> 568 */ 569 com.google.cloud.datacatalog.v1.BigQueryDateShardedSpecOrBuilder getBigqueryDateShardedSpecOrBuilder()570 getBigqueryDateShardedSpecOrBuilder(); 571 572 /** 573 * 574 * 575 * <pre> 576 * Specification that applies to a table resource. Valid only 577 * for entries with the `TABLE` or `EXPLORE` type. 578 * </pre> 579 * 580 * <code>.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;</code> 581 * 582 * @return Whether the databaseTableSpec field is set. 583 */ hasDatabaseTableSpec()584 boolean hasDatabaseTableSpec(); 585 /** 586 * 587 * 588 * <pre> 589 * Specification that applies to a table resource. Valid only 590 * for entries with the `TABLE` or `EXPLORE` type. 591 * </pre> 592 * 593 * <code>.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;</code> 594 * 595 * @return The databaseTableSpec. 596 */ getDatabaseTableSpec()597 com.google.cloud.datacatalog.v1.DatabaseTableSpec getDatabaseTableSpec(); 598 /** 599 * 600 * 601 * <pre> 602 * Specification that applies to a table resource. Valid only 603 * for entries with the `TABLE` or `EXPLORE` type. 604 * </pre> 605 * 606 * <code>.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;</code> 607 */ getDatabaseTableSpecOrBuilder()608 com.google.cloud.datacatalog.v1.DatabaseTableSpecOrBuilder getDatabaseTableSpecOrBuilder(); 609 610 /** 611 * 612 * 613 * <pre> 614 * Specification that applies to a data source connection. Valid only 615 * for entries with the `DATA_SOURCE_CONNECTION` type. 616 * </pre> 617 * 618 * <code>.google.cloud.datacatalog.v1.DataSourceConnectionSpec data_source_connection_spec = 27; 619 * </code> 620 * 621 * @return Whether the dataSourceConnectionSpec field is set. 622 */ hasDataSourceConnectionSpec()623 boolean hasDataSourceConnectionSpec(); 624 /** 625 * 626 * 627 * <pre> 628 * Specification that applies to a data source connection. Valid only 629 * for entries with the `DATA_SOURCE_CONNECTION` type. 630 * </pre> 631 * 632 * <code>.google.cloud.datacatalog.v1.DataSourceConnectionSpec data_source_connection_spec = 27; 633 * </code> 634 * 635 * @return The dataSourceConnectionSpec. 636 */ getDataSourceConnectionSpec()637 com.google.cloud.datacatalog.v1.DataSourceConnectionSpec getDataSourceConnectionSpec(); 638 /** 639 * 640 * 641 * <pre> 642 * Specification that applies to a data source connection. Valid only 643 * for entries with the `DATA_SOURCE_CONNECTION` type. 644 * </pre> 645 * 646 * <code>.google.cloud.datacatalog.v1.DataSourceConnectionSpec data_source_connection_spec = 27; 647 * </code> 648 */ 649 com.google.cloud.datacatalog.v1.DataSourceConnectionSpecOrBuilder getDataSourceConnectionSpecOrBuilder()650 getDataSourceConnectionSpecOrBuilder(); 651 652 /** 653 * 654 * 655 * <pre> 656 * Specification that applies to a user-defined function or procedure. Valid 657 * only for entries with the `ROUTINE` type. 658 * </pre> 659 * 660 * <code>.google.cloud.datacatalog.v1.RoutineSpec routine_spec = 28;</code> 661 * 662 * @return Whether the routineSpec field is set. 663 */ hasRoutineSpec()664 boolean hasRoutineSpec(); 665 /** 666 * 667 * 668 * <pre> 669 * Specification that applies to a user-defined function or procedure. Valid 670 * only for entries with the `ROUTINE` type. 671 * </pre> 672 * 673 * <code>.google.cloud.datacatalog.v1.RoutineSpec routine_spec = 28;</code> 674 * 675 * @return The routineSpec. 676 */ getRoutineSpec()677 com.google.cloud.datacatalog.v1.RoutineSpec getRoutineSpec(); 678 /** 679 * 680 * 681 * <pre> 682 * Specification that applies to a user-defined function or procedure. Valid 683 * only for entries with the `ROUTINE` type. 684 * </pre> 685 * 686 * <code>.google.cloud.datacatalog.v1.RoutineSpec routine_spec = 28;</code> 687 */ getRoutineSpecOrBuilder()688 com.google.cloud.datacatalog.v1.RoutineSpecOrBuilder getRoutineSpecOrBuilder(); 689 690 /** 691 * 692 * 693 * <pre> 694 * Specification that applies to a fileset resource. Valid only 695 * for entries with the `FILESET` type. 696 * </pre> 697 * 698 * <code>.google.cloud.datacatalog.v1.FilesetSpec fileset_spec = 33;</code> 699 * 700 * @return Whether the filesetSpec field is set. 701 */ hasFilesetSpec()702 boolean hasFilesetSpec(); 703 /** 704 * 705 * 706 * <pre> 707 * Specification that applies to a fileset resource. Valid only 708 * for entries with the `FILESET` type. 709 * </pre> 710 * 711 * <code>.google.cloud.datacatalog.v1.FilesetSpec fileset_spec = 33;</code> 712 * 713 * @return The filesetSpec. 714 */ getFilesetSpec()715 com.google.cloud.datacatalog.v1.FilesetSpec getFilesetSpec(); 716 /** 717 * 718 * 719 * <pre> 720 * Specification that applies to a fileset resource. Valid only 721 * for entries with the `FILESET` type. 722 * </pre> 723 * 724 * <code>.google.cloud.datacatalog.v1.FilesetSpec fileset_spec = 33;</code> 725 */ getFilesetSpecOrBuilder()726 com.google.cloud.datacatalog.v1.FilesetSpecOrBuilder getFilesetSpecOrBuilder(); 727 728 /** 729 * 730 * 731 * <pre> 732 * Display name of an entry. 733 * The maximum size is 500 bytes when encoded in UTF-8. 734 * Default value is an empty string. 735 * </pre> 736 * 737 * <code>string display_name = 3;</code> 738 * 739 * @return The displayName. 740 */ getDisplayName()741 java.lang.String getDisplayName(); 742 /** 743 * 744 * 745 * <pre> 746 * Display name of an entry. 747 * The maximum size is 500 bytes when encoded in UTF-8. 748 * Default value is an empty string. 749 * </pre> 750 * 751 * <code>string display_name = 3;</code> 752 * 753 * @return The bytes for displayName. 754 */ getDisplayNameBytes()755 com.google.protobuf.ByteString getDisplayNameBytes(); 756 757 /** 758 * 759 * 760 * <pre> 761 * Entry description that can consist of several sentences or paragraphs 762 * that describe entry contents. 763 * The description must not contain Unicode non-characters as well as C0 764 * and C1 control codes except tabs (HT), new lines (LF), carriage returns 765 * (CR), and page breaks (FF). 766 * The maximum size is 2000 bytes when encoded in UTF-8. 767 * Default value is an empty string. 768 * </pre> 769 * 770 * <code>string description = 4;</code> 771 * 772 * @return The description. 773 */ getDescription()774 java.lang.String getDescription(); 775 /** 776 * 777 * 778 * <pre> 779 * Entry description that can consist of several sentences or paragraphs 780 * that describe entry contents. 781 * The description must not contain Unicode non-characters as well as C0 782 * and C1 control codes except tabs (HT), new lines (LF), carriage returns 783 * (CR), and page breaks (FF). 784 * The maximum size is 2000 bytes when encoded in UTF-8. 785 * Default value is an empty string. 786 * </pre> 787 * 788 * <code>string description = 4;</code> 789 * 790 * @return The bytes for description. 791 */ getDescriptionBytes()792 com.google.protobuf.ByteString getDescriptionBytes(); 793 794 /** 795 * 796 * 797 * <pre> 798 * Business Context of the entry. Not supported for BigQuery datasets 799 * </pre> 800 * 801 * <code>.google.cloud.datacatalog.v1.BusinessContext business_context = 37;</code> 802 * 803 * @return Whether the businessContext field is set. 804 */ hasBusinessContext()805 boolean hasBusinessContext(); 806 /** 807 * 808 * 809 * <pre> 810 * Business Context of the entry. Not supported for BigQuery datasets 811 * </pre> 812 * 813 * <code>.google.cloud.datacatalog.v1.BusinessContext business_context = 37;</code> 814 * 815 * @return The businessContext. 816 */ getBusinessContext()817 com.google.cloud.datacatalog.v1.BusinessContext getBusinessContext(); 818 /** 819 * 820 * 821 * <pre> 822 * Business Context of the entry. Not supported for BigQuery datasets 823 * </pre> 824 * 825 * <code>.google.cloud.datacatalog.v1.BusinessContext business_context = 37;</code> 826 */ getBusinessContextOrBuilder()827 com.google.cloud.datacatalog.v1.BusinessContextOrBuilder getBusinessContextOrBuilder(); 828 829 /** 830 * 831 * 832 * <pre> 833 * Schema of the entry. An entry might not have any schema attached to it. 834 * </pre> 835 * 836 * <code>.google.cloud.datacatalog.v1.Schema schema = 5;</code> 837 * 838 * @return Whether the schema field is set. 839 */ hasSchema()840 boolean hasSchema(); 841 /** 842 * 843 * 844 * <pre> 845 * Schema of the entry. An entry might not have any schema attached to it. 846 * </pre> 847 * 848 * <code>.google.cloud.datacatalog.v1.Schema schema = 5;</code> 849 * 850 * @return The schema. 851 */ getSchema()852 com.google.cloud.datacatalog.v1.Schema getSchema(); 853 /** 854 * 855 * 856 * <pre> 857 * Schema of the entry. An entry might not have any schema attached to it. 858 * </pre> 859 * 860 * <code>.google.cloud.datacatalog.v1.Schema schema = 5;</code> 861 */ getSchemaOrBuilder()862 com.google.cloud.datacatalog.v1.SchemaOrBuilder getSchemaOrBuilder(); 863 864 /** 865 * 866 * 867 * <pre> 868 * Timestamps from the underlying resource, not from the Data Catalog 869 * entry. 870 * Output only when the entry has a system listed in the `IntegratedSystem` 871 * enum. For entries with `user_specified_system`, this field is optional 872 * and defaults to an empty timestamp. 873 * </pre> 874 * 875 * <code>.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;</code> 876 * 877 * @return Whether the sourceSystemTimestamps field is set. 878 */ hasSourceSystemTimestamps()879 boolean hasSourceSystemTimestamps(); 880 /** 881 * 882 * 883 * <pre> 884 * Timestamps from the underlying resource, not from the Data Catalog 885 * entry. 886 * Output only when the entry has a system listed in the `IntegratedSystem` 887 * enum. For entries with `user_specified_system`, this field is optional 888 * and defaults to an empty timestamp. 889 * </pre> 890 * 891 * <code>.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;</code> 892 * 893 * @return The sourceSystemTimestamps. 894 */ getSourceSystemTimestamps()895 com.google.cloud.datacatalog.v1.SystemTimestamps getSourceSystemTimestamps(); 896 /** 897 * 898 * 899 * <pre> 900 * Timestamps from the underlying resource, not from the Data Catalog 901 * entry. 902 * Output only when the entry has a system listed in the `IntegratedSystem` 903 * enum. For entries with `user_specified_system`, this field is optional 904 * and defaults to an empty timestamp. 905 * </pre> 906 * 907 * <code>.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;</code> 908 */ getSourceSystemTimestampsOrBuilder()909 com.google.cloud.datacatalog.v1.SystemTimestampsOrBuilder getSourceSystemTimestampsOrBuilder(); 910 911 /** 912 * 913 * 914 * <pre> 915 * Resource usage statistics. 916 * </pre> 917 * 918 * <code>.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;</code> 919 * 920 * @return Whether the usageSignal field is set. 921 */ hasUsageSignal()922 boolean hasUsageSignal(); 923 /** 924 * 925 * 926 * <pre> 927 * Resource usage statistics. 928 * </pre> 929 * 930 * <code>.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;</code> 931 * 932 * @return The usageSignal. 933 */ getUsageSignal()934 com.google.cloud.datacatalog.v1.UsageSignal getUsageSignal(); 935 /** 936 * 937 * 938 * <pre> 939 * Resource usage statistics. 940 * </pre> 941 * 942 * <code>.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;</code> 943 */ getUsageSignalOrBuilder()944 com.google.cloud.datacatalog.v1.UsageSignalOrBuilder getUsageSignalOrBuilder(); 945 946 /** 947 * 948 * 949 * <pre> 950 * Cloud labels attached to the entry. 951 * In Data Catalog, you can create and modify labels attached only to custom 952 * entries. Synced entries have unmodifiable labels that come from the source 953 * system. 954 * </pre> 955 * 956 * <code>map<string, string> labels = 14;</code> 957 */ getLabelsCount()958 int getLabelsCount(); 959 /** 960 * 961 * 962 * <pre> 963 * Cloud labels attached to the entry. 964 * In Data Catalog, you can create and modify labels attached only to custom 965 * entries. Synced entries have unmodifiable labels that come from the source 966 * system. 967 * </pre> 968 * 969 * <code>map<string, string> labels = 14;</code> 970 */ containsLabels(java.lang.String key)971 boolean containsLabels(java.lang.String key); 972 /** Use {@link #getLabelsMap()} instead. */ 973 @java.lang.Deprecated getLabels()974 java.util.Map<java.lang.String, java.lang.String> getLabels(); 975 /** 976 * 977 * 978 * <pre> 979 * Cloud labels attached to the entry. 980 * In Data Catalog, you can create and modify labels attached only to custom 981 * entries. Synced entries have unmodifiable labels that come from the source 982 * system. 983 * </pre> 984 * 985 * <code>map<string, string> labels = 14;</code> 986 */ getLabelsMap()987 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 988 /** 989 * 990 * 991 * <pre> 992 * Cloud labels attached to the entry. 993 * In Data Catalog, you can create and modify labels attached only to custom 994 * entries. Synced entries have unmodifiable labels that come from the source 995 * system. 996 * </pre> 997 * 998 * <code>map<string, string> labels = 14;</code> 999 */ 1000 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)1001 java.lang.String getLabelsOrDefault( 1002 java.lang.String key, 1003 /* nullable */ 1004 java.lang.String defaultValue); 1005 /** 1006 * 1007 * 1008 * <pre> 1009 * Cloud labels attached to the entry. 1010 * In Data Catalog, you can create and modify labels attached only to custom 1011 * entries. Synced entries have unmodifiable labels that come from the source 1012 * system. 1013 * </pre> 1014 * 1015 * <code>map<string, string> labels = 14;</code> 1016 */ getLabelsOrThrow(java.lang.String key)1017 java.lang.String getLabelsOrThrow(java.lang.String key); 1018 1019 /** 1020 * 1021 * 1022 * <pre> 1023 * Output only. Physical location of the entry. 1024 * </pre> 1025 * 1026 * <code> 1027 * .google.cloud.datacatalog.v1.DataSource data_source = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1028 * </code> 1029 * 1030 * @return Whether the dataSource field is set. 1031 */ hasDataSource()1032 boolean hasDataSource(); 1033 /** 1034 * 1035 * 1036 * <pre> 1037 * Output only. Physical location of the entry. 1038 * </pre> 1039 * 1040 * <code> 1041 * .google.cloud.datacatalog.v1.DataSource data_source = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1042 * </code> 1043 * 1044 * @return The dataSource. 1045 */ getDataSource()1046 com.google.cloud.datacatalog.v1.DataSource getDataSource(); 1047 /** 1048 * 1049 * 1050 * <pre> 1051 * Output only. Physical location of the entry. 1052 * </pre> 1053 * 1054 * <code> 1055 * .google.cloud.datacatalog.v1.DataSource data_source = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1056 * </code> 1057 */ getDataSourceOrBuilder()1058 com.google.cloud.datacatalog.v1.DataSourceOrBuilder getDataSourceOrBuilder(); 1059 1060 /** 1061 * 1062 * 1063 * <pre> 1064 * Output only. Additional information related to the entry. Private to the 1065 * current user. 1066 * </pre> 1067 * 1068 * <code> 1069 * .google.cloud.datacatalog.v1.PersonalDetails personal_details = 26 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1070 * </code> 1071 * 1072 * @return Whether the personalDetails field is set. 1073 */ hasPersonalDetails()1074 boolean hasPersonalDetails(); 1075 /** 1076 * 1077 * 1078 * <pre> 1079 * Output only. Additional information related to the entry. Private to the 1080 * current user. 1081 * </pre> 1082 * 1083 * <code> 1084 * .google.cloud.datacatalog.v1.PersonalDetails personal_details = 26 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1085 * </code> 1086 * 1087 * @return The personalDetails. 1088 */ getPersonalDetails()1089 com.google.cloud.datacatalog.v1.PersonalDetails getPersonalDetails(); 1090 /** 1091 * 1092 * 1093 * <pre> 1094 * Output only. Additional information related to the entry. Private to the 1095 * current user. 1096 * </pre> 1097 * 1098 * <code> 1099 * .google.cloud.datacatalog.v1.PersonalDetails personal_details = 26 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1100 * </code> 1101 */ getPersonalDetailsOrBuilder()1102 com.google.cloud.datacatalog.v1.PersonalDetailsOrBuilder getPersonalDetailsOrBuilder(); 1103 getEntryTypeCase()1104 public com.google.cloud.datacatalog.v1.Entry.EntryTypeCase getEntryTypeCase(); 1105 getSystemCase()1106 public com.google.cloud.datacatalog.v1.Entry.SystemCase getSystemCase(); 1107 getSystemSpecCase()1108 public com.google.cloud.datacatalog.v1.Entry.SystemSpecCase getSystemSpecCase(); 1109 getTypeSpecCase()1110 public com.google.cloud.datacatalog.v1.Entry.TypeSpecCase getTypeSpecCase(); 1111 getSpecCase()1112 public com.google.cloud.datacatalog.v1.Entry.SpecCase getSpecCase(); 1113 } 1114