Google Cloud Data Catalog API (datacatalog:v1)

2022-12-10

5 new methods

Additions

    Methods
  • datacatalog.projects.locations.operations.get

      Parameters :

        name

          Required : Yes

          Type : string

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Description : The name of the operation resource.

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Parameter Order : name

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

      Path : v1/{+name}

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • datacatalog.projects.locations.operations.delete

      Path : v1/{+name}

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

      HTTP Method : DELETE

      Parameters :

        name

          Location : path

          Required : Yes

          Description : The name of the operation resource to be deleted.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Type : string

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

  • datacatalog.projects.locations.operations.list

      HTTP Method : GET

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations

      Parameters :

        filter

          Location : query

          Description : The standard list filter.

          Type : string

        name

          Description : The name of the operation's parent resource.

          Type : string

          Required : Yes

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+$

        pageSize

          Format : int32

          Description : The standard list page size.

          Location : query

          Type : integer

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

      Path : v1/{+name}/operations

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

  • datacatalog.projects.locations.operations.cancel

      Path : v1/{+name}:cancel

      Parameters :

        name

          Description : The name of the operation resource to be cancelled.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      Parameter Order : name

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

  • datacatalog.projects.locations.entryGroups.entries.import

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : POST

      Parameters :

        parent

          Type : string

          Location : path

          Description : Required. Target entry group for ingested entries.

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries:import

      Parameter Order : parent

      Description : Imports entries from some source (e.g. dump in a Cloud Storage bucket) to the Data Catalog. Dump here is a snapshot of the third-party system state, that needs to be ingested in the Data Catalog. Import of entries is a sync operation that reconciles state of the third-party system and Data Catalog. ImportEntries is a long-running operation done in the background, so this method returns long-running operation resource. The resource can be queried with Operations.GetOperation which contains metadata and response.

      Path : v1/{+parent}/entries:import