2026-03-12
▼ ▲ dataplex.projects.locations.lakes.contentitems.setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}:setIamPolicy
Parameter Order : resource
Path : v1/{+resource}:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$
Type : string
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
▼ ▲ dataplex.projects.locations.lakes.contentitems.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
filter
Type : string
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.
pageToken
Location : query
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.
parent
Description : Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
pageSize
Format : int32
Location : query
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
Parameter Order : parent
Path : v1/{+parent}/contentitems
HTTP Method : GET
Description : List content.
▼ ▲ dataplex.projects.locations.lakes.contentitems.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a content resource.
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}
Parameters :
name
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$
Description : Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
view
Location : query
Enum :
Description : Optional. Specify content view to make a partial request.
Type : string
Enum Descriptions :
HTTP Method : GET
Path : v1/{+name}
▼ ▲ dataplex.projects.locations.lakes.contentitems.getIamPolicy
Parameters :
resource
Location : path
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
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$
options.requestedPolicyVersion
Format : int32
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).
Path : v1/{+resource}:getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
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
Parameter Order : resource
▼ ▲ dataplex.projects.locations.lakes.contentitems.create
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+parent}/contentitems
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems
Description : Create a content.
Parameters :
parent
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Description : Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
validateOnly
Type : boolean
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Location : query
▼ ▲ dataplex.projects.locations.lakes.contentitems.testIamPermissions
HTTP Method : POST
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.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}:testIamPermissions
Path : v1/{+resource}:testIamPermissions
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
resource
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$
Type : string
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.
▼ ▲ dataplex.projects.locations.lakes.contentitems.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$
Description : Delete a content.
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}
Path : v1/{+name}
▼ ▲ dataplex.projects.locations.lakes.contentitems.patch
Parameter Order : name
Parameters :
updateMask
Format : google-fieldmask
Description : Required. Mask of fields to update.
Type : string
Location : query
name
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}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$
Required : Yes
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Location : query
Type : boolean
HTTP Method : PATCH
Description : Update a content. Only supports full resource update.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}
▼ ▲ dataplex.projects.locations.lakes.environments.patch
Parameter Order : name
Description : Update the environment resource.
Parameters :
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Location : query
Type : boolean
updateMask
Format : google-fieldmask
Location : query
Description : Required. Mask of fields to update.
Type : string
name
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}
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$
Type : string
Location : path
Required : Yes
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}
Path : v1/{+name}
▼ ▲ dataplex.projects.locations.lakes.environments.delete
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}
Description : Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Description : Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$
Type : string
Location : path
Path : v1/{+name}
▼ ▲ dataplex.projects.locations.lakes.environments.list
Parameter Order : parent
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments
Description : Lists environments under the given lake.
Path : v1/{+parent}/environments
Parameters :
orderBy
Description : Optional. Order by fields for the result.
Type : string
Location : query
pageSize
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
Format : int32
filter
Location : query
Type : string
Description : Optional. Filter request.
pageToken
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.
Location : query
Type : string
parent
Type : string
Description : Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Location : path
Required : Yes
▼ ▲ dataplex.projects.locations.lakes.environments.create
Parameter Order : parent
Path : v1/{+parent}/environments
Parameters :
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Type : boolean
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.
environmentId
Type : string
Location : query
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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create an environment resource.
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments
▼ ▲ dataplex.projects.locations.lakes.environments.get
Parameter Order : name
Parameters :
name
Location : path
Description : Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$
Required : Yes
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}
Path : v1/{+name}
Description : Get environment resource.
▼ ▲ dataplex.projects.locations.lakes.environments.sessions.list
Description : Lists session resources in an environment.
Path : v1/{+parent}/sessions
Parameter Order : parent
Parameters :
filter
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
Location : query
pageToken
Type : string
Location : query
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.
pageSize
Type : integer
Location : query
Format : int32
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.
parent
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$
Type : string
Description : Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}/sessions
▼ ▲ dataplex.projects.locations.lakes.content.patch
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}
Description : Update a content. Only supports full resource update.
Parameters :
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Location : query
Type : boolean
updateMask
Description : Required. Mask of fields to update.
Location : query
Type : string
Format : google-fieldmask
name
Location : path
Type : string
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
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
▼ ▲ dataplex.projects.locations.lakes.content.testIamPermissions
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
HTTP Method : POST
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.
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$
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
Type : string
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:testIamPermissions
▼ ▲ dataplex.projects.locations.lakes.content.create
Parameter Order : parent
Parameters :
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is false.
Location : query
Type : boolean
parent
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Type : string
Description : Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a content.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content
HTTP Method : POST
Path : v1/{+parent}/content
▼ ▲ dataplex.projects.locations.lakes.content.setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:setIamPolicy
HTTP Method : POST
Parameter Order : resource
Path : v1/{+resource}:setIamPolicy
Parameters :
resource
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.
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$
Required : Yes
Location : path
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.content.delete
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}
Description : Delete a content.
HTTP Method : DELETE
Parameters :
name
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
Type : string
Parameter Order : name
▼ ▲ dataplex.projects.locations.lakes.content.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content
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.
Location : query
Type : string
parent
Required : Yes
Type : string
Location : path
Description : Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
pageToken
Location : query
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.
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
Format : int32
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/content
Description : List content.
Parameter Order : parent
▼ ▲ dataplex.projects.locations.lakes.content.getIamPolicy
HTTP Method : GET
Parameter Order : resource
Parameters :
options.requestedPolicyVersion
Location : query
Type : integer
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
Type : string
Required : Yes
Location : path
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.
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}/content/{contentId}:getIamPolicy
Path : v1/{+resource}:getIamPolicy
▼ ▲ dataplex.projects.locations.lakes.content.get
HTTP Method : GET
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}
Path : v1/{+name}
Parameters :
view
Type : string
Description : Optional. Specify content view to make a partial request.
Enum :
Enum Descriptions :
Location : query
name
Description : Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a content resource.