datacatalog_gapic.yaml 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. type: com.google.api.codegen.ConfigProto
  2. config_schema_version: 2.0.0
  3. # The settings of generated code in a specific language.
  4. language_settings:
  5. python:
  6. package_name: google.cloud.datacatalog_v1beta1.gapic
  7. go:
  8. package_name: cloud.google.com/go/datacatalog/apiv1beta1
  9. csharp:
  10. package_name: Google.Cloud.Datacatalog.V1beta1
  11. ruby:
  12. package_name: Google::Cloud::Datacatalog::V1beta1
  13. php:
  14. package_name: Google\Cloud\Datacatalog\V1beta1
  15. nodejs:
  16. package_name: datacatalog.v1beta1
  17. domain_layer_location: google-cloud
  18. # A list of API interface configurations.
  19. interfaces:
  20. # The fully qualified name of the API interface.
  21. - name: google.cloud.datacatalog.v1beta1.DataCatalog
  22. methods:
  23. - name: SearchCatalog
  24. samples:
  25. standalone:
  26. - value_sets: [datacatalog_search]
  27. region_tag: datacatalog_search
  28. sample_value_sets:
  29. - id: datacatalog_search
  30. description: Search Catalog
  31. parameters:
  32. defaults:
  33. - scope.include_project_ids[0] = "[Google Cloud Project ID]"
  34. - scope.include_gcp_public_datasets = false
  35. - query = "[String in search query syntax]"
  36. attributes:
  37. - parameter: scope.include_project_ids[0]
  38. description: Your Google Cloud project ID.
  39. sample_argument_name: include_project_id
  40. - parameter: scope.include_gcp_public_datasets
  41. description: If true, include Google Cloud Platform (GCP) public datasets in the search results.
  42. sample_argument_name: include_gcp_public_datasets
  43. - parameter: query
  44. description: |
  45. Your query string.
  46. See: https://cloud.google.com/data-catalog/docs/how-to/search-reference
  47. Example: system=bigquery type=dataset
  48. sample_argument_name: query
  49. on_success:
  50. - print: ["Result type: %s", $resp.search_result_type]
  51. - print: ["Result subtype: %s", $resp.search_result_subtype]
  52. - print: ["Relative resource name: %s", $resp.relative_resource_name]
  53. - print: ["Linked resource: %s", $resp.linked_resource]
  54. - name: GetEntry
  55. samples:
  56. standalone:
  57. - region_tag: datacatalog_get_entry
  58. value_sets: [datacatalog_get_entry]
  59. sample_value_sets:
  60. - id: datacatalog_get_entry
  61. description: Get Entry
  62. parameters:
  63. defaults:
  64. # The full "name" is of the format: "projects/{project_id}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}"
  65. # Each part of the name can be separated out into its own parameter using `name%[part name]`
  66. - name%project = "[Google Cloud Project ID]"
  67. - name%location = "[Google Cloud Location ID]"
  68. - name%entry_group = "[Entry Group ID]"
  69. - name%entry = "[Entry ID]"
  70. attributes:
  71. - parameter: name%project
  72. description: "Your Google Cloud project ID"
  73. sample_argument_name: project_id
  74. - parameter: name%location
  75. description: "Google Cloud region, e.g. us-central1"
  76. sample_argument_name: location_id
  77. - parameter: name%entry_group
  78. description: "ID of the Entry Group, e.g. @bigquery, @pubsub, my_entry_group"
  79. sample_argument_name: entry_group_id
  80. - parameter: name%entry
  81. description: "ID of the Entry"
  82. sample_argument_name: entry_id
  83. on_success:
  84. - define: entry = $resp
  85. - print: ["Entry name: %s", entry.name]
  86. - print: ["Entry type: %s", entry.type]
  87. - print: ["Linked resource: %s", entry.linked_resource]
  88. - name: LookupEntry
  89. samples:
  90. standalone:
  91. - region_tag: datacatalog_lookup_entry
  92. value_sets: [datacatalog_lookup_entry]
  93. - region_tag: datacatalog_lookup_entry_sql_resource
  94. value_sets: [datacatalog_lookup_entry_sql_resource]
  95. sample_value_sets:
  96. - id: datacatalog_lookup_entry
  97. description: Lookup Entry
  98. parameters:
  99. defaults:
  100. - linked_resource = "[Full Resource Name]"
  101. attributes:
  102. - parameter: linked_resource
  103. sample_argument_name: resource_name
  104. description: |
  105. The full name of the Google Cloud Platform resource the Data Catalog entry represents.
  106. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
  107. Examples:
  108. //bigquery.googleapis.com/projects/bigquery-public-data/datasets/new_york_taxi_trips/tables/taxi_zone_geom
  109. //pubsub.googleapis.com/projects/pubsub-public-data/topics/taxirides-realtime
  110. on_success:
  111. - define: entry = $resp
  112. - print: ["Entry name: %s", entry.name]
  113. - print: ["Entry type: %s", entry.type]
  114. - print: ["Linked resource: %s", entry.linked_resource]
  115. - id: datacatalog_lookup_entry_sql_resource
  116. description: Lookup Entry using SQL resource
  117. parameters:
  118. defaults:
  119. - sql_resource = "[SQL Resource Name]"
  120. attributes:
  121. - parameter: sql_resource
  122. sample_argument_name: sql_name
  123. description: |
  124. The SQL name of the Google Cloud Platform resource the Data Catalog entry represents.
  125. Examples:
  126. bigquery.table.`bigquery-public-data`.new_york_taxi_trips.taxi_zone_geom
  127. pubsub.topic.`pubsub-public-data`.`taxirides-realtime`
  128. on_success:
  129. - define: entry = $resp
  130. - print: ["Entry name: %s", entry.name]
  131. - print: ["Entry type: %s", entry.type]
  132. - print: ["Linked resource: %s", entry.linked_resource]