Cloud Dataplex API (dataplex:v1)

▼ ▲ dataplex.projects.locations.entryGroups.entryLinks.create

Path : v1/{+parent}/entryLinks

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entryLinks

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

entryLinkId

Description : Required. Entry Link 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 EntryGroup.

Location : query

Type : string

Parameter Order : parent

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

Description : Creates an Entry Link.

▼ ▲ dataplex.projects.locations.entryGroups.entryLinks.delete

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entryLinks/{entryLinksId}

HTTP Method : DELETE

Parameters :

name

Description : Required. The resource name of the Entry Link: projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}.

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

Location : path

Required : Yes

Type : string

Parameter Order : name

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

Description : Deletes an Entry Link.

▼ ▲ dataplex.projects.locations.entryGroups.entryLinks.get

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entryLinks/{entryLinksId}

HTTP Method : GET

Parameters :

name

Description : Required. The resource name of the Entry Link: projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}.

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

Location : path

Required : Yes

Type : string

Parameter Order : name

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

Description : Gets an entry link.

▼ ▲ dataplex.projects.locations.glossaries.create

Path : v1/{+parent}/glossaries

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

HTTP Method : POST

Parameters :

parent

Description : Required. The parent resource where this Glossary will be created. Format: projects/{projectId}/locations/{locationId} where locationId refers to a GCP region.

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

Location : path

Required : Yes

Type : string

glossaryId

Description : Required. Glossary ID: Glossary identifier.

Location : query

Type : string

validateOnly

Description : Optional. Validates the request without actually creating the glossary. Default: false.

Location : query

Type : boolean

Parameter Order : parent

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

Description : Creates a new Glossary resource.

▼ ▲ dataplex.projects.locations.glossaries.patch

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}

HTTP Method : PATCH

Parameters :

name

Description : Output only. Identifier. The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}

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

Location : path

Required : Yes

Type : string

updateMask

Description : Required. The list of fields to update.

Location : query

Type : string

Format : google-fieldmask

validateOnly

Description : Optional. Validates the request without actually updating the glossary. Default: false.

Location : query

Type : boolean

Parameter Order : name

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

Description : Updates a Glossary resource.

▼ ▲ dataplex.projects.locations.glossaries.delete

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}

HTTP Method : DELETE

Parameters :

name

Description : Required. The name of the Glossary to delete. Format: projects/{project}/locations/{location}/glossary/{glossary}

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

Location : path

Required : Yes

Type : string

etag

Description : Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.

Location : query

Type : string

Parameter Order : name

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

Description : Deletes a Glossary resource. All the categories and terms within the glossary must be deleted before a glossary can be deleted.

▼ ▲ dataplex.projects.locations.glossaries.get

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}

HTTP Method : GET

Parameters :

name

Description : Required. The name of the Glossary to retrieve. Format: projects/{project}/locations/{location}/glossaries/{glossary}

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

Location : path

Required : Yes

Type : string

Parameter Order : name

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

Description : Retrieves a specified Glossary resource.

▼ ▲ dataplex.projects.locations.glossaries.list

Path : v1/{+parent}/glossaries

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

HTTP Method : GET

Parameters :

parent

Description : Required. The parent, which has this collection of glossaries. Format: projects/{project}/locations/{location} Location is the GCP region.

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

Location : path

Required : Yes

Type : string

pageSize

Description : Optional. The maximum number of glossaries to return. The service may return fewer than this value. If unspecified, at most 50 glossaries 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. A page token, received from a previous ListGlossaries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaries must match the call that provided the page token.

Location : query

Type : string

filter

Description : Optional. Filter expression that filters glossaries listed in the response. Initially, no filter is supported.

Location : query

Type : string

orderBy

Description : Optional. Order by expression that orders glossaries listed in the response. Order by fields are: 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 Glossary resources in a project and location.

▼ ▲ dataplex.projects.locations.glossaries.categories.create

Path : v1/{+parent}/categories

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories

HTTP Method : POST

Parameters :

parent

Description : Required. The parent resource where this GlossaryCategory will be created. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} where locationId refers to a GCP region.

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

Location : path

Required : Yes

Type : string

categoryId

Description : Required. Category ID: GlossaryCategory identifier.

Location : query

Type : string

Parameter Order : parent

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

Description : GlossaryCategory APIs are CCFE passthrough APIs. Creates a new GlossaryCategory resource.

▼ ▲ dataplex.projects.locations.glossaries.categories.patch

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}

HTTP Method : PATCH

Parameters :

name

Description : Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}

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

Location : path

Required : Yes

Type : string

updateMask

Description : Required. The list of fields to update.

Location : query

Type : string

Format : google-fieldmask

Parameter Order : name

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

Description : Updates a GlossaryCategory resource.

