2022-02-15
▼ ▲ dataplex.projects.locations.lakes.get
Description: Retrieves a lake resource.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}
HTTP Method: GET
Path: v1/{+name}
Parameters:
name
Description: Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
▼ ▲ dataplex.projects.locations.lakes.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Location: path
Type: string
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
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:testIamPermissions
▼ ▲ dataplex.projects.locations.lakes.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}
Description: Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Description: Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
Required: Yes
Location: path
Type: string
HTTP Method: DELETE
▼ ▲ dataplex.projects.locations.lakes.getIamPolicy
HTTP Method: GET
Parameter Order: resource
Path: v1/{+resource}:getIamPolicy
Parameters:
resource
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Location: path
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
Format: int32
Location: query
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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:getIamPolicy
▼ ▲ dataplex.projects.locations.lakes.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Parameters:
resource
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Required: Yes
Type: string
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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:setIamPolicy
HTTP Method: POST
▼ ▲ dataplex.projects.locations.lakes.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: Lists lake resources in a project and location.
Path: v1/{+parent}/lakes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes
HTTP Method: GET
Parameters:
orderBy
Location: query
Description: Optional. Order by fields for the result.
Type: string
pageToken
Description: Optional. Page token received from a previous ListLakes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakes must match the call that provided the page token.
Location: query
Type: string
filter
Description: Optional. Filter request.
Location: query
Type: string
parent
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
pageSize
Description: Optional. Maximum number of Lakes to return. The service may return fewer than this value. If unspecified, at most 10 lakes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format: int32
Type: integer
Location: query
▼ ▲ dataplex.projects.locations.lakes.create
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes
HTTP Method: POST
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
lakeId
Description: Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
Type: string
Location: query
validateOnly
Location: query
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Type: boolean
Description: Creates a lake resource.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/lakes
Parameter Order: parent
▼ ▲ dataplex.projects.locations.lakes.patch
Description: Updates a lake resource.
Parameters:
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Type: boolean
Location: query
name
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Type: string
Location: path
Description: Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
Required: Yes
updateMask
Type: string
Format: google-fieldmask
Description: Required. Mask of fields to update.
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Parameter Order: name
▼ ▲ dataplex.projects.locations.lakes.actions.list
Description: Lists action resources in a lake.
HTTP Method: GET
Path: v1/{+parent}/actions
Parameters:
pageToken
Description: Optional. Page token received from a previous ListLakeActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakeActions must match the call that provided the page token.
Type: string
Location: query
parent
Description: Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Required: Yes
pageSize
Location: query
Description: Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Type: integer
Format: int32
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/actions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ dataplex.projects.locations.lakes.content.testIamPermissions
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Path: v1/{+resource}:testIamPermissions
Parameters:
resource
Location: path
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:testIamPermissions
▼ ▲ dataplex.projects.locations.lakes.content.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
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
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/[^/]+$
Required: Yes
Location: path
Type: string
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
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:getIamPolicy
▼ ▲ dataplex.projects.locations.lakes.content.setIamPolicy
HTTP Method: POST
Path: v1/{+resource}:setIamPolicy
Parameters:
resource
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:setIamPolicy
Parameter Order: resource
▼ ▲ dataplex.projects.locations.lakes.zones.setIamPolicy
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Location: path
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$
Required: Yes
HTTP Method: POST
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.lakes.zones.patch
Parameter Order: name
Description: Updates a zone resource.
HTTP Method: PATCH
Parameters:
updateMask
Location: query
Description: Required. Mask of fields to update.
Format: google-fieldmask
Type: string
name
Description: Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$
Type: string
Required: Yes
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Type: boolean
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}
Path: v1/{+name}
▼ ▲ dataplex.projects.locations.lakes.zones.delete
Path: v1/{+name}
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$
Type: string
Description: Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}`
Required: Yes
HTTP Method: DELETE
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}
Description: Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.
▼ ▲ dataplex.projects.locations.lakes.zones.create
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones
Path: v1/{+parent}/zones
Description: Creates a zone resource within a lake.
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Location: path
Description: Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
Required: Yes
Type: string
zoneId
Location: query
Type: string
Description: Required. Zone identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique across all lakes from all locations in a project. * Must not be one of the reserved IDs (i.e. "default", "global-temp")
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Type: boolean
Location: query
HTTP Method: POST
▼ ▲ dataplex.projects.locations.lakes.zones.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/zones
Parameter Order: parent
Parameters:
orderBy
Description: Optional. Order by fields for the result.
Type: string
Location: query
pageToken
Description: Optional. Page token received from a previous ListZones call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZones must match the call that provided the page token.
Location: query
Type: string
parent
Location: path
Required: Yes
Description: Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Type: string
pageSize
Location: query
Description: Optional. Maximum number of zones to return. The service may return fewer than this value. If unspecified, at most 10 zones will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format: int32
Type: integer
filter
Location: query
Description: Optional. Filter request.
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones
HTTP Method: GET
Description: Lists zone resources in a lake.
▼ ▲ dataplex.projects.locations.lakes.zones.testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Location: path
Type: string
Required: Yes
Path: v1/{+resource}: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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}:testIamPermissions
HTTP Method: POST
Parameter Order: resource
▼ ▲ dataplex.projects.locations.lakes.zones.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Parameters:
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$
Location: path
Type: string
options.requestedPolicyVersion
Location: query
Format: int32
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).
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
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
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}:getIamPolicy
▼ ▲ dataplex.projects.locations.lakes.zones.get
Path: v1/{+name}
Description: Retrieves a zone resource.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}
HTTP Method: GET
Parameters:
name
Required: Yes
Location: path
Description: Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ dataplex.projects.locations.lakes.zones.assets.actions.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}/actions
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$
Location: path
Required: Yes
Description: Required. The resource name of the parent asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}
pageSize
Description: Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format: int32
Type: integer
Location: query
pageToken
Type: string
Description: Optional. Page token received from a previous ListAssetActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssetActions must match the call that provided the page token.
Location: query
Path: v1/{+parent}/actions
Parameter Order: parent
Description: Lists action resources in an asset.
HTTP Method: GET
▼ ▲ dataplex.projects.locations.lakes.zones.assets.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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}:setIamPolicy
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameter Order: resource
Path: v1/{+resource}:setIamPolicy
▼ ▲ dataplex.projects.locations.lakes.zones.assets.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Format: int32
Type: integer
Description: Optional. Maximum number of asset to return. The service may return fewer than this value. If unspecified, at most 10 assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
parent
Required: Yes
Description: Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$
Type: string
orderBy
Description: Optional. Order by fields for the result.
Location: query
Type: string
filter
Description: Optional. Filter request.
Type: string
Location: query
pageToken
Location: query
Type: string
Description: Optional. Page token received from a previous ListAssets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssets must match the call that provided the page token.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets
HTTP Method: GET
Path: v1/{+parent}/assets
Description: Lists asset resources in a zone.
Parameter Order: parent
▼ ▲ dataplex.projects.locations.lakes.zones.assets.getIamPolicy
Parameters:
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
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$
Location: path
Type: string
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
Path: v1/{+resource}:getIamPolicy
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}:getIamPolicy
HTTP Method: GET
▼ ▲ dataplex.projects.locations.lakes.zones.assets.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}
Description: Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.
HTTP Method: DELETE
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$
Type: string
Description: Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}/assets/{asset_id}
Location: path
Required: Yes
Path: v1/{+name}
▼ ▲ dataplex.projects.locations.lakes.zones.assets.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$
Description: Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}/assets/{asset_id}
Required: Yes
Type: string
Description: Retrieves an asset resource.
Parameter Order: name
▼ ▲ dataplex.projects.locations.lakes.zones.assets.testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Path: v1/{+resource}:testIamPermissions
Parameter Order: resource
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
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}:testIamPermissions
▼ ▲ dataplex.projects.locations.lakes.zones.assets.create
Parameter Order: parent
Parameters:
assetId
Description: Required. Asset identifier. This ID will be used to generate names such as table names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the zone.
Type: string
Location: query
validateOnly
Location: query
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Type: boolean
parent
Type: string
Description: Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$
Required: Yes
Location: path
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets
Path: v1/{+parent}/assets
Description: Creates an asset resource.
▼ ▲ dataplex.projects.locations.lakes.zones.assets.patch
Parameter Order: name
Path: v1/{+name}
Description: Updates an asset resource.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}
Parameters:
updateMask
Description: Required. Mask of fields to update.
Location: query
Format: google-fieldmask
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$
Description: Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.
Type: string
Required: Yes
Location: path
validateOnly
Type: boolean
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
▼ ▲ dataplex.projects.locations.lakes.zones.entities.partitions.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}/partitions/{partitionsId}
Parameter Order: name
Parameters:
name
Type: string
Description: Required. The resource name of the partition: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_value_path}. The {partition_value_path} segment consists of an ordered sequence of partition values separated by "/". All values must be provided.
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+/partitions/.*$
Location: path
Required: Yes
HTTP Method: GET
Description: Get a metadata partition of an entity.
Path: v1/{+name}
▼ ▲ dataplex.projects.locations.lakes.zones.entities.partitions.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Create a metadata partition.
Parameters:
parent
Type: string
Required: Yes
Description: Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+$
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Type: boolean
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}/partitions
HTTP Method: POST
Path: v1/{+parent}/partitions
▼ ▲ dataplex.projects.locations.lakes.zones.entities.partitions.list
Description: List metadata partitions of an entity.
Parameter Order: parent
HTTP Method: GET
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
pageToken
Description: Optional. Page token received from a previous ListPartitions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartitions must match the call that provided the page token.
Location: query
Type: string
pageSize
Location: query
Description: Optional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500.
Format: int32
Type: integer
filter
Type: string
Description: Optional. Filter the partitions returned to the caller using a key vslue pair expression. The filter expression supports: logical operators: AND, OR comparison operators: <, >, >=, <= ,=, != LIKE operators: The right hand of a LIKE operator supports “.” and “*” for wildcard searches, for example "value1 LIKE ".*oo.*" parenthetical grouping: ( )Sample filter expression: `?filter="key1 < value1 OR key2 > value2"Notes: Keys to the left of operators are case insensitive. Partition results are sorted first by creation time, then by lexicographic order. Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}/partitions
Path: v1/{+parent}/partitions
▼ ▲ dataplex.projects.locations.lakes.zones.entities.partitions.delete
Parameter Order: name
Description: Delete a metadata partition.
Parameters:
etag
Type: string
Location: query
Description: Optional. The etag associated with the partition if it was previously retrieved.
name
Description: Required. The resource name of the partition. format: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_value_path}. The {partition_value_path} segment consists of an ordered sequence of partition values separated by "/". All values must be provided.
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+/partitions/.*$
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}/partitions/{partitionsId}
▼ ▲ dataplex.projects.locations.lakes.zones.entities.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Get a metadata entity.
Parameter Order: name
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+$
Required: Yes
Type: string
Description: Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
view
Enum:
Location: query
Enum Descriptions:
Description: Optional. Used to select the subset of entity information to return. Defaults to BASIC.
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}
Path: v1/{+name}
▼ ▲ dataplex.projects.locations.lakes.zones.entities.list
Description: List metadata entities in a zone.
Path: v1/{+parent}/entities
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities
HTTP Method: GET
Parameters:
filter
Description: Optional. The following filter parameters can be added to the URL to limit the entities returned by the API: Entity ID: ?filter="id=entityID" Asset ID: ?filter="asset=assetID" Data path ?filter="data_path=gs://my-bucket" Is HIVE compatible: ?filter=”hive_compatible=true” Is BigQuery compatible: ?filter=”bigquery_compatible=true”
Type: string
Location: query
parent
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$
Required: Yes
Description: Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
pageSize
Type: integer
Description: Optional. Maximum number of entities to return. The service may return fewer than this value. If unspecified, 100 entities will be returned by default. The maximum value is 500; larger values will will be truncated to 500.
Location: query
Format: int32
pageToken
Location: query
Type: string
Description: Optional. Page token received from a previous ListEntities call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntities must match the call that provided the page token.
view
Description: Required. Specify the entity view to make a partial list request.
Type: string
Enum:
Enum Descriptions:
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ dataplex.projects.locations.lakes.zones.entities.create
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities
Path: v1/{+parent}/entities
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$
Location: path
Description: Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
Type: string
Required: Yes
validateOnly
Type: boolean
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Description: Create a metadata entity.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ dataplex.projects.locations.lakes.zones.entities.update
Description: Update a metadata entity. Only supports full resource update.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}
Parameters:
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Type: boolean
name
Location: path
Required: Yes
Description: Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+$
Type: string
HTTP Method: PUT
▼ ▲ dataplex.projects.locations.lakes.zones.entities.delete
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+$
Description: Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
Location: path
Required: Yes
etag
Location: query
Description: Required. The etag associated with the partition if it was previously retrieved.
Type: string
Description: Delete a metadata entity.
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}
Parameter Order: name
▼ ▲ dataplex.projects.locations.lakes.zones.actions.list
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/actions
Path: v1/{+parent}/actions
Parameter Order: parent
Parameters:
pageSize
Location: query
Format: int32
Type: integer
Description: Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
Location: query
Description: Optional. Page token received from a previous ListZoneActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZoneActions must match the call that provided the page token.
Type: string
parent
Description: Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$
Location: path
Description: Lists action resources in a zone.
▼ ▲ dataplex.projects.locations.lakes.tasks.jobs.get
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}/jobs/{jobsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+name}
Description: Get job resource.
Parameters:
name
Required: Yes
Description: Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /tasks/{task_id}/jobs/{job_id}
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+/jobs/[^/]+$
▼ ▲ dataplex.projects.locations.lakes.tasks.jobs.cancel
Parameter Order: name
Path: v1/{+name}:cancel
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Description: Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /task/{task_id}/job/{job_id}`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+/jobs/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}/jobs/{jobsId}:cancel
Description: Cancel jobs running for the task resource.
▼ ▲ dataplex.projects.locations.lakes.tasks.jobs.list
Parameters:
parent
Description: Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$
Location: path
Type: string
Required: Yes
pageToken
Location: query
Description: Optional. Page token received from a previous ListJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListJobs must match the call that provided the page token.
Type: string
pageSize
Description: Optional. Maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 10 jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Format: int32
Type: integer
HTTP Method: GET
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/jobs
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}/jobs
Description: Lists Jobs under the given task.
▼ ▲ dataplex.projects.locations.lakes.tasks.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}
Parameter Order: name
Description: Delete the task resource.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameters:
name
Description: Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /task/{task_id}`
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$
Required: Yes
HTTP Method: DELETE
▼ ▲ dataplex.projects.locations.lakes.tasks.create
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks
Description: Creates a task resource within a lake.
HTTP Method: POST
Parameters:
parent
Description: Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
taskId
Description: Required. Task identifier.
Type: string
Location: query
validateOnly
Type: boolean
Location: query
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Path: v1/{+parent}/tasks
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ dataplex.projects.locations.lakes.tasks.setIamPolicy
Parameters:
resource
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$
Location: path
Path: v1/{+resource}:setIamPolicy
Parameter Order: resource
HTTP Method: POST
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
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:setIamPolicy
▼ ▲ dataplex.projects.locations.lakes.tasks.getIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$
Location: path
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Type: string
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
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:getIamPolicy
Path: v1/{+resource}:getIamPolicy
▼ ▲ dataplex.projects.locations.lakes.tasks.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: GET
Path: v1/{+parent}/tasks
Parameters:
filter
Type: string
Location: query
Description: Optional. Filter request.
pageToken
Location: query
Type: string
Description: Optional. Page token received from a previous ListZones call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZones must match the call that provided the page token.
parent
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Description: Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
Location: path
Type: string
Required: Yes
pageSize
Description: Optional. Maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
orderBy
Description: Optional. Order by fields for the result.
Type: string
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks
Description: Lists tasks under the given lake.
▼ ▲ dataplex.projects.locations.lakes.tasks.get
Path: v1/{+name}
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Get task resource.
Parameters:
name
Description: Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /tasks/{tasks_id}
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$
Required: Yes
HTTP Method: GET
▼ ▲ dataplex.projects.locations.lakes.tasks.testIamPermissions
Path: v1/{+resource}:testIamPermissions
HTTP Method: POST
Parameter Order: resource
Parameters:
resource
Location: path
Type: string
Required: Yes
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$
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}/lakes/{lakesId}/tasks/{tasksId}:testIamPermissions
▼ ▲ dataplex.projects.locations.lakes.tasks.patch
Parameters:
updateMask
Type: string
Location: query
Description: Required. Mask of fields to update.
Format: google-fieldmask
validateOnly
Location: query
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Type: boolean
name
Description: Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Update the task resource.
Path: v1/{+name}
Parameter Order: name
HTTP Method: PATCH
▼ ▲ dataplex.projects.locations.lakes.contentitems.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}
Description: Update a content. Only supports full resource update.
Parameters:
updateMask
Type: string
Format: google-fieldmask
Description: Required. Mask of fields to update.
Location: query
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/[^/]+/contentitems/.*$
Location: path
Required: Yes
Type: string
validateOnly
Location: query
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Type: boolean
Path: v1/{+name}
▼ ▲ dataplex.projects.locations.lakes.contentitems.create
Path: v1/{+parent}/contentitems
Parameter Order: parent
Description: Create a content.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems
Parameters:
validateOnly
Location: query
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Type: boolean
parent
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Description: Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ dataplex.projects.locations.lakes.contentitems.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}
HTTP Method: GET
Parameters:
name
Required: Yes
Location: path
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/[^/]+/contentitems/.*$
view
Type: string
Enum:
Description: Optional. Specify content view to make a partial request.
Location: query
Enum Descriptions:
Description: Get a content resource.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}
▼ ▲ dataplex.projects.locations.lakes.contentitems.list
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.
Location: query
Type: integer
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.
Location: query
Type: string
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
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+$
Required: Yes
Location: path
Description: Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
Type: string
Path: v1/{+parent}/contentitems
HTTP Method: GET
Description: List content.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems
▼ ▲ dataplex.projects.locations.lakes.contentitems.delete
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/[^/]+/contentitems/.*$
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Description: Delete a content.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}
HTTP Method: DELETE
▼ ▲ dataplex.projects.locations.lakes.environments.sessions.list
Description: Lists session resources in an environment.
Parameters:
pageSize
Type: integer
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.
Location: query
Format: int32
parent
Type: string
Location: path
Description: Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$
Required: Yes
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
Parameter Order: parent
Path: v1/{+parent}/sessions
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}/sessions
▼ ▲ dataplex.projects.locations.lakes.environments.getIamPolicy
Parameters:
options.requestedPolicyVersion
Format: int32
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).
Location: query
resource
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$
Required: Yes
HTTP Method: GET
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}: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.
Path: v1/{+resource}:getIamPolicy
▼ ▲ dataplex.projects.locations.lakes.environments.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/environments
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments
Description: Create an environment resource.
HTTP Method: POST
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
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/[^/]+$
Required: Yes
Location: path
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Type: boolean
▼ ▲ dataplex.projects.locations.lakes.environments.list
Parameter Order: parent
Parameters:
pageToken
Location: query
Type: string
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.
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.
Location: query
Format: int32
Type: integer
filter
Description: Optional. Filter request.
Location: query
Type: string
parent
Location: path
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}
orderBy
Description: Optional. Order by fields for the result.
Type: string
Location: query
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
▼ ▲ dataplex.projects.locations.lakes.environments.setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:setIamPolicy
Parameters:
resource
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$
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.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:setIamPolicy
▼ ▲ dataplex.projects.locations.lakes.environments.get
Description: Get environment resource.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}
Parameter Order: name
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}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$
Type: string
▼ ▲ dataplex.projects.locations.lakes.environments.delete
Path: v1/{+name}
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.
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
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
Required: Yes
Parameter Order: name
▼ ▲ dataplex.projects.locations.lakes.environments.testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}: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
Pattern: ^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$
Location: path
Type: string
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Required: Yes
Parameter Order: resource
Path: v1/{+resource}:testIamPermissions
▼ ▲ dataplex.projects.locations.lakes.environments.patch
Path: v1/{+name}
Parameter Order: name
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
Type: string
Description: Required. Mask of fields to update.
name
Required: Yes
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
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}
HTTP Method: PATCH
Description: Update the environment resource.
▼ ▲ dataplex.projects.locations.operations.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
Parameters:
filter
Type: string
Description: The standard list filter.
Location: query
pageSize
Type: integer
Description: The standard list page size.
Format: int32
Location: query
pageToken
Type: string
Description: The standard list page token.
Location: query
name
Type: string
Required: Yes
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Path: v1/{+name}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: name
▼ ▲ dataplex.projects.locations.operations.delete
HTTP Method: DELETE
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Description: The name of the operation resource to be deleted.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ dataplex.projects.locations.operations.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameter Order: name
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Location: path
Description: The name of the operation resource.
Required: Yes
HTTP Method: GET
Path: v1/{+name}
▼ ▲ dataplex.projects.locations.operations.cancel
Parameters:
name
Type: string
Location: path
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
HTTP Method: POST
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Parameter Order: name
Path: v1/{+name}:cancel
▼ ▲ dataplex.projects.locations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations
Path: v1/{+name}/locations
Description: Lists information about the supported locations for this service.
Parameters:
filter
Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
Type: string
Location: query
pageSize
Type: integer
Location: query
Format: int32
Description: The maximum number of results to return. If not set, the service selects a default.
name
Pattern: ^projects/[^/]+$
Type: string
Location: path
Description: The resource that owns the locations collection, if applicable.
Required: Yes
pageToken
Type: string
Location: query
Description: A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
Parameter Order: name
▼ ▲ dataplex.projects.locations.get
Description: Gets information about a location.
Parameters:
name
Type: string
Required: Yes
Description: Resource name for the location.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
Path: v1/{+name}