Google Cloud Data Catalog API (datacatalog:v1)

2022-12-09

5 removed methods

Deletions

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

      Parameters:

        parent

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

          Type: string

          Description: Required. Target entry group for ingested entries.

          Location: path

          Required: Yes

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

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

      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.

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

      Parameter Order: parent

      HTTP Method: POST

  • datacatalog.projects.locations.operations.cancel

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

      Path: v1/{+name}:cancel

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

      Parameters:

        name

          Location: path

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

          Required: Yes

          Type: string

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

      Parameter Order: name

      HTTP Method: POST

      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.operations.get

      Parameters:

        name

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

          Required: Yes

          Location: path

          Type: string

          Description: The name of the operation resource.

      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.

      Parameter Order: name

      Path: v1/{+name}

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

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

      HTTP Method: GET

  • datacatalog.projects.locations.operations.delete

      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

      Path: v1/{+name}

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

      Parameter Order: name

  • datacatalog.projects.locations.operations.list

      Parameters:

        pageToken

          Description: The standard list page token.

          Location: query

          Type: string

        name

          Type: string

          Required: Yes

          Location: path

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

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

        filter

          Description: The standard list filter.

          Location: query

          Type: string

        pageSize

          Type: integer

          Location: query

          Format: int32

          Description: The standard list page size.

      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.

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

      Path: v1/{+name}/operations

      Parameter Order: name

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

      HTTP Method: GET

5 new methods

Additions

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

      Parameters:

        parent

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

          Type: string

          Description: Required. Target entry group for ingested entries.

          Location: path

          Required: Yes

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

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

      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.

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

      Parameter Order: parent

      HTTP Method: POST

  • datacatalog.projects.locations.operations.cancel

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

      Path: v1/{+name}:cancel

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

      Parameters:

        name

          Location: path

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

          Required: Yes

          Type: string

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

      Parameter Order: name

      HTTP Method: POST

      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.operations.get

      Parameters:

        name

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

          Required: Yes

          Location: path

          Type: string

          Description: The name of the operation resource.

      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.

      Parameter Order: name

      Path: v1/{+name}

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

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

      HTTP Method: GET

  • datacatalog.projects.locations.operations.delete

      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

      Path: v1/{+name}

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

      Parameter Order: name

  • datacatalog.projects.locations.operations.list

      Parameters:

        pageToken

          Description: The standard list page token.

          Location: query

          Type: string

        name

          Type: string

          Required: Yes

          Location: path

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

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

        filter

          Description: The standard list filter.

          Location: query

          Type: string

        pageSize

          Type: integer

          Location: query

          Format: int32

          Description: The standard list page size.

      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.

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

      Path: v1/{+name}/operations

      Parameter Order: name

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

      HTTP Method: GET