Cloud Dataplex API (dataplex:v1)

2024-08-25

13 new methods

Additions

    Methods
  • dataplex.projects.locations.entryLinkTypes.setIamPolicy

      Path : v1/{+resource}:setIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}: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/[^/]+/entryLinkTypes/[^/]+$

          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.entryLinkTypes.getIamPolicy

      Path : v1/{+resource}:getIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}: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/[^/]+/entryLinkTypes/[^/]+$

          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.entryLinkTypes.testIamPermissions

      Path : v1/{+resource}:testIamPermissions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}: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/[^/]+/entryLinkTypes/[^/]+$

          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.projects.locations.glossaries.categories.setIamPolicy

      Path : v1/{+resource}:setIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}: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/[^/]+/categories/[^/]+$

          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.categories.getIamPolicy

      Path : v1/{+resource}:getIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}: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/[^/]+/categories/[^/]+$

          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.categories.testIamPermissions

      Path : v1/{+resource}:testIamPermissions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}: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/[^/]+/categories/[^/]+$

          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.projects.locations.glossaries.terms.setIamPolicy

      Path : v1/{+resource}:setIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}: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/[^/]+/terms/[^/]+$

          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.terms.getIamPolicy

      Path : v1/{+resource}:getIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}: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/[^/]+/terms/[^/]+$

          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.terms.testIamPermissions

      Path : v1/{+resource}:testIamPermissions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}: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/[^/]+/terms/[^/]+$

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

      Path : v1/{+name}

      Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

      Parameter Order : name

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

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

  • dataplex.organizations.locations.operations.get

      Path : v1/{+name}

      Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation resource.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      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.

  • dataplex.organizations.locations.operations.delete

      Path : v1/{+name}

      Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method : DELETE

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

      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.

  • dataplex.organizations.locations.operations.cancel

      Path : v1/{+name}:cancel

      Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel

      HTTP Method : POST

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      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.