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