Google Cloud Data Catalog Catalog API

openapi: 3.2.0
info:
  title: Google Cloud Data Catalog API
  version: v1
  description: Generated from Google's published Discovery document for Google Cloud Data Catalog API (datacatalog v1, revision 20261106). 1 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://datacatalog.googleapis.com
tags:
- name: Catalog
paths:
  /v1/catalog:search:
    post:
      operationId: datacatalog.catalog.search
      summary: Search catalog
      description: 'Searches Data Catalog for multiple resources like entries and tags that match a query. This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn''t return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods. Note: Data Catalog search queries don''t guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. For more information, see [Data Catalog search syntax] (https://cloud.google.com/data-catalog/docs/how-to/search-reference).'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleCloudDatacatalogV1SearchCatalogRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDatacatalogV1SearchCatalogResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      deprecated: true
      tags:
      - Catalog
components:
  schemas:
    GoogleCloudDatacatalogV1SearchCatalogResponse:
      type: object
      description: Response message for SearchCatalog.
      properties:
        results:
          items:
            $ref: '#/components/schemas/GoogleCloudDatacatalogV1SearchCatalogResult'
          description: Search results.
          type: array
        totalSize:
          description: The approximate total number of entries matched by the query.
          format: int32
          type: integer
        nextPageToken:
          description: Pagination token that can be used in subsequent calls to retrieve the next page of results.
          type: string
        unreachable:
          description: Unreachable locations. Search results don't include data from those locations. To get additional information on an error, repeat the search request and restrict it to specific locations by setting the `SearchCatalogRequest.scope.restricted_locations` parameter.
          type: array
          items:
            type: string
    GoogleCloudDatacatalogV1SearchCatalogResult:
      properties:
        searchResultType:
          description: Type of the search result. You can use this field to determine which get method to call to fetch the full resource.
          enum:
          - SEARCH_RESULT_TYPE_UNSPECIFIED
          - ENTRY
          - TAG_TEMPLATE
          - ENTRY_GROUP
          type: string
        searchResultSubtype:
          type: string
          description: 'Sub-type of the search result. A dot-delimited full type of the resource. The same type you specify in the `type` search predicate. Examples: `entry.table`, `entry.dataStream`, `tagTemplate`.'
        fullyQualifiedName:
          type: string
          description: 'Fully qualified name (FQN) of the resource. FQNs take two forms: * For non-regionalized resources: `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` * For regionalized resources: `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` Example for a DPMS table: `dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID`'
        displayName:
          type: string
          description: The display name of the result.
        integratedSystem:
          description: Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
          readOnly: true
          enum:
          - INTEGRATED_SYSTEM_UNSPECIFIED
          - BIGQUERY
          - CLOUD_PUBSUB
          - DATAPROC_METASTORE
          - DATAPLEX
          - CLOUD_SPANNER
          - CLOUD_BIGTABLE
          - CLOUD_SQL
          - LOOKER
          - VERTEX_AI
          type: string
        linkedResource:
          type: string
          description: 'The full name of the Google Cloud resource the entry belongs to. For more information, see [Full Resource Name] (/apis/design/resource_names#full_resource_name). Example: `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`'
        relativeResourceName:
          description: 'The relative name of the resource in URL format. Examples: * `projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}` * `projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}`'
          type: string
        description:
          description: Entry description that can consist of several sentences or paragraphs that describe entry contents.
          type: string
        modifyTime:
          type: string
          description: The last modification timestamp of the entry in the source system.
          format: google-datetime
        userSpecifiedSystem:
          type: string
          description: Custom source system that you can manually integrate Data Catalog with.
      description: Result in the response to a search request. Each result captures details of one entry that matches the search.
      type: object
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    GoogleCloudDatacatalogV1SearchCatalogRequestScope:
      type: object
      properties:
        includeOrgIds:
          description: The list of organization IDs to search within. To find your organization ID, follow the steps from [Creating and managing organizations] (/resource-manager/docs/creating-managing-organization).
          items:
            type: string
          type: array
        includeProjectIds:
          description: The list of project IDs to search within. For more information on the distinction between project names, IDs, and numbers, see [Projects](/docs/overview/#projects).
          type: array
          items:
            type: string
        includePublicTagTemplates:
          type: boolean
          description: Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.
          deprecated: true
        restrictedLocations:
          items:
            type: string
          type: array
          description: Optional. The list of locations to search within. If empty, all locations are searched. Returns an error if any location in the list isn't one of the [Supported regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions). If a location is unreachable, its name is returned in the `SearchCatalogResponse.unreachable` field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.
        starredOnly:
          description: Optional. If `true`, search only among starred entries. By default, all results are returned, starred or not.
          type: boolean
        includeGcpPublicDatasets:
          description: If `true`, include Google Cloud public datasets in search results. By default, they are excluded. See [Google Cloud Public Datasets](/public-datasets) for more information.
          type: boolean
      description: The criteria that select the subspace used for query matching.
    GoogleCloudDatacatalogV1SearchCatalogRequest:
      type: object
      properties:
        pageSize:
          type: integer
          description: Upper bound on the number of results you can get in a single response. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.
          format: int32
        query:
          type: string
          description: 'Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see [Data Catalog search syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference). An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple `xyz` or qualified by predicates: * `name:x` * `column:y` * `description:z`'
        adminSearch:
          type: boolean
          description: Optional. If set, use searchAll permission granted on organizations from `include_org_ids` and projects from `include_project_ids` instead of the fine grained per resource permissions when filtering the search results. The only allowed `order_by` criteria for admin_search mode is `default`. Using this flags guarantees a full recall of the search results.
        scope:
          $ref: '#/components/schemas/GoogleCloudDatacatalogV1SearchCatalogRequestScope'
          description: Required. The scope of this search request. The `scope` is invalid if `include_org_ids`, `include_project_ids` are empty AND `include_gcp_public_datasets` is set to `false`. In this case, the request returns an error.
        orderBy:
          description: 'Specifies the order of results. Currently supported case-sensitive values are: * `relevance` that can only be descending * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default * `default` that can only be descending Search queries don''t guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don''t have to fetch the results in any specific order, consider setting this parameter to `default`. If this parameter is omitted, it defaults to the descending `relevance`.'
          type: string
        pageToken:
          type: string
          description: Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.
      description: Request message for SearchCatalog.
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
externalDocs:
  url: https://cloud.google.com/data-catalog/docs/
x-provenance:
  method: harvested
  publisher: Google
  source: https://datacatalog.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261106)