### SqlAssertion Example

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule

Provides an example of a SqlAssertion using the data reference parameter `${data()}` to select rows where the price is less than 0.

```sql
SELECT * FROM ${data()} WHERE price < 0
```

--------------------------------

### Example Access Group Configuration

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataProducts.dataAssets

An example of how to configure access groups for a data asset, specifying IAM roles granted to a group.

```json
{
  "analyst": {
    "iamRoles": ["roles/bigquery.dataViewer"]
  }
}
```

--------------------------------

### TestIamPermissions Request Example

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.tasks/testIamPermissions

This example demonstrates how to construct a request to test IAM permissions for a Dataplex task. It includes the resource path and the specific permissions to verify.

```bash
POST https://dataplex.googleapis.com/v1/{resource=projects/*/locations/*/lakes/*/tasks/*}:testIamPermissions
```

--------------------------------

### Example Request Body with Labels and Args

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.tasks/run

An example demonstrating how to provide key-value pairs for both labels and arguments in the request body. Note that clearing an existing label or arg requires setting its value to a hyphen "-".

```JSON
{
  "labels": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  },
  "args": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}
```

--------------------------------

### projects.locations.dataProducts.get

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataProducts/get

Gets a data product.

```APIDOC
## GET projects.locations.dataProducts.get

### Description
Gets a data product.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/dataProducts/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The name of the data product to retrieve. Format: projects/{project_id_or_number}/locations/{locationId}/dataProducts/{dataProductId}

### Request Body
The request body must be empty.

### Response Body
If successful, the response body contains an instance of `DataProduct`.
```

--------------------------------

### Example Request Body for TestIamPermissions

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataTaxonomies.attributes/testIamPermissions

This example shows a minimal request body for testing permissions, specifying the 'permissions' field with a list of IAM permissions to verify against the resource.

```json
{
  "permissions": [
    "dataplex.attributes.get",
    "dataplex.attributes.list"
  ]
}
```

--------------------------------

### Metadata Field Example

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/organizations.locations.operations

An example of the metadata field within an Operation resource, showing how to specify the type and include arbitrary data.

```json
{ "id": 1234, "@type": "types.example.com/standard/id" }
```

--------------------------------

### Location Labels Example

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations

An example of how cross-service attributes for a location are represented using labels.

```json
{
"cloud.googleapis.com/region": "us-east1"
}
```

--------------------------------

### IAM Policy YAML Example

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/Policy

Demonstrates the equivalent IAM policy structure in YAML format, useful for configuration files and readability.

```yaml
    bindings:
    - members:
      - user:mike@example.com
      - group:admins@example.com
      - domain:google.com
      - serviceAccount:my-project-id@appspot.gserviceaccount.com
      role: roles/resourcemanager.organizationAdmin
    - members:
      - user:eve@example.com
      role: roles/resourcemanager.organizationViewer
      condition:
        title: expirable access
        description: Does not grant access after Sep 2020
        expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
    etag: BwWWja0YfJA=
    version: 3

```

--------------------------------

### Aspects Map Example

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryGroups.entryLinks

An example of the 'aspects' map, showing how key-value pairs are used to attach aspects to an entry link. The key format is {project_id_or_number}.{locationId}.{aspectTypeId}.

```json
{ "name": "wrench", "mass": "1.3kg", "count": "3" }
```

--------------------------------

### projects.locations.entryGroups.entryLinks.get

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryGroups.entryLinks/get

Gets an Entry Link. Stay organized with collections. Save and categorize content based on your preferences.

```APIDOC
## GET projects.locations.entryGroups.entryLinks.get

### Description
Gets an Entry Link.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/entryGroups/*/entryLinks/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The resource name of the Entry Link: `projects/{project_id_or_number}/locations/{locationId}/entryGroups/{entryGroupId}/entryLinks/{entryLinkId}`.

### Request Body
The request body must be empty.

### Response Body
If successful, the response body contains an instance of `EntryLink`.

### Authorization Scopes
Requires one of the following OAuth scopes:
- `https://www.googleapis.com/auth/cloud-platform`
- `https://www.googleapis.com/auth/dataplex.read-write`

