Cloud Dataplex API (dataplex:v1)

▼ ▲ dataplex.projects.locations.lookupContext

Path : v1/{+name}:lookupContext

Parameters :

name

Location : path

Type : string

Required : Yes

Description : Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.

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

Parameter Order : name

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/dataplex.read-write
• https://www.googleapis.com/auth/dataplex.readonly

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

Description : Looks up LLM Context for the specified resources.

HTTP Method : POST

▼ ▲ dataplex.projects.locations.lakes.environments.get

HTTP Method : GET

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

Parameter Order : name

Parameters :

name

Location : path

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

Type : string

Description : Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}.

Required : Yes

Description : Get environment resource.

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

Path : v1/{+name}

▼ ▲ dataplex.projects.locations.lakes.environments.list

Parameters :

pageSize

Format : int32

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

Type : integer

Location : query

orderBy

Type : string

Location : query

Description : Optional. Order by fields for the result.

filter

Type : string

Location : query

Description : Optional. Filter request.

pageToken

Location : query

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

Type : string

parent

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

Type : string

Required : Yes

Location : path

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

Description : Lists environments under the given lake.

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

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

Path : v1/{+parent}/environments

HTTP Method : GET

Parameter Order : parent

▼ ▲ dataplex.projects.locations.lakes.environments.create

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

HTTP Method : POST

Parameter Order : parent

Path : v1/{+parent}/environments

Parameters :

environmentId

Type : string

Description : Required. Environment identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the lake.

Location : query

validateOnly

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

Location : query

Type : boolean

parent

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

Required : Yes

Type : string

Location : path

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

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

Description : Create an environment resource.

▼ ▲ dataplex.projects.locations.lakes.environments.patch

HTTP Method : PATCH

Parameter Order : name

Path : v1/{+name}

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

Parameters :

validateOnly

Location : query

Type : boolean

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

updateMask

Description : Required. Mask of fields to update.

Format : google-fieldmask

Location : query

Type : string

name

Location : path

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

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

Type : string

Required : Yes

Description : Update the environment resource.

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

▼ ▲ dataplex.projects.locations.lakes.environments.delete

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

Description : Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.

HTTP Method : DELETE

Parameters :

name

Type : string

Description : Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}.

Required : Yes

Location : path

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

Parameter Order : name

Path : v1/{+name}

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

▼ ▲ dataplex.projects.locations.lakes.environments.sessions.list

Path : v1/{+parent}/sessions

Description : Lists session resources in an environment.

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

Parameter Order : parent

Parameters :

pageSize

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

Type : integer

Format : int32

Location : query

filter

Location : query

Type : string

Description : Optional. Filter request. The following mode filter is supported to return only the sessions belonging to the requester when the mode is USER and return sessions of all the users when the mode is ADMIN. When no filter is sent default to USER mode. NOTE: When the mode is ADMIN, the requester should have dataplex.environments.listAllSessions permission to list all sessions, in absence of the permission, the request fails.mode = ADMIN | USER

pageToken

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

Location : query

Type : string

parent

Description : Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.

Location : path

Type : string

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

Required : Yes

HTTP Method : GET

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}/sessions

▼ ▲ dataplex.projects.locations.lakes.contentitems.setIamPolicy

Parameters :

resource

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

Required : Yes

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.

Location : path

HTTP Method : POST

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

Path : v1/{+resource}:setIamPolicy

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

Parameter Order : resource

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.

▼ ▲ dataplex.projects.locations.lakes.contentitems.patch

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

HTTP Method : PATCH

Path : v1/{+name}

Parameters :

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/[^/]+/contentitems/.*$

Required : Yes

updateMask

Type : string

Location : query

Description : Required. Mask of fields to update.

Format : google-fieldmask

validateOnly

Location : query

Type : boolean

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

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

Parameter Order : name

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

▼ ▲ dataplex.projects.locations.lakes.contentitems.getIamPolicy

Parameter Order : resource

Path : v1/{+resource}:getIamPolicy

Parameters :

options.requestedPolicyVersion

Location : query

Type : integer

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

Format : int32

resource

Location : path

Type : string

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.

Required : Yes

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

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.

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

HTTP Method : GET

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

