Cloud Dataplex API (dataplex:v1)

2026-05-22

6 new methods

Additions

    Methods
  • dataplex.projects.locations.changeRequests.get

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/dataplex.read-write
    • Description : Gets a ChangeRequest.

      HTTP Method : GET

      Parameters :

        name

          Required : Yes

          Type : string

          Location : path

          Description : Required. The name of the ChangeRequest to retrieve. Format: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}

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

      Path : v1/{+name}

  • dataplex.projects.locations.changeRequests.list

      Path : v1/{+parent}/changeRequests

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/dataplex.read-write
    • Flat Path : v1/projects/{projectsId}/locations/{locationsId}/changeRequests

      HTTP Method : GET

      Parameters :

        orderBy

          Description : Optional. Order by fields for the result.

          Type : string

          Location : query

        parent

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

          Description : Required. The parent, which owns this collection of ChangeRequests. Format: projects/{project_number}/locations/{location_id}

          Location : path

          Required : Yes

          Type : string

        pageToken

          Location : query

          Description : Optional. Page token received from a previous ListChangeRequests call.

          Type : string

        pageSize

          Description : Optional. Maximum number of ChangeRequests to return. The service may return fewer.

          Type : integer

          Location : query

          Format : int32

        filter

          Location : query

          Description : Optional. Filter request. Supports filtering by: state, author, resource, create_time, update_time.

          Type : string

      Description : Lists ChangeRequests.

  • dataplex.projects.locations.changeRequests.approve

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}:approve

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/dataplex.read-write
    • HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the ChangeRequest to approve.

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

          Required : Yes

          Type : string

          Location : path

      Description : Approves a ChangeRequest.

      Path : v1/{+name}:approve

  • dataplex.projects.locations.changeRequests.delete

      Path : v1/{+name}

      Description : Deletes a ChangeRequest.Behavior depends on the caller's permissions and the resource's state: 1. Callers with dataplex.changeRequests.delete can only delete ChangeRequests in the NEW state. 2. Callers with the dataplex.changeRequests.adminDelete permission can delete ChangeRequests regardless of their state.

      HTTP Method : DELETE

      Parameters :

        name

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

          Description : Required. The name of the ChangeRequest to delete. Format: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}

          Location : path

          Required : Yes

          Type : string

        etag

          Description : Optional. The etag of the ChangeRequest.

          Type : string

          Location : query

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/dataplex.read-write
    • Flat Path : v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}

  • dataplex.projects.locations.changeRequests.reject

      Path : v1/{+name}:reject

      HTTP Method : POST

      Parameters :

        name

          Location : path

          Required : Yes

          Type : string

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

          Description : Required. The name of the ChangeRequest to reject.

      Description : Rejects a ChangeRequest.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}:reject

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/dataplex.read-write
  • dataplex.projects.locations.changeRequests.patch

      Path : v1/{+name}

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/dataplex.read-write
    • Flat Path : v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}

      Description : Updates a ChangeRequest. Only allowed when the state is NEW.

      HTTP Method : PATCH

      Parameters :

        updateMask

          Format : google-fieldmask

          Location : query

          Description : Optional. The list of fields to update.

          Type : string

        name

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

          Description : Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}

          Location : path

          Required : Yes

          Type : string