### IAM Permissions
Requires the following IAM permission on the `name` resource:
- `dataplex.entryLinks.get`
```

--------------------------------

### Update Mask Example

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations/modifyEntry

An example of how to specify a field mask for updating specific fields within an entry. The updateMask must contain 'aspects' to update Aspects.

```text
"user.displayName,photo"
```

--------------------------------

### Timestamp Format Examples

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryGroups.entryLinks

Examples of the RFC 3339 timestamp format used for createTime and updateTime fields, including Z-normalized and offset variations.

```text
"2014-10-02T15:01:23Z"
```

```text
"2014-10-02T15:01:23.045123456Z"
```

```text
"2014-10-02T15:01:23+05:30"
```

--------------------------------

### projects.locations.glossaries.categories.get

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.glossaries.categories/get

Gets a GlossaryCategory resource. Stay organized with collections. Save and categorize content based on your preferences.

```APIDOC
## GET https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/glossaries/*/categories/*}

### Description
Gets a GlossaryCategory resource.

### Method
GET

### Endpoint
https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/glossaries/*/categories/*}

### Parameters
#### Path Parameters
- **name** (string) - Required. The name of the GlossaryCategory to retrieve. Format: projects/{project_id_or_number}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}

### Request Body
The request body must be empty.

### Response Body
If successful, the response body contains an instance of `GlossaryCategory`.
```

--------------------------------

### projects.locations.metadataJobs.get

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.metadataJobs/get

Gets a metadata job. The URL uses gRPC Transcoding syntax.

```APIDOC
## GET projects.locations.metadataJobs.get

### Description
Gets a metadata job.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/metadataJobs/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The resource name of the metadata job, in the format `projects/{project_id_or_number}/locations/{locationId}/metadataJobs/{metadataJobId}`.

### Request Body
The request body must be empty.

### Response Body
If successful, the response body contains an instance of `MetadataJob`.
```

--------------------------------

### DataAttribute Example

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataTaxonomies.attributes

Illustrates a DataAttribute with PII classification, including ResourceAccessSpec and DataAccessSpec details.

```plaintext
PII
  - ResourceAccessSpec :
                - readers :foo@bar.com
  - DataAccessSpec :
                - readers :bar@foo.com
```

--------------------------------

### Get Task

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.tasks/get

Retrieves a task resource.

```APIDOC
## GET projects.locations.lakes.tasks.get

### Description
Get task resource.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/lakes/*/tasks/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The resource name of the task: `projects/{projectNumber}/locations/{locationId}/lakes/{lakeId}/tasks/{tasks_id}`.

### Response
If successful, the response body contains an instance of `Task`.
```

--------------------------------

### projects.locations.dataScans.get

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataScans/get

Gets a DataScan resource.

```APIDOC
## GET projects.locations.dataScans.get

### Description
Retrieves a DataScan resource.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/dataScans/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The resource name of the dataScan: `projects/{project}/locations/{locationId}/dataScans/{dataScanId}` where `project` refers to a _projectId_ or _projectNumber_ and `locationId` refers to a Google Cloud region.

#### Query Parameters
- **view** (enum (`DataScanView`)) - Optional. Select the DataScan view to return. Defaults to `BASIC`.

### Response
#### Success Response (200)
Returns an instance of `DataScan`.

### Authorization scopes
Requires one of the following OAuth scopes:
- `https://www.googleapis.com/auth/cloud-platform`
- `https://www.googleapis.com/auth/cloud-platform.read-only`
- `https://www.googleapis.com/auth/dataplex.read-write`
- `https://www.googleapis.com/auth/dataplex.readonly`
```

--------------------------------

### Get Entry

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryGroups.entries/get

Retrieves a specific Entry resource. The URL uses gRPC Transcoding syntax.

```APIDOC
## GET projects.locations.entryGroups.entries.get

