Cloud Dataplex API (dataplex:v1)

2023-05-06

9 new methods

Additions

    Methods
  • dataplex.projects.locations.entryTypes.setIamPolicy

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:setIamPolicy

      HTTP Method: POST

      Path: v1/{+resource}:setIamPolicy

      Parameter Order: resource

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

      Parameters:

        resource

          Required: Yes

          Location: path

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

          Type: string

          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.

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

  • dataplex.projects.locations.entryTypes.getIamPolicy

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:getIamPolicy

      HTTP Method: GET

      Parameter Order: resource

      Parameters:

        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).

          Type: integer

          Location: query

          Format: int32

        resource

          Type: string

          Required: Yes

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

          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.

          Location: path

      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.

      Path: v1/{+resource}:getIamPolicy

  • dataplex.projects.locations.entryTypes.testIamPermissions

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:testIamPermissions

      Parameter Order: resource

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

      Parameters:

        resource

          Type: string

          Required: Yes

          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.

          Location: path

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

      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.

      Path: v1/{+resource}:testIamPermissions

  • dataplex.projects.locations.entryGroups.setIamPolicy

      Parameters:

        resource

          Required: Yes

          Type: string

          Location: path

          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/[^/]+/entryGroups/[^/]+$

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

      Parameter Order: resource

      HTTP Method: POST

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

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

      Path: v1/{+resource}:setIamPolicy

  • dataplex.projects.locations.entryGroups.getIamPolicy

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

      Parameters:

        options.requestedPolicyVersion

          Type: integer

          Location: query

          Format: int32

          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).

        resource

          Location: path

          Type: string

          Required: Yes

          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/[^/]+/entryGroups/[^/]+$

      Parameter Order: resource

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

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

      HTTP Method: GET

      Path: v1/{+resource}:getIamPolicy

  • dataplex.projects.locations.entryGroups.testIamPermissions

      HTTP Method: POST

      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.

      Parameter Order: resource

      Path: v1/{+resource}:testIamPermissions

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

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

      Parameters:

        resource

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

          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.

          Required: Yes

          Location: path

          Type: string

  • dataplex.projects.locations.aspectTypes.testIamPermissions

      Path: v1/{+resource}:testIamPermissions

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:testIamPermissions

      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.

      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/[^/]+/aspectTypes/[^/]+$

          Location: path

          Type: string

          Required: Yes

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

      HTTP Method: POST

      Parameter Order: resource

  • dataplex.projects.locations.aspectTypes.getIamPolicy

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

      HTTP Method: GET

      Parameters:

        resource

          Location: path

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

          Type: string

          Required: Yes

          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.

        options.requestedPolicyVersion

          Format: int32

          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

      Parameter Order: resource

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

      Path: v1/{+resource}:getIamPolicy

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:getIamPolicy

  • dataplex.projects.locations.aspectTypes.setIamPolicy

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:setIamPolicy

      Path: v1/{+resource}:setIamPolicy

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

      Parameters:

        resource

          Type: string

          Required: Yes

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

          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.

          Location: path

      HTTP Method: POST

      Parameter Order: resource

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

9 removed methods

Deletions

    Methods
  • dataplex.projects.locations.entryTypes.setIamPolicy

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

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:setIamPolicy

      Parameters:

        resource

          Required: Yes

          Location: path

          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/[^/]+/entryTypes/[^/]+$

          Type: string

      HTTP Method: POST

      Parameter Order: resource

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

      Path: v1/{+resource}:setIamPolicy

  • dataplex.projects.locations.entryTypes.getIamPolicy

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

      Parameters:

        options.requestedPolicyVersion

          Format: int32

          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

        resource

          Type: string

          Location: path

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

          Required: Yes

          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.

      Path: v1/{+resource}:getIamPolicy

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

      HTTP Method: GET

      Parameter Order: resource

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:getIamPolicy

  • dataplex.projects.locations.entryTypes.testIamPermissions

      Path: v1/{+resource}:testIamPermissions

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

      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.

          Type: string

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

          Required: Yes

          Location: path

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:testIamPermissions

      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.

      Parameter Order: resource

      HTTP Method: POST

  • dataplex.projects.locations.entryGroups.setIamPolicy

      Path: v1/{+resource}:setIamPolicy

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

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

      HTTP Method: POST

      Parameter Order: resource

      Parameters:

        resource

          Required: Yes

          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.

          Location: path

          Type: string

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

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

      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.

      Parameters:

        resource

          Required: Yes

          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.

          Type: string

          Location: path

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

      Path: v1/{+resource}:testIamPermissions

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

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

      HTTP Method: POST

      Parameter Order: resource

  • dataplex.projects.locations.entryGroups.getIamPolicy

      Path: v1/{+resource}:getIamPolicy

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

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

      Parameter Order: resource

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

      HTTP Method: GET

      Parameters:

        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

        resource

          Location: path

          Type: string

          Required: Yes

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

          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.

  • dataplex.projects.locations.aspectTypes.testIamPermissions

      Path: v1/{+resource}:testIamPermissions

      Parameters:

        resource

          Required: Yes

          Type: string

          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/[^/]+/aspectTypes/[^/]+$

          Location: path

      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.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:testIamPermissions

      Parameter Order: resource

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

      HTTP Method: POST

  • dataplex.projects.locations.aspectTypes.getIamPolicy

      Path: v1/{+resource}:getIamPolicy

      Parameters:

        resource

          Type: string

          Location: path

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

          Required: Yes

          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.

        options.requestedPolicyVersion

          Type: integer

          Location: query

          Format: int32

          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).

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:getIamPolicy

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

      Parameter Order: resource

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

  • dataplex.projects.locations.aspectTypes.setIamPolicy

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:setIamPolicy

      Path: v1/{+resource}:setIamPolicy

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

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

      Parameters:

        resource

          Required: Yes

          Location: path

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

          Type: string

          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.

      Parameter Order: resource