Cloud Dataplex API (dataplex:v1)

2022-06-11

8 new methods | 3 updated methods

Additions

    Methods
  • dataplex.projects.locations.lakes.content.list

      Parameters :

        filter

          Location : query

          Description : Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = "value1" labels:key1 type = "NOTEBOOK" type = "SQL_SCRIPT"These restrictions can be coinjoined with AND, OR and NOT conjunctions.

          Type : string

        pageToken

          Type : string

          Description : Optional. Page token received from a previous ListContent call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListContent must match the call that provided the page token.

          Location : query

        parent

          Description : Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}

          Type : string

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

          Location : path

          Required : Yes

        pageSize

          Location : query

          Type : integer

          Description : Optional. Maximum number of content to return. The service may return fewer than this value. If unspecified, at most 10 content will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Format : int32

      Parameter Order : parent

      Path : v1/{+parent}/content

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content

      HTTP Method : GET

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

      Description : List content.

  • dataplex.projects.locations.lakes.content.patch

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}

      Path : v1/{+name}

      HTTP Method : PATCH

      Description : Update a content. Only supports full resource update.

      Parameter Order : name

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

      Parameters :

        updateMask

          Format : google-fieldmask

          Type : string

          Location : query

          Description : Required. Mask of fields to update.

        name

          Type : string

          Location : path

          Description : Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}

          Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$

          Required : Yes

        validateOnly

          Description : Optional. Only validate the request, but do not perform mutations. The default is false.

          Location : query

          Type : boolean

  • dataplex.projects.locations.lakes.content.create

      Parameter Order : parent

      Path : v1/{+parent}/content

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content

      Parameters :

        parent

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

          Location : path

          Description : Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}

          Required : Yes

          Type : string

        validateOnly

          Description : Optional. Only validate the request, but do not perform mutations. The default is false.

          Location : query

          Type : boolean

      HTTP Method : POST

      Description : Create a content.

  • dataplex.projects.locations.lakes.content.get

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}

      Parameter Order : name

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

      Description : Get a content resource.

      Path : v1/{+name}

      Parameters :

        name

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$

          Description : Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}

          Location : path

          Required : Yes

        view

          Description : Optional. Specify content view to make a partial request.

          Enum :

        • CONTENT_VIEW_UNSPECIFIED
        • BASIC
        • FULL
        • Enum Descriptions :

        • Content view not specified. Defaults to BASIC. The API will default to the BASIC view.
        • Will not return the data_text field.
        • Returns the complete proto.
        • Location : query

          Type : string

  • dataplex.projects.locations.lakes.content.delete

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

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}

      Parameter Order : name

      Parameters :

        name

          Location : path

          Required : Yes

          Type : string

          Description : Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}

          Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$

      HTTP Method : DELETE

      Description : Delete a content.

  • dataplex.projects.locations.lakes.contentitems.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.

          Type : string

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$

          Required : Yes

      Description : Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).A caller is not required to have Google IAM permission to make this request.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.

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

      Path : v1/{+resource}:testIamPermissions

      Parameter Order : resource

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}:testIamPermissions

  • dataplex.projects.locations.lakes.contentitems.getIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}:getIamPolicy

      Parameter Order : resource

      Description : Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.

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

      Path : v1/{+resource}:getIamPolicy

      Parameters :

        resource

          Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$

          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.

        options.requestedPolicyVersion

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

          Type : integer

      HTTP Method : GET

  • dataplex.projects.locations.lakes.contentitems.setIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}:setIamPolicy

      Parameter Order : resource

      HTTP Method : POST

      Description : Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.

      Path : v1/{+resource}:setIamPolicy

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

      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.

          Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$

          Location : path

          Type : string

Updates

    Methods
  • dataplex.projects.locations.lakes.content.setIamPolicy

      Parameters :

        resource

          Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/[^/]+$  ⟶  ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$

  • dataplex.projects.locations.lakes.content.testIamPermissions

      Parameters :

        resource

          Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/[^/]+$  ⟶  ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$

  • dataplex.projects.locations.lakes.content.getIamPolicy

      Parameters :

        resource

          Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/[^/]+$  ⟶  ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$