### Description
Gets an Entry.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/entryGroups/*/entries/**}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The resource name of the Entry: `projects/{project}/locations/{location}/entryGroups/{entryGroup}/entries/{entry}`.

#### Query Parameters
- **view** (enum (`EntryView`)) - Optional. View to control which parts of an entry the service should return.
- **aspectTypes[]** (string) - Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view.
- **paths[]** (string) - Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.

### Request Body
The request body must be empty.

### Response
#### Success Response (200)
If successful, the response body contains an instance of `Entry`.

### Authorization scopes
Requires one of the following OAuth scopes:
- `https://www.googleapis.com/auth/cloud-platform`
- `https://www.googleapis.com/auth/cloud-platform.read-only`
- `https://www.googleapis.com/auth/dataplex.read-write`
- `https://www.googleapis.com/auth/dataplex.readonly`
```

--------------------------------

### IAM Policy JSON Example

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/Policy

Illustrates the structure of an IAM policy in JSON format, including bindings with roles, members, and an optional condition.

```json
    {
      "bindings": [
        {
          "role": "roles/resourcemanager.organizationAdmin",
          "members": [
            "user:mike@example.com",
            "group:admins@example.com",
            "domain:google.com",
            "serviceAccount:my-project-id@appspot.gserviceaccount.com"
          ]
        },
        {
          "role": "roles/resourcemanager.organizationViewer",
          "members": [
            "user:eve@example.com"
          ],
          "condition": {
            "title": "expirable access",
            "description": "Does not grant access after Sep 2020",
            "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
          }
        }
      ],
      "etag": "BwWWja0YfJA=",
      "version": 3
    }

```

--------------------------------

### Get Partition

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.zones.entities.partitions/get

Retrieves a metadata partition of an entity. The URL uses gRPC Transcoding syntax.

```APIDOC
## GET projects.locations.lakes.zones.entities.partitions.get

### Description
Retrieves a metadata partition of an entity.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/lakes/*/zones/*/entities/*/partitions/**}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The resource name of the partition: `projects/{projectNumber}/locations/{locationId}/lakes/{lakeId}/zones/{zoneId}/entities/{entityId}/partitions/{partition_value_path}`. The {partition_value_path} segment consists of an ordered sequence of partition values separated by "/". All values must be provided.

### Request Body
The request body must be empty.

### Response Body
If successful, the response body contains an instance of `Partition`.
```

--------------------------------

### HTTP Request Example

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataTaxonomies/setIamPolicy

This is the HTTP request structure for setting the IAM policy on a data taxonomy resource. The URL includes the resource name, and the request body contains the policy details.

```http
POST https://dataplex.googleapis.com/v1/{resource=projects/*/locations/*/dataTaxonomies/*}:setIamPolicy
```

--------------------------------

### get DataScanJob

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataScans.jobs

Gets a DataScanJob resource.

```APIDOC
## get DataScanJob

### Description
Gets a DataScanJob resource.

### Method
GET

### Endpoint
/projects/{projectId}/locations/{locationId}/dataScans/{dataScanId}/dataScanJobs/{dataScanJobId}

### Parameters
#### Path Parameters
- **projectId** (string) - Required - The Google Cloud project ID.
- **locationId** (string) - Required - The location ID.
- **dataScanId** (string) - Required - The data scan ID.
- **dataScanJobId** (string) - Required - The data scan job ID.

### Response
#### Success Response (200)
(No specific response fields are documented in the source.)
```

--------------------------------

### get

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/organizations.locations.operations

Gets the latest state of a long-running operation.

```APIDOC
## get

Gets the latest state of a long-running operation.
```

--------------------------------

### projects.locations.entryGroups.create

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryGroups/create

Creates an EntryGroup. This allows users to organize and categorize content based on their preferences.

```APIDOC
## POST https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/entryGroups

### Description
Creates an EntryGroup. Stay organized with collections by saving and categorizing content based on your preferences.

### Method
POST

### Endpoint
https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/entryGroups

### Parameters
#### Path Parameters
- **parent** (string) - Required. The resource name of the entryGroup, of the form: projects/{projectNumber}/locations/{locationId} where `locationId` refers to a Google Cloud region.

#### Query Parameters
- **entryGroupId** (string) - Required. EntryGroup identifier.
- **validateOnly** (boolean) - Optional. The service validates the request without performing any mutations. The default is false.

### Request Body
The request body contains an instance of `EntryGroup`.

### Response
#### Success Response (200)
If successful, the response body contains a newly created instance of `Operation`.

### Authorization scopes
Requires one of the following OAuth scopes:
- `https://www.googleapis.com/auth/cloud-platform`
- `https://www.googleapis.com/auth/dataplex.read-write`

### IAM Permissions
Requires the following IAM permission on the `parent` resource:
- `dataplex.entryGroups.create`
```

--------------------------------

### projects.locations.entryGroups.entries.create

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryGroups.entries/create

Creates an Entry. Entries are used to organize and categorize content based on user preferences.

```APIDOC
## POST https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*/entryGroups/*}/entries

### Description
Creates an Entry. Entries are used to organize and categorize content based on user preferences.

### Method
POST

### Endpoint
https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*/entryGroups/*}/entries

### Parameters
#### Path Parameters
- **parent** (string) - Required. The resource name of the parent Entry Group: `projects/{project}/locations/{location}/entryGroups/{entryGroup}`.

#### Query Parameters
- **entryId** (string) - Required. Entry identifier. It has to be unique within an Entry Group. Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names. The format is a full resource name of the resource without the prefix double slashes in the API service name part of the 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 entryId is `library.googleapis.com/shelves/shelf1/books/book2`. It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud. The maximum size of the field is 4000 characters.

### Request Body
The request body contains an instance of `Entry`.

### Response Body
If successful, the response body contains a newly created instance of `Entry`.
```

--------------------------------

### EntryLinkType Examples

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryGroups.entryLinks

Examples of EntryLinkType values used to define the relationship between linked entries, such as synonym terms, related terms, or glossary terms to data assets.

```text
projects/dataplex-types/locations/global/entryLinkTypes/synonym
```

```text
projects/dataplex-types/locations/global/entryLinkTypes/related
```

```text
projects/dataplex-types/locations/global/entryLinkTypes/definition
```

--------------------------------

### projects.locations.entryTypes.create

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryTypes/create

Creates a new EntryType. EntryTypes help organize and categorize content based on user preferences.

```APIDOC
## POST projects.locations.entryTypes

### Description
Creates an EntryType. Stay organized with collections. Save and categorize content based on your preferences.

### Method
POST

### Endpoint
`https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/entryTypes`

### Parameters
#### Path Parameters
- **parent** (string) - Required. The resource name of the EntryType, of the form: projects/{projectNumber}/locations/{locationId} where `locationId` refers to a Google Cloud region.

#### Query Parameters
- **entryTypeId** (string) - Required. EntryType identifier.
- **validateOnly** (boolean) - Optional. The service validates the request without performing any mutations. The default is false.

### Request Body
The request body contains an instance of `EntryType`.

### Response
#### Success Response (200)
If successful, the response body contains a newly created instance of `Operation`.

### Authorization Scopes
- `https://www.googleapis.com/auth/cloud-platform`
- `https://www.googleapis.com/auth/dataplex.read-write`

### IAM Permissions
- `dataplex.entryTypes.create` on the `parent` resource.
```

--------------------------------

### Example DebugQuery SQL Statement

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule

An example of a SQL statement for a debug query. It uses the `${data()}` parameter to reference the source table and includes an alias for a column.

```sql
SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM           ${data()}
```

--------------------------------

### projects.locations.lakes.actions.list

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.actions/list

Lists action resources in a lake. Stay organized with collections. Save and categorize content based on your preferences.

```APIDOC
## GET https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*/lakes/*}/actions

### Description
Lists action resources in a lake.

### Method
GET

### Endpoint
https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*/lakes/*}/actions

### Parameters
#### Path Parameters
- **parent** (string) - Required. The resource name of the parent lake: `projects/{projectNumber}/locations/{locationId}/lakes/{lakeId}`.

#### Query Parameters
- **pageSize** (integer) - 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** (string) - Optional. Page token received from a previous `actions.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `actions.list` must match the call that provided the page token.

### Request Body
The request body must be empty.

### Response Body
If successful, the response body contains an instance of `ListActionsResponse`.

### Authorization Scopes
Requires one of the following OAuth scopes:
- `https://www.googleapis.com/auth/cloud-platform`
- `https://www.googleapis.com/auth/cloud-platform.read-only`
- `https://www.googleapis.com/auth/dataplex.read-write`
- `https://www.googleapis.com/auth/dataplex.readonly`
```

--------------------------------

### Aspect Key Syntaxes

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations/modifyEntry

Illustrates the different syntaxes supported for specifying aspect keys to modify. These include matching by type, path, or all paths.

```text
<aspect_type_reference>
```

```text
<aspect_type_reference>@path
```

```text
<aspect_type_reference>@*
```

```text
*@path
```

--------------------------------

### List Partitions

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.zones.entities.partitions

Lists all metadata partitions for a given entity.

```APIDOC
## GET projects.locations.lakes.zones.entities.partitions

### Description
List metadata partitions of an entity.

### Method
GET

### Endpoint
projects/{projectName}/locations/{locationId}/lakes/{lakeId}/zones/{zoneId}/entities/{entityId}/partitions

### Query Parameters
- **pageSize** (integer) - Optional. The maximum number of partitions to return. Defaults to 10.
- **pageToken** (string) - Optional. A page token, received from a previous `ListPartitions` call.

### Response
#### Success Response (200)
- **partitions[]** (object) - List of partitions.
  - **name** (string) - Output only. Partition values used in the HTTP URL must be double encoded.
  - **values[]** (string) - The set of values representing the partition.
  - **location** (string) - The location of the entity data within the partition.
  - **etag** (string) - The etag for this partition.
- **nextPageToken** (string) - A token to retrieve the next page of results, or empty if there are no more pages.

#### Response Example
{
  "partitions": [
    {
      "name": "projects/your-project/locations/us/lakes/your-lake/zones/your-zone/entities/your-entity/partitions/encoded_value1",
      "values": [
        "value1"
      ],
      "location": "gs://your-bucket/path/to/data/value1",
      "etag": "some-etag-value"
    },
    {
      "name": "projects/your-project/locations/us/lakes/your-lake/zones/your-zone/entities/your-entity/partitions/encoded_value2",
      "values": [
        "value2"
      ],
      "location": "gs://your-bucket/path/to/data/value2",
      "etag": "another-etag-value"
    }
  ],
  "nextPageToken": ""
}
```

--------------------------------

### projects.locations.glossaries.create

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.glossaries/create

Creates a new Glossary resource. This operation allows for organizing and categorizing content based on user preferences.

```APIDOC
## POST /v1/{parent=projects/*/locations/*}/glossaries

### Description
Creates a new Glossary resource.

### Method
POST

### Endpoint
`https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/glossaries`

### Parameters
#### Path Parameters
- **parent** (string) - Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{locationId}.

#### Query Parameters
- **glossaryId** (string) - Required. Glossary ID: Glossary identifier.
- **validateOnly** (boolean) - Optional. Validates the request without actually creating the Glossary. Default: false.

### Request Body
The request body contains an instance of `Glossary`.

### Response
#### Success Response
If successful, the response body contains a newly created instance of `Operation`.

### Authorization Scopes
- `https://www.googleapis.com/auth/cloud-platform`
- `https://www.googleapis.com/auth/dataplex.read-write`

### IAM Permissions
Requires the following IAM permission on the `parent` resource:
- `dataplex.glossaries.create`
```

--------------------------------

### projects.locations.dataProducts.list

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataProducts/list

Lists data products for a given project. Supports filtering, pagination, and ordering.

```APIDOC
## GET projects.locations.dataProducts.list

### Description
Lists data products for a given project.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/dataProducts`

### Parameters
#### Path Parameters
- **parent** (string) - Required. The parent, which has this collection of data products. Format: `projects/{project_id_or_number}/locations/{locationId}`. Supports listing across all locations with the wildcard `-` (hyphen) character. Example: `projects/{project_id_or_number}/locations/-`

#### Query Parameters
- **filter** (string) - Optional. Filter expression that filters data products listed in the response. Example of using this filter is: `displayName="my-data-product"
- **pageSize** (integer) - Optional. The maximum number of data products to return. The service may return fewer than this value. If unspecified, at most 50 data products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
- **pageToken** (string) - Optional. A page token, received from a previous `dataProducts.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `dataProducts.list` must match the call that provided the page token.
- **orderBy** (string) - Optional. Order by expression that orders data products listed in the response. Supported Order by fields are: `name` or `createTime`. If not specified, the ordering is undefined. Ordering by `createTime` is not supported when listing resources across locations (i.e. when request contains `/locations/-`).

### Request Body
The request body must be empty.

### Response
#### Success Response (200)
- **dataProducts** (array of objects) - The data products for the requested filter criteria.
- **nextPageToken** (string) - A token, which can be sent as `pageToken` to retrieve the next page. If this field is empty, then there are no subsequent pages.
- **unreachable** (array of strings) - Unordered list. Locations that the service couldn't reach.

#### Response Example
```json
{
  "dataProducts": [
    {
      "object (DataProduct)"
    }
  ],
  "nextPageToken": "string",
  "unreachable": [
    "string"
  ]
}
```
```

--------------------------------

### Get EntryGroup

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryGroups/get

Retrieves a specific EntryGroup resource.

```APIDOC
## GET projects.locations.entryGroups/{name=projects/*/locations/*/entryGroups/*}

### Description
Gets an EntryGroup.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/entryGroups/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The resource name of the EntryGroup: `projects/{projectNumber}/locations/{locationId}/entryGroups/{entryGroupId}`.

### Request Body
The request body must be empty.

### Response Body
If successful, the response body contains an instance of `EntryGroup`.
```

--------------------------------

### projects.locations.dataProducts.create

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataProducts/create

Creates a data product. This operation allows for organizing and categorizing content based on user preferences.

```APIDOC
## POST projects.locations.dataProducts.create

### Description
Creates a data product. Stay organized with collections and save/categorize content based on your preferences.

### Method
POST

### Endpoint
https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/dataProducts

### Parameters
#### Path Parameters
- **parent** (string) - Required. The parent resource where this data product will be created. Format: projects/{project_id_or_number}/locations/{locationId}

#### Query Parameters
- **dataProductId** (string) - Optional. The ID of the data product to create. The ID must conform to RFC-1034 and contain only lower-case letters (a-z), numbers (0-9), or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. Characters outside of ASCII are not permitted. Valid format regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$` If not provided, a system generated ID will be used.
- **validateOnly** (boolean) - Optional. Validates the request without actually creating the data product. Default: false.

### Request Body
The request body contains an instance of `DataProduct`.

### Response Body
If successful, the response body contains a newly created instance of `Operation`.

### Authorization Scopes
Requires one of the following OAuth scopes:
- `https://www.googleapis.com/auth/cloud-platform`
- `https://www.googleapis.com/auth/dataplex.read-write`

### IAM Permissions
Requires the following IAM permission on the `parent` resource:
- `dataplex.dataProducts.create`
```

--------------------------------

### projects.locations.entryTypes.list

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryTypes/list

Lists EntryType resources in a project and location.

```APIDOC
## GET /v1/{parent=projects/*/locations/*}/entryTypes

### Description
Lists EntryType resources in a project and location.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/entryTypes`

### Parameters
#### Path Parameters
- **parent** (string) - Required. The resource name of the EntryType location, of the form: `projects/{projectNumber}/locations/{locationId}` where `locationId` refers to a Google Cloud region.

#### Query Parameters
- **pageSize** (integer) - Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.
- **pageToken** (string) - Optional. Page token received from a previous `entryTypes.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provided to `entryTypes.list` must match the call that provided the page token.
- **filter** (string) - Optional. Filter request. Filters are case-sensitive. The service supports the following formats:
  * labels.key1 = "value1"
  * labels:key1
  * name = "value"
These restrictions can be conjoined with AND, OR, and NOT conjunctions.
- **orderBy** (string) - Optional. Orders the result by `name` or `createTime` fields. If not specified, the ordering is undefined.

### Request Body
The request body must be empty.

### Response
#### Success Response (200)
- **entryTypes** (array) - EntryTypes under the given parent location.
- **nextPageToken** (string) - Token to retrieve the next page of results, or empty if there are no more results in the list.
- **unreachableLocations** (array) - Locations that the service couldn't reach.

#### Response Example
```json
{
  "entryTypes": [
    {
      "object": "EntryType"
    }
  ],
  "nextPageToken": "string",
  "unreachableLocations": [
    "string"
  ]
}
```
```

--------------------------------

### cancel

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/organizations.locations.operations

Starts asynchronous cancellation on a long-running operation.

```APIDOC
## cancel

Starts asynchronous cancellation on a long-running operation.
```

--------------------------------

### Get Partition

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.zones.entities.partitions

Retrieves the metadata for a specific partition of an entity.

```APIDOC
## GET projects.locations.lakes.zones.entities.partitions

### Description
Get a metadata partition of an entity.

### Method
GET

### Endpoint
projects/{projectName}/locations/{locationId}/lakes/{lakeId}/zones/{zoneId}/entities/{entityId}/partitions/{partitionId}

### Parameters
#### Path Parameters
- **partitionId** (string) - Required. The identifier of the partition to retrieve. This ID is typically a URL-encoded representation of the partition values.

### Response
#### Success Response (200)
- **name** (string) - Output only. Partition values used in the HTTP URL must be double encoded.
- **values[]** (string) - The set of values representing the partition.
- **location** (string) - The location of the entity data within the partition.
- **etag** (string) - The etag for this partition.

#### Response Example
{
  "name": "projects/your-project/locations/us/lakes/your-lake/zones/your-zone/entities/your-entity/partitions/encoded_value1/encoded_value2",
  "values": [
    "value1",
    "value2"
  ],
  "location": "gs://your-bucket/path/to/data",
  "etag": "some-etag-value"
}
```

--------------------------------

### projects.locations.entryGroups.list

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryGroups/list

Lists EntryGroup resources in a project and location. The URL uses gRPC Transcoding syntax.

```APIDOC
## GET https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/entryGroups

### Description
Lists EntryGroup resources in a project and location.

### Method
GET

### Endpoint
https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/entryGroups

### Parameters
#### Path Parameters
- **parent** (string) - Required. The resource name of the entryGroup location, of the form: `projects/{projectNumber}/locations/{locationId}` where `locationId` refers to a Google Cloud region.

#### Query Parameters
- **pageSize** (integer) - Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryGroups. The maximum value is 1000; values above 1000 will be coerced to 1000.
- **pageToken** (string) - Optional. Page token received from a previous `entryGroups.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to `entryGroups.list` must match the call that provided the page token.
- **filter** (string) - Optional. Filter request.
- **orderBy** (string) - Optional. Order by fields for the result.

### Request Body
The request body must be empty.

### Response
#### Success Response (200)
List entry groups response.
- **entryGroups** (array) - Entry groups under the given parent location.
- **nextPageToken** (string) - Token to retrieve the next page of results, or empty if there are no more results in the list.
- **unreachableLocations** (array) - Locations that the service couldn't reach.

### Response Example
```json
{
  "entryGroups": [
    {
      "object (EntryGroup)"
    }
  ],
  "nextPageToken": "string",
  "unreachableLocations": [
    "string"
  ]
}
```
```

--------------------------------

### Get Job

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.tasks.jobs

Retrieves details of a specific job resource.

```APIDOC
## Get Job

### Description
Get job resource.

### Method
GET

### Endpoint
projects/{projectNumber}/locations/{locationId}/lakes/{lakeId}/tasks/{taskId}/jobs/{jobId}

### Parameters
#### Path Parameters
- **projectNumber** (string) - Required - The project number of the project.
- **locationId** (string) - Required - The location ID.
- **lakeId** (string) - Required - The lake ID.
- **taskId** (string) - Required - The task ID.
- **jobId** (string) - Required - The job ID.

### Response
#### Success Response (200)
- **name** (string) - Output only. The relative resource name of the job.
- **uid** (string) - Output only. System generated globally unique ID for the job.
- **startTime** (string) - Output only. The time when the job was started (Timestamp format).
- **endTime** (string) - Output only. The time when the job ended (Timestamp format).
- **state** (enum) - Output only. Execution state for the job.
- **retryCount** (integer) - Output only. The number of times the job has been retried.
- **service** (enum) - Output only. The underlying service running a job.
- **serviceJob** (string) - Output only. The full resource name for the job run under a particular service.
- **message** (string) - Output only. Additional information about the current state.
- **labels** (map) - Output only. User-defined labels for the task.
- **trigger** (enum) - Output only. Job execution trigger.
- **executionSpec** (object) - Output only. Spec related to how a task is executed.

#### Response Example
{
  "name": "projects/{projectNumber}/locations/{locationId}/lakes/{lakeId}/tasks/{taskId}/jobs/{jobId}",
  "uid": "some-unique-id",
  "startTime": "2023-10-27T10:00:00Z",
  "endTime": "2023-10-27T10:05:00Z",
  "state": "SUCCEEDED",
  "retryCount": 0,
  "service": "DATAPROC",
  "serviceJob": "projects/123/regions/us-central1/jobs/dataproc-job-id",
  "message": "Job completed successfully.",
  "labels": {
    "key1": "value1"
  },
  "trigger": "TASK_CONFIG",
  "executionSpec": {}
}
```

--------------------------------

### Query

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/DataDocumentationResult

Represents a sample SQL query in data documentation.

```APIDOC
## Query

### Description
A sample SQL query in data documentation.

### JSON Representation
```json
{
  "sql": "string",
  "description": "string"
}
```

### Fields
- `sql` (string): Output only. The SQL query string which can be executed.
- `description` (string): Output only. The description for the query.
```

--------------------------------

### Get Glossary Term

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.glossaries.terms/get

Retrieves a GlossaryTerm resource by its name.

```APIDOC
## GET projects.locations.glossaries.terms.get

### Description
Gets a GlossaryTerm resource.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/glossaries/*/terms/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the GlossaryTerm to retrieve. Format: projects/{project_id_or_number}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}