▼ ▲ dataplex.projects.locations.lakes.contentitems.testIamPermissions

Parameters :

resource

Type : string

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

Location : path

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

Path : v1/{+resource}:testIamPermissions

Parameter Order : resource

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

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

HTTP Method : POST

▼ ▲ dataplex.projects.locations.lakes.contentitems.list

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

HTTP Method : GET

Parameters :

filter

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

Location : query

pageSize

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.

Type : integer

Location : query

Format : int32

parent

Type : string

Location : path

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

Required : Yes

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

pageToken

Location : query

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.

Type : string

Parameter Order : parent

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

Path : v1/{+parent}/contentitems

Description : List content.

▼ ▲ dataplex.projects.locations.lakes.contentitems.get

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

Parameters :

view

Location : query

Type : string

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

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.

Enum :

• CONTENT_VIEW_UNSPECIFIED
• BASIC
• FULL

name

Required : Yes

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

Type : string

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

Location : path

Parameter Order : name

Description : Get a content resource.

Path : v1/{+name}

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

HTTP Method : GET

▼ ▲ dataplex.projects.locations.lakes.contentitems.create

HTTP Method : POST

Description : Create a content.

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

Path : v1/{+parent}/contentitems

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

Parameter Order : parent

Parameters :

parent

Type : string

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

Required : Yes

Location : path

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

validateOnly

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

Type : boolean

Location : query

▼ ▲ dataplex.projects.locations.lakes.contentitems.delete

Parameters :

name

Required : Yes

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

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

Location : path

Type : string

Path : v1/{+name}

HTTP Method : DELETE

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

Description : Delete a content.

Parameter Order : name

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

▼ ▲ dataplex.projects.locations.lakes.content.patch

HTTP Method : PATCH

Path : v1/{+name}

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

Parameter Order : name

Parameters :

validateOnly

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

Type : boolean

Location : query

updateMask

Description : Required. Mask of fields to update.

Location : query

Type : string

Format : google-fieldmask

name

Required : Yes

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/.*$

Type : string

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

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

▼ ▲ dataplex.projects.locations.lakes.content.list

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

HTTP Method : GET

Parameter Order : parent

Description : List content.

Parameters :

pageSize

Format : int32

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.

Type : integer

Location : query

parent

Type : string

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

Required : Yes

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

Location : path

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

filter

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

Location : query

Path : v1/{+parent}/content

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

▼ ▲ dataplex.projects.locations.lakes.content.testIamPermissions

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.

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

Location : path

Parameter Order : resource

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

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.

Path : v1/{+resource}:testIamPermissions

HTTP Method : POST

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

▼ ▲ dataplex.projects.locations.lakes.content.getIamPolicy

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.

HTTP Method : GET

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

Parameters :

resource

Location : path

Type : string

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

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.

Required : Yes

options.requestedPolicyVersion

Type : integer

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

Format : int32

Location : query

Parameter Order : resource

Path : v1/{+resource}:getIamPolicy

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

▼ ▲ dataplex.projects.locations.lakes.content.get

Path : v1/{+name}

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

HTTP Method : GET

Parameter Order : name

Parameters :

name

Required : Yes

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/.*$

Type : string

Location : path

view

Enum :

• CONTENT_VIEW_UNSPECIFIED
• BASIC
• FULL

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

Location : query

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.

Type : string

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

Description : Get a content resource.

▼ ▲ dataplex.projects.locations.lakes.content.setIamPolicy

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.

Type : string

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

Required : Yes

Location : path

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

Parameter Order : resource

Path : v1/{+resource}:setIamPolicy

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

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.

HTTP Method : POST

▼ ▲ dataplex.projects.locations.lakes.content.create

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

HTTP Method : POST

Parameters :

validateOnly

Type : boolean

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

Location : query

parent

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

Type : string

Required : Yes

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

Location : path

Path : v1/{+parent}/content

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

Parameter Order : parent

Description : Create a content.

▼ ▲ dataplex.projects.locations.lakes.content.delete

Path : v1/{+name}

Parameters :

name

Location : path

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}

Type : string

Required : Yes

Parameter Order : name

Description : Delete a content.

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

HTTP Method : DELETE

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