Google Cloud Data Catalog Folders API

openapi: 3.2.0
info:
  title: Data Lineage Folders API
  version: v1
  description: Generated from Google's published Discovery document for Data Lineage API (datalineage v1, revision 20261107). 2 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://datalineage.googleapis.com
tags:
- name: Folders
paths:
  /v1/folders/{foldersId}/locations/{locationsId}/config:
    patch:
      operationId: datalineage.folders.locations.config.patch
      summary: Patch config
      description: Update the Config for a given resource.
      parameters:
      - name: foldersId
        in: path
        required: true
        description: Resource name segment (foldersId).
        schema:
          type: string
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1Config'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1Config'
        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: []
      tags:
      - Folders
    get:
      operationId: datalineage.folders.locations.config.get
      summary: Get config
      description: Get the Config for a given resource.
      parameters:
      - name: foldersId
        in: path
        required: true
        description: Resource name segment (foldersId).
        schema:
          type: string
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1Config'
        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: []
      tags:
      - Folders
components:
  schemas:
    GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleLineageEnablement:
      description: Lineage enablement configuration. Defines configurations for the ingestion of lineage for the resource and its children.
      type: object
      properties:
        enabled:
          description: Optional. If true, ingestion of lineage should be enabled. If false, it should be disabled. If unspecified, the system default value is used.
          type: boolean
    GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleIntegrationSelector:
      type: object
      properties:
        integration:
          description: Required. Integration to which the rule applies. This field can be used to specify the integration against which the ingestion rule should be applied.
          type: string
          enum:
          - INTEGRATION_UNSPECIFIED
          - BIGQUERY
          - DATAPROC
          - LOOKER_CORE
          - MANAGED_AIRFLOW
      description: Integration selector of the rule. The rule is only applied to the Integration selected by the selector.
    GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRule:
      properties:
        lineageEnablement:
          $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleLineageEnablement'
          description: Required. Lineage enablement configuration. Defines configurations for the ingestion of lineage for the resource and its children. If unspecified, the ingestion will be enabled only if it was configured in the resource's parent.
        integrationSelector:
          $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleIntegrationSelector'
          description: Required. Integration selector of the rule. The rule is only applied to the Integration selected by the selector.
      description: Ingestion rule for Data Lineage ingestion.
      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
    GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestion:
      description: Defines how Lineage should be ingested for a given resource.
      type: object
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRule'
          description: Optional. List of rules for Data Lineage ingestion.
    GoogleCloudDatacatalogLineageConfigmanagementV1Config:
      type: object
      properties:
        name:
          description: 'Identifier. The resource name of the config. Format: `organizations/{organization_id}/locations/global/config` `folders/{folder_id}/locations/global/config` `projects/{project_id}/locations/global/config` `projects/{project_number}/locations/global/config`'
          type: string
        etag:
          description: 'Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a config from overwriting each other. It is required that systems make use of the `etag` in the read-modify-write cycle to perform config updates in order to avoid race conditions: An `etag` is returned in the response to `GetConfig`, and systems are expected to put that etag in the request to `UpdateConfig` to ensure that their change will be applied to the same version of the config. If an `etag` is not provided in the call to `UpdateConfig`, then the existing config, if any, will be overwritten.'
          type: string
        ingestion:
          $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestion'
          description: Optional. Ingestion rule for Data Lineage ingestion.
      description: Configuration for Data Lineage. Defines different configuration options for Lineage customers to control behaviour of lineage systems.
  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/datalineage.readonly: See your Google Cloud Data Lineage data and the email address of your Google Account
            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.
            https://www.googleapis.com/auth/datalineage.read-write: See, edit, configure, and delete your Google Cloud Data Lineage data and see the email address for your Google Account
externalDocs:
  url: https://cloud.google.com/data-catalog
x-provenance:
  method: harvested
  publisher: Google
  source: https://datalineage.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261107)