▼ ▲ dataplex.projects.locations.glossaries.categories.delete

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}

HTTP Method : DELETE

Parameters :

name

Description : Required. The name of the GlossaryCategory to delete. Format: projects/{project}/locations/{location}/glossary/{glossary}/categories/{glossary_category}

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

Location : path

Required : Yes

Type : string

Parameter Order : name

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

Description : Deletes a GlossaryCategory resource. All the categories and terms nested directly under the category will be moved one level up to the parent in the hierarchy.

▼ ▲ dataplex.projects.locations.glossaries.categories.get

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}

HTTP Method : GET

Parameters :

name

Description : Required. The name of the GlossaryCategory to retrieve. Format: projects/{project}/locations/{location}/glossaries/{glossary}/categories/{glossary_category}

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

Location : path

Required : Yes

Type : string

Parameter Order : name

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

Description : Retrieves a specified GlossaryCategory resource.

▼ ▲ dataplex.projects.locations.glossaries.categories.list

Path : v1/{+parent}/categories

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories

HTTP Method : GET

Parameters :

parent

Description : Required. The parent, which has this collection of categories. Format: projects/{project}/locations/{location}/glossaries/{glossary} Location is the GCP region.

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

Location : path

Required : Yes

Type : string

pageSize

Description : Optional. The maximum number of categories to return. The service may return fewer than this value. If unspecified, at most 50 categories 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. A page token, received from a previous ListGlossaryCategories call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaryCategories must match the call that provided the page token.

Location : query

Type : string

filter

Description : Optional. Filter expression that filters categories listed in the response. Filters supported: List GlossaryCategories based on immediate parent in the resource hierarchy. This will only return the GlossaryCategories nested directly under the parent and no other subsequent nested categories will be returned.

Location : query

Type : string

orderBy

Description : Optional. Order by expression that orders categories listed in the response. Order by fields are: 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 GlossaryCategory resources in a glossary.

▼ ▲ dataplex.projects.locations.glossaries.terms.create

Path : v1/{+parent}/terms

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms

HTTP Method : POST

Parameters :

parent

Description : Required. The parent resource where this GlossaryTerm will be created. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} where locationId refers to a GCP region.

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

Location : path

Required : Yes

Type : string

termId

Description : Required. Term ID: GlossaryTerm identifier.

Location : query

Type : string

Parameter Order : parent

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

Description : GlossaryTerm APIs are CCFE passthrough APIs. Creates a new GlossaryTerm resource.

▼ ▲ dataplex.projects.locations.glossaries.terms.patch

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}

HTTP Method : PATCH

Parameters :

name

Description : Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}

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

Location : path

Required : Yes

Type : string

updateMask

Description : Required. The list of fields to update.

Location : query

Type : string

Format : google-fieldmask

Parameter Order : name

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

Description : Updates a GlossaryTerm resource.

▼ ▲ dataplex.projects.locations.glossaries.terms.delete

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}

HTTP Method : DELETE

Parameters :

name

Description : Required. The name of the GlossaryTerm to delete. Format: projects/{project}/locations/{location}/glossary/{glossary}/terms/{glossary_term}

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

Location : path

Required : Yes

Type : string

Parameter Order : name

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

Description : Deletes a GlossaryTerm resource.

▼ ▲ dataplex.projects.locations.glossaries.terms.get

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}

HTTP Method : GET

Parameters :

name

Description : Required. The name of the GlossaryTerm to retrieve. Format: projects/{project}/locations/{location}/glossaries/{glossary}/terms/{glossary_term}

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

Location : path

Required : Yes

Type : string

Parameter Order : name

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

Description : Retrieves a specified GlossaryTerm resource.

▼ ▲ dataplex.projects.locations.glossaries.terms.list

Path : v1/{+parent}/terms

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms

HTTP Method : GET

Parameters :

parent

Description : Required. The parent, which has this collection of terms. Format: projects/{project}/locations/{location}/glossaries/{glossary} Location is the GCP region.

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

Location : path

Required : Yes

Type : string

pageSize

Description : Optional. The maximum number of terms to return. The service may return fewer than this value. If unspecified, at most 50 terms 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. A page token, received from a previous ListGlossaryTerms call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaryTerms must match the call that provided the page token.

Location : query

Type : string

filter

Description : Optional. Filter expression that filters terms listed in the response. Filters supported: List GlossaryTerms based on immediate parent in the resource hierarchy. This will only return the terms nested directly under the parent and no other subsequent nested terms will be returned.

Location : query

Type : string

orderBy

Description : Optional. Order by expression that orders terms listed in the response. Order by fields are: 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 GlossaryTerm resources in a glossary.

▼ ▲ dataplex.projects.locations.searchEntries

Parameters :

semanticSearch

Description : Optional. Internal only.

Location : query

Type : boolean