Cloud Dataplex API (dataplex:v1)

2024-07-27

10 new methods

Additions

    Methods
  • dataplex.projects.locations.metadataJobs.create

      Path: v1/{+parent}/metadataJobs

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

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}

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

          Location: path

          Required: Yes

          Type: string

        metadataJobId

          Description: Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.

  • dataplex.projects.locations.metadataJobs.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The resource name of the metadata job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets a metadata job.

  • dataplex.projects.locations.metadataJobs.list

      Path: v1/{+parent}/metadataJobs

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

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}

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

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: Optional. The page token received from a previous ListMetadataJobs call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token.

          Location: query

          Type: string

        filter

          Description: Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"You can combine filters with AND, OR, and NOT operators.

          Location: query

          Type: string

        orderBy

          Description: Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Lists metadata jobs.

  • dataplex.projects.locations.metadataJobs.cancel

      Path: v1/{+name}:cancel

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}:cancel

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The resource name of the job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.

  • dataplex.projects.locations.glossaries.setIamPolicy

      Path: v1/{+resource}:setIamPolicy

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:setIamPolicy

      HTTP Method: POST

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: resource

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

      Description: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

  • dataplex.projects.locations.glossaries.getIamPolicy

      Path: v1/{+resource}:getIamPolicy

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:getIamPolicy

      HTTP Method: GET

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location: path

          Required: Yes

          Type: string

        options.requestedPolicyVersion

          Description: Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

          Location: query

          Type: integer

          Format: int32

      Parameter Order: resource

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

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • dataplex.projects.locations.glossaries.testIamPermissions

      Path: v1/{+resource}:testIamPermissions

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:testIamPermissions

      HTTP Method: POST

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: resource

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

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • dataplex.organizations.locations.encryptionConfigs.setIamPolicy

      Path: v1/{+resource}:setIamPolicy

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:setIamPolicy

      HTTP Method: POST

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: resource

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

      Description: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

  • dataplex.organizations.locations.encryptionConfigs.getIamPolicy

      Path: v1/{+resource}:getIamPolicy

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:getIamPolicy

      HTTP Method: GET

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$

          Location: path

          Required: Yes

          Type: string

        options.requestedPolicyVersion

          Description: Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

          Location: query

          Type: integer

          Format: int32

      Parameter Order: resource

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

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • dataplex.organizations.locations.encryptionConfigs.testIamPermissions

      Path: v1/{+resource}:testIamPermissions

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:testIamPermissions

      HTTP Method: POST

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: resource

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

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

10 removed methods

Deletions

    Methods
  • dataplex.projects.locations.metadataJobs.create

      Path: v1/{+parent}/metadataJobs

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

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}

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

          Location: path

          Required: Yes

          Type: string

        metadataJobId

          Description: Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.

  • dataplex.projects.locations.metadataJobs.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The resource name of the metadata job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets a metadata job.

  • dataplex.projects.locations.metadataJobs.list

      Path: v1/{+parent}/metadataJobs

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

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}

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

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: Optional. The page token received from a previous ListMetadataJobs call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token.

          Location: query

          Type: string

        filter

          Description: Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"You can combine filters with AND, OR, and NOT operators.

          Location: query

          Type: string

        orderBy

          Description: Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Lists metadata jobs.

  • dataplex.projects.locations.metadataJobs.cancel

      Path: v1/{+name}:cancel

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}:cancel

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The resource name of the job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.

  • dataplex.projects.locations.glossaries.setIamPolicy

      Path: v1/{+resource}:setIamPolicy

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:setIamPolicy

      HTTP Method: POST

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: resource

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

      Description: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

  • dataplex.projects.locations.glossaries.getIamPolicy

      Path: v1/{+resource}:getIamPolicy

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:getIamPolicy

      HTTP Method: GET

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location: path

          Required: Yes

          Type: string

        options.requestedPolicyVersion

          Description: Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

          Location: query

          Type: integer

          Format: int32

      Parameter Order: resource

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

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • dataplex.projects.locations.glossaries.testIamPermissions

      Path: v1/{+resource}:testIamPermissions

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:testIamPermissions

      HTTP Method: POST

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: resource

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

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • dataplex.organizations.locations.encryptionConfigs.setIamPolicy

      Path: v1/{+resource}:setIamPolicy

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:setIamPolicy

      HTTP Method: POST

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: resource

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

      Description: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

  • dataplex.organizations.locations.encryptionConfigs.getIamPolicy

      Path: v1/{+resource}:getIamPolicy

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:getIamPolicy

      HTTP Method: GET

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$

          Location: path

          Required: Yes

          Type: string

        options.requestedPolicyVersion

          Description: Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

          Location: query

          Type: integer

          Format: int32

      Parameter Order: resource

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

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • dataplex.organizations.locations.encryptionConfigs.testIamPermissions

      Path: v1/{+resource}:testIamPermissions

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:testIamPermissions

      HTTP Method: POST

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: resource

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

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.