2024-03-15
▼ ▲ dataplex.projects.locations.lookupEntry
Path: v1/{+name}:lookupEntry
Flat Path: v1/projects/{projectsId}/locations/{locationsId}:lookupEntry
HTTP Method: GET
Parameters:
name
Description: Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
view
Description: Optional. View for controlling which parts of an entry are to be returned.
Location: query
Type: string
Enum Descriptions:
Enum:
aspectTypes
Description: Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected.
Location: query
Repeated: Yes
Type: string
paths
Description: Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected.
Location: query
Repeated: Yes
Type: string
entry
Description: Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Looks up a single entry.
▼ ▲ dataplex.projects.locations.searchEntries
Path: v1/{+name}:searchEntries
Flat Path: v1/projects/{projectsId}/locations/{locationsId}:searchEntries
HTTP Method: POST
Parameters:
name
Description: Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
query
Description: Required. The query against which entries in scope should be matched.
Location: query
Type: string
pageSize
Description: Optional. Pagination.
Location: query
Type: integer
Format: int32
pageToken
Location: query
Type: string
orderBy
Description: Optional. Ordering of the results. Supported options to be added later.
Location: query
Type: string
scope
Description: Optional. The scope under which the search should be operating. Should either be organizations/ or projects/. If left unspecified, it will default to the organization where the project provided in name is located.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Searches for entries matching given query and scope.
▼ ▲ dataplex.projects.locations.entryTypes.create
Path: v1/{+parent}/entryTypes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryTypes
HTTP Method: POST
Parameters:
parent
Description: Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
entryTypeId
Description: Required. EntryType identifier.
Location: query
Type: string
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates an EntryType
▼ ▲ dataplex.projects.locations.entryTypes.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Mask of fields to update.
Location: query
Type: string
Format: google-fieldmask
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a EntryType resource.
▼ ▲ dataplex.projects.locations.entryTypes.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$
Location: path
Required: Yes
Type: string
etag
Description: Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a EntryType resource.
▼ ▲ dataplex.projects.locations.entryTypes.list
Path: v1/{+parent}/entryTypes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryTypes
HTTP Method: GET
Parameters:
parent
Description: Required. The resource name of the EntryType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, at most 10 EntryTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryTypes 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 name = "value" These restrictions can be coinjoined with AND, OR and NOT conjunctions.
Location: query
Type: string
orderBy
Description: Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists EntryType resources in a project and location.
▼ ▲ dataplex.projects.locations.entryTypes.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Retrieves a EntryType resource.
▼ ▲ dataplex.projects.locations.aspectTypes.create
Path: v1/{+parent}/aspectTypes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/aspectTypes
HTTP Method: POST
Parameters:
parent
Description: Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
aspectTypeId
Description: Required. AspectType identifier.
Location: query
Type: string
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates an AspectType
▼ ▲ dataplex.projects.locations.aspectTypes.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Mask of fields to update.
Location: query
Type: string
Format: google-fieldmask
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a AspectType resource.
▼ ▲ dataplex.projects.locations.aspectTypes.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$
Location: path
Required: Yes
Type: string
etag
Description: Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a AspectType resource.
▼ ▲ dataplex.projects.locations.aspectTypes.list
Path: v1/{+parent}/aspectTypes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/aspectTypes
HTTP Method: GET
Parameters:
parent
Description: Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, at most 10 AspectTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAspectTypes 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 name = "value" These restrictions can be coinjoined with AND, OR and NOT conjunctions.
Location: query
Type: string
orderBy
Description: Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists AspectType resources in a project and location.
▼ ▲ dataplex.projects.locations.aspectTypes.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Retrieves a AspectType resource.
▼ ▲ dataplex.projects.locations.entryGroups.create
Path: v1/{+parent}/entryGroups
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryGroups
HTTP Method: POST
Parameters:
parent
Description: Required. The resource name of the entryGroup, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
entryGroupId
Description: Required. EntryGroup identifier.
Location: query
Type: string
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates an EntryGroup
▼ ▲ dataplex.projects.locations.entryGroups.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Mask of fields to update.
Location: query
Type: string
Format: google-fieldmask
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is false.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a EntryGroup resource.
▼ ▲ dataplex.projects.locations.entryGroups.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Location: path
Required: Yes
Type: string
etag
Description: Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a EntryGroup resource.
▼ ▲ dataplex.projects.locations.entryGroups.list
Path: v1/{+parent}/entryGroups
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryGroups
HTTP Method: GET
Parameters:
parent
Description: Required. The resource name of the entryGroup location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, at most 10 EntryGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryGroups must match the call that provided the page token.
Location: query
Type: string
filter
Description: Optional. Filter request.
Location: query
Type: string
orderBy
Description: Optional. Order by fields for the result.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists EntryGroup resources in a project and location.
▼ ▲ dataplex.projects.locations.entryGroups.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Retrieves a EntryGroup resource.
▼ ▲ dataplex.projects.locations.entryGroups.entries.create
Path: v1/{+parent}/entries
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries
HTTP Method: POST
Parameters:
parent
Description: Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
Pattern: ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Location: path
Required: Yes
Type: string
entryId
Description: Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name.For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud.The maximum size of the field is 4000 characters.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates an Entry.
▼ ▲ dataplex.projects.locations.entryGroups.entries.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}
HTTP Method: PATCH
Parameters:
name
Description: Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
Pattern: ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/.*$
Location: path
Required: Yes
Type: string
updateMask
Description: Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, all modifiable fields present in the request will be updated.
Location: query
Type: string
Format: google-fieldmask
allowMissing
Description: Optional. If set to true and the entry does not exist, it will be created.
Location: query
Type: boolean
deleteMissingAspects
Description: Optional. If set to true and the aspect_keys specify aspect ranges, any existing aspects from that range not provided in the request will be deleted.
Location: query
Type: boolean
aspectKeys
Description: Optional. The map keys of the Aspects which should be modified. Supports the following syntaxes: * - matches aspect on given type and empty path * @path - matches aspect on given type and specified path * * - matches aspects on given type for all paths * *@path - matches aspects of all types on the given pathExisting aspects matching the syntax will not be removed unless delete_missing_aspects is set to true.If this field is left empty, it will be treated as specifying exactly those Aspects present in the request.
Location: query
Repeated: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates an Entry.
▼ ▲ dataplex.projects.locations.entryGroups.entries.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
Pattern: ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/.*$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes an Entry.
▼ ▲ dataplex.projects.locations.entryGroups.entries.list
Path: v1/{+parent}/entries
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries
HTTP Method: GET
Parameters:
parent
Description: Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
Pattern: ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. The pagination token returned by a previous request.
Location: query
Type: string
filter
Description: Optional. A filter on the entries to return. Filters are case-sensitive. The request can be filtered by the following fields: entry_type, display_name. The comparison operators are =, !=, <, >, <=, >= (strings are compared according to lexical order) The logical operators AND, OR, NOT can be used in the filter. Example filter expressions: "display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/a* OR "entry_type=projects/k*" "NOT display_name=AnotherExampleDisplayName"
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists entries within an entry group.
▼ ▲ dataplex.projects.locations.entryGroups.entries.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
Pattern: ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/.*$
Location: path
Required: Yes
Type: string
view
Description: Optional. View for controlling which parts of an entry are to be returned.
Location: query
Type: string
Enum Descriptions:
Enum:
aspectTypes
Description: Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected.
Location: query
Repeated: Yes
Type: string
paths
Description: Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected.
Location: query
Repeated: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a single entry.
▼ ▲ dataplex.projects.locations.dataScans.generateDataQualityRules
Path: v1/{+name}:generateDataQualityRules
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:generateDataQualityRules
HTTP Method: POST
Parameters:
name
Description: Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.
Pattern: ^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Generates recommended DataQualityRule from a data profiling DataScan.
▼ ▲ dataplex.projects.locations.dataScans.jobs.generateDataQualityRules
Path: v1/{+name}:generateDataQualityRules
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}:generateDataQualityRules
HTTP Method: POST
Parameters:
name
Description: Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.
Pattern: ^projects/[^/]+/locations/[^/]+/dataScans/[^/]+/jobs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Generates recommended DataQualityRule from a data profiling DataScan.