### Request Body
The request body must be empty.

### Response
#### Success Response (200)
If successful, the response body contains an instance of `GlossaryTerm`.
```

--------------------------------

### Get EncryptionConfig

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs/get

Retrieves a specific EncryptionConfig resource by its name.

```APIDOC
## GET organizations.locations.encryptionConfigs.get

### Description
Retrieves an EncryptionConfig.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=organizations/*/locations/*/encryptionConfigs/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The name of the EncryptionConfig to fetch. Authorization requires the following IAM permission on the specified resource `name`:
  * `dataplex.encryptionConfig.get`

### Request Body
The request body must be empty.

### Response Body
If successful, the response body contains an instance of `EncryptionConfig`.

### Authorization Scopes
Requires one of the following OAuth scopes:
  * `https://www.googleapis.com/auth/cloud-platform`
  * `https://www.googleapis.com/auth/dataplex.read-write`
```

--------------------------------

### Get Data Asset

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataProducts.dataAssets/get

Retrieves a data asset by its resource name.

```APIDOC
## GET projects.locations.dataProducts.dataAssets.get

### Description
Gets a data asset.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/dataProducts/*/dataAssets/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The name of the data asset to retrieve. Format: projects/{project_id_or_number}/locations/{locationId}/dataProducts/{dataProductId}/dataAssets/{dataAssetId}

### Request Body
The request body must be empty.

### Response Body
If successful, the response body contains an instance of `DataAsset`.
```

--------------------------------

### Get Metadata Entity

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.zones.entities

Retrieves a specific metadata entity within a Dataplex zone.

```APIDOC
## GET /projects/{projectId}/locations/{locationId}/lakes/{lakeId}/zones/{zoneId}/metadataEntities/{entityId}

### Description
Get a metadata entity.

### Method
GET

### Endpoint
/projects/{projectId}/locations/{locationId}/lakes/{lakeId}/zones/{zoneId}/metadataEntities/{entityId}
```

--------------------------------

### Create Partition

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.zones.entities.partitions/create

Creates a metadata partition for a given entity. This operation requires appropriate IAM permissions on the parent resource.

```APIDOC
## POST projects.locations.lakes.zones.entities.partitions.create

### Description
Creates a metadata partition.

### Method
POST

### Endpoint
`https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*/lakes/*/zones/*/entities/*}/partitions`

### Path parameters
* **parent** (string) - Required. The resource name of the parent zone: `projects/{projectNumber}/locations/{locationId}/lakes/{lakeId}/zones/{zoneId}/entities/{entityId}`.

### Query parameters
* **validateOnly** (boolean) - Optional. Only validate the request, but do not perform mutations. The default is false.

### Request body
The request body contains an instance of `Partition`.

### Response body
If successful, the response body contains a newly created instance of `Partition`.

### Authorization scopes
Requires one of the following OAuth scopes:
* `https://www.googleapis.com/auth/cloud-platform`
* `https://www.googleapis.com/auth/dataplex.read-write`
```

--------------------------------

### Get Entity

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.zones.entities/get

Retrieves a metadata entity. The URL uses gRPC Transcoding syntax.

```APIDOC
## GET projects.locations.lakes.zones.entities.get

### Description
Get a metadata entity.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/lakes/*/zones/*/entities/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The resource name of the entity: `projects/{projectNumber}/locations/{locationId}/lakes/{lakeId}/zones/{zoneId}/entities/{entityId}.` Authorization requires the following IAM permission on the specified resource `name`:
  * `dataplex.entities.get`

#### Query Parameters
- **view** (enum (`EntityView`)) - Optional. Used to select the subset of entity information to return. Defaults to `BASIC`.

### Request Body
The request body must be empty.

### Response
#### Success Response (200)
If successful, the response body contains an instance of `Entity`.

### Authorization scopes
Requires one of the following OAuth scopes:
  * `https://www.googleapis.com/auth/cloud-platform`
  * `https://www.googleapis.com/auth/dataplex.read-write`
```

--------------------------------

### Get Job

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.tasks.jobs/get

Retrieves a job resource. The URL uses gRPC Transcoding syntax.

```APIDOC
## GET projects.locations.lakes.tasks.jobs.get

### Description
Retrieves a job resource.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/lakes/*/tasks/*/jobs/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The resource name of the job: `projects/{projectNumber}/locations/{locationId}/lakes/{lakeId}/tasks/{taskId}/jobs/{jobId}`.

### Request Body
The request body must be empty.

### Response Body
If successful, the response body contains an instance of `Job`.

### Authorization Scopes
Requires one of the following OAuth scopes:
- `https://www.googleapis.com/auth/cloud-platform`
- `https://www.googleapis.com/auth/cloud-platform.read-only`
- `https://www.googleapis.com/auth/dataplex.read-write`
- `https://www.googleapis.com/auth/dataplex.readonly`
```

--------------------------------

### Zone Methods

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.zones

Available methods for interacting with Zone resources.

```APIDOC
## Methods
- create
- delete
- get
- getIamPolicy
- list
- patch
- setIamPolicy
- testIamPermissions
```

--------------------------------

### projects.locations.aspectTypes.get

Source: https://docs.cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.aspectTypes/get

Gets an AspectType. This method allows you to retrieve the details of a specific AspectType resource.

```APIDOC
## GET projects.locations.aspectTypes.get

### Description
Gets an AspectType.

### Method
GET

### Endpoint
`https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/aspectTypes/*}`

### Parameters
#### Path Parameters
- **name** (string) - Required. The resource name of the AspectType: `projects/{projectNumber}/locations/{locationId}/aspectTypes/{aspectTypeId}`.

### Request Body
The request body must be empty.

### Response
#### Success Response (200)
Returns an instance of `AspectType`.

### Authorization Scopes
Requires one of the following OAuth scopes:
- `https://www.googleapis.com/auth/cloud-platform`
- `https://www.googleapis.com/auth/cloud-platform.read-only`
- `https://www.googleapis.com/auth/dataplex.read-write`
- `https://www.googleapis.com/auth/dataplex.readonly

### IAM Permissions
Requires the following IAM permission on the `name` resource:
- `dataplex.aspectTypes.get`
```