{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud services and see the email address of your Google Account"
},
"https://www.googleapis.com/auth/dataplex.read-write": {
"description": "See, edit, configure, and delete your Google Cloud Dataplex data and see the email address for your Google Account"
},
"https://www.googleapis.com/auth/dataplex.readonly": {
"description": "See your Google Cloud Dataplex data and the email address of your Google Account"
}
}
}
},
"basePath": "",
"baseUrl": "https://dataplex.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Dataplex",
"description": "A unified, intelligent governance solution for data and AI assets.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/dataplex/docs",
"endpoints": [
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.africa-south1.rep.googleapis.com/",
"location": "africa-south1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.asia-east1.rep.googleapis.com/",
"location": "asia-east1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.asia-east2.rep.googleapis.com/",
"location": "asia-east2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.asia-northeast1.rep.googleapis.com/",
"location": "asia-northeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.asia-northeast2.rep.googleapis.com/",
"location": "asia-northeast2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.asia-northeast3.rep.googleapis.com/",
"location": "asia-northeast3"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.asia-south1.rep.googleapis.com/",
"location": "asia-south1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.asia-south2.rep.googleapis.com/",
"location": "asia-south2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.asia-southeast1.rep.googleapis.com/",
"location": "asia-southeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.asia-southeast2.rep.googleapis.com/",
"location": "asia-southeast2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.asia-southeast3.rep.googleapis.com/",
"location": "asia-southeast3"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.australia-southeast1.rep.googleapis.com/",
"location": "australia-southeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.australia-southeast2.rep.googleapis.com/",
"location": "australia-southeast2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-central2.rep.googleapis.com/",
"location": "europe-central2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-north1.rep.googleapis.com/",
"location": "europe-north1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-north2.rep.googleapis.com/",
"location": "europe-north2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-southwest1.rep.googleapis.com/",
"location": "europe-southwest1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-west1.rep.googleapis.com/",
"location": "europe-west1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-west10.rep.googleapis.com/",
"location": "europe-west10"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-west12.rep.googleapis.com/",
"location": "europe-west12"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-west15.rep.googleapis.com/",
"location": "europe-west15"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-west2.rep.googleapis.com/",
"location": "europe-west2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-west3.rep.googleapis.com/",
"location": "europe-west3"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-west4.rep.googleapis.com/",
"location": "europe-west4"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-west6.rep.googleapis.com/",
"location": "europe-west6"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-west8.rep.googleapis.com/",
"location": "europe-west8"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.europe-west9.rep.googleapis.com/",
"location": "europe-west9"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.me-central1.rep.googleapis.com/",
"location": "me-central1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.me-central2.rep.googleapis.com/",
"location": "me-central2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.me-west1.rep.googleapis.com/",
"location": "me-west1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.northamerica-northeast1.rep.googleapis.com/",
"location": "northamerica-northeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.northamerica-northeast2.rep.googleapis.com/",
"location": "northamerica-northeast2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.northamerica-south1.rep.googleapis.com/",
"location": "northamerica-south1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.southamerica-east1.rep.googleapis.com/",
"location": "southamerica-east1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.southamerica-west1.rep.googleapis.com/",
"location": "southamerica-west1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-central1.rep.googleapis.com/",
"location": "us-central1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-central2.rep.googleapis.com/",
"location": "us-central2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-east1.rep.googleapis.com/",
"location": "us-east1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-east4.rep.googleapis.com/",
"location": "us-east4"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-east5.rep.googleapis.com/",
"location": "us-east5"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-east7.rep.googleapis.com/",
"location": "us-east7"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-south1.rep.googleapis.com/",
"location": "us-south1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-west1.rep.googleapis.com/",
"location": "us-west1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-west2.rep.googleapis.com/",
"location": "us-west2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-west3.rep.googleapis.com/",
"location": "us-west3"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-west4.rep.googleapis.com/",
"location": "us-west4"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us-west8.rep.googleapis.com/",
"location": "us-west8"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.us.rep.googleapis.com/",
"location": "us"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dataplex.eu.rep.googleapis.com/",
"location": "eu"
}
],
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "dataplex:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://dataplex.mtls.googleapis.com/",
"name": "dataplex",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"organizations": {
"resources": {
"locations": {
"resources": {
"encryptionConfigs": {
"methods": {
"create": {
"description": "Create an EncryptionConfig.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs",
"httpMethod": "POST",
"id": "dataplex.organizations.locations.encryptionConfigs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"encryptionConfigId": {
"description": "Required. The ID of the EncryptionConfig to create. Currently, only a value of \"default\" is supported.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The location at which the EncryptionConfig is to be created.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/encryptionConfigs",
"request": {
"$ref": "GoogleCloudDataplexV1EncryptionConfig"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Delete an EncryptionConfig.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}",
"httpMethod": "DELETE",
"id": "dataplex.organizations.locations.encryptionConfigs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. Etag of the EncryptionConfig. This is a strong etag.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the EncryptionConfig to delete.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Get an EncryptionConfig.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}",
"httpMethod": "GET",
"id": "dataplex.organizations.locations.encryptionConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the EncryptionConfig to fetch.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1EncryptionConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.organizations.locations.encryptionConfigs.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "List EncryptionConfigs.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs",
"httpMethod": "GET",
"id": "dataplex.organizations.locations.encryptionConfigs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter the EncryptionConfigs to be returned. Using bare literals: (These values will be matched anywhere it may appear in the object's field values) * filter=some_value Using fields: (These values will be matched only in the specified field) * filter=some_field=some_value Supported fields: * name, key, create_time, update_time, encryption_state Example: * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config conjunctions: (AND, OR, NOT) * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config AND mode=CMEK logical operators: (>, <, >=, <=, !=, =, :), * filter=create_time>2024-05-01T00:00:00.000Z",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by fields for the result.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Maximum number of EncryptionConfigs to return. The service may return fewer than this value. If unspecified, at most 10 EncryptionConfigs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token received from a previous ListEncryptionConfigs call. Provide this to retrieve the subsequent page. When paginating, the parameters - filter and order_by provided to ListEncryptionConfigs must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The location for which the EncryptionConfig is to be listed.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/encryptionConfigs",
"response": {
"$ref": "GoogleCloudDataplexV1ListEncryptionConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"patch": {
"description": "Update an EncryptionConfig.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}",
"httpMethod": "PATCH",
"id": "dataplex.organizations.locations.encryptionConfigs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Mask of fields to update. The service treats an omitted field mask as an implied field mask equivalent to all fields that are populated (have a non-empty value).",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1EncryptionConfig"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.organizations.locations.encryptionConfigs.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.organizations.locations.encryptionConfigs.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"operations": {
"methods": {
"cancel": {
"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.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "dataplex.organizations.locations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "GoogleLongrunningCancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"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.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "dataplex.organizations.locations.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"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.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "dataplex.organizations.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "dataplex.organizations.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"returnPartialSuccess": {
"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to \"projects/example/locations/-\".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
}
}
}
}
},
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudLocationLocation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "dataplex.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"extraLocationTypes": {
"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.",
"location": "query",
"repeated": true,
"type": "string"
},
"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).",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/locations",
"response": {
"$ref": "GoogleCloudLocationListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"lookupContext": {
"description": "Looks up LLM Context for the specified resources.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupContext",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lookupContext",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:lookupContext",
"request": {
"$ref": "GoogleCloudDataplexV1LookupContextRequest"
},
"response": {
"$ref": "GoogleCloudDataplexV1LookupContextResponse"
},
"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"
]
},
"lookupEntry": {
"description": "Looks up an entry by name using the permission on the source system.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntry",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lookupEntry",
"parameterOrder": [
"name"
],
"parameters": {
"aspectTypes": {
"description": "Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view.",
"location": "query",
"repeated": true,
"type": "string"
},
"entry": {
"description": "Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"paths": {
"description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.",
"location": "query",
"repeated": true,
"type": "string"
},
"view": {
"description": "Optional. View to control which parts of an entry the service should return. Please check the limitations on returned aspects in the Entry view documentation. Amount of returned aspects depends on the selected Entry View.",
"enum": [
"ENTRY_VIEW_UNSPECIFIED",
"BASIC",
"FULL",
"CUSTOM",
"ALL"
],
"enumDescriptions": [
"Unspecified EntryView. Defaults to FULL.",
"Returns entry only, without aspects.",
"Returns all required aspects as well as the keys of all non-required aspects.",
"Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.",
"Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}:lookupEntry",
"response": {
"$ref": "GoogleCloudDataplexV1Entry"
},
"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"
]
},
"lookupEntryLinks": {
"description": "Looks up Entry Links referencing the specified Entry.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntryLinks",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lookupEntryLinks",
"parameterOrder": [
"name"
],
"parameters": {
"entry": {
"description": "Required. The resource name of the referred Entry. Format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. Entry Links which references this entry will be returned in the response.",
"location": "query",
"type": "string"
},
"entryLinkTypes": {
"description": "Entry link types to filter the response by. If empty, all entry link types will be returned. At most 10 entry link types can be specified.",
"location": "query",
"repeated": true,
"type": "string"
},
"entryMode": {
"description": "Mode of entry reference.",
"enum": [
"ENTRY_MODE_UNSPECIFIED",
"SOURCE",
"TARGET"
],
"enumDescriptions": [
"Unspecified entry mode. Returns both directional and non-directional entry links which references the entry.",
"Returns all directed entry links which references the entry as source.",
"Return all directed entry links which references the entry as target."
],
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The project to which the request should be attributed to Format: projects/{project_id_or_number}/locations/{location_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Maximum number of EntryLinks to return. The service may return fewer than this value. If unspecified, at most 10 EntryLinks will be returned. The maximum value is 10; values above 10 will be coerced to 10.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token received from a previous LookupEntryLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters that are provided to the LookupEntryLinks request must match the call that provided the page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}:lookupEntryLinks",
"response": {
"$ref": "GoogleCloudDataplexV1LookupEntryLinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"modifyEntry": {
"description": "Modifies an entry using the permission on the source system.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:modifyEntry",
"httpMethod": "POST",
"id": "dataplex.projects.locations.modifyEntry",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:modifyEntry",
"request": {
"$ref": "GoogleCloudDataplexV1ModifyEntryRequest"
},
"response": {
"$ref": "GoogleCloudDataplexV1Entry"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"searchEntries": {
"description": "Searches for Entries matching the given query and scope.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchEntries",
"httpMethod": "POST",
"id": "dataplex.projects.locations.searchEntries",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The project to which the request should be attributed in the following form: projects/{project}/locations/global.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"orderBy": {
"description": "Optional. Specifies the ordering of results. Supported values are: relevance last_modified_timestamp last_modified_timestamp asc",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"query": {
"description": "Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/search-syntax).",
"location": "query",
"type": "string"
},
"scope": {
"description": "Optional. The scope under which the search should be operating. It must either be organizations/ or projects/. If it is unspecified, it defaults to the organization where the project provided in name is located.",
"location": "query",
"type": "string"
},
"semanticSearch": {
"description": "Optional. Specifies whether the search should understand the meaning and intent behind the query, rather than just matching keywords.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}:searchEntries",
"response": {
"$ref": "GoogleCloudDataplexV1SearchEntriesResponse"
},
"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"
]
}
},
"resources": {
"aspectTypes": {
"methods": {
"create": {
"description": "Creates an AspectType.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes",
"httpMethod": "POST",
"id": "dataplex.projects.locations.aspectTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"aspectTypeId": {
"description": "Required. AspectType identifier.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. The service validates the request without performing any mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/aspectTypes",
"request": {
"$ref": "GoogleCloudDataplexV1AspectType"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes an AspectType.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.aspectTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"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"
},
"name": {
"description": "Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets an AspectType.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.aspectTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1AspectType"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.aspectTypes.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists AspectType resources in a project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes",
"httpMethod": "GET",
"id": "dataplex.projects.locations.aspectTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 AspectTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListAspectTypes must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"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 Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/aspectTypes",
"response": {
"$ref": "GoogleCloudDataplexV1ListAspectTypesResponse"
},
"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"
]
},
"patch": {
"description": "Updates an AspectType.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.aspectTypes.patch",
"parameterOrder": [
"name"
],
"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}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1AspectType"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.aspectTypes.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.aspectTypes.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"changeRequests": {
"methods": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.changeRequests.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/changeRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.changeRequests.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/changeRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.changeRequests.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/changeRequests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"dataAttributeBindings": {
"methods": {
"create": {
"deprecated": true,
"description": "Create a DataAttributeBinding resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataAttributeBindings.create",
"parameterOrder": [
"parent"
],
"parameters": {
"dataAttributeBindingId": {
"description": "Required. DataAttributeBinding 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 Location.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/dataAttributeBindings",
"request": {
"$ref": "GoogleCloudDataplexV1DataAttributeBinding"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"deprecated": true,
"description": "Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.dataAttributeBindings.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Required. If the client provided etag value does not match the current etag value, the DeleteDataAttributeBindingRequest method returns an ABORTED error response. Etags must be used when calling the DeleteDataAttributeBinding.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"deprecated": true,
"description": "Retrieves a DataAttributeBinding resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataAttributeBindings.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1DataAttributeBinding"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataAttributeBindings.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"deprecated": true,
"description": "Lists DataAttributeBinding resources in a project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataAttributeBindings.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter request. Filter using resource: filter=resource:\"resource-name\" Filter using attribute: filter=attributes:\"attribute-name\" Filter using attribute in paths list: filter=paths.attributes:\"attribute-name\"",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by fields for the result.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Maximum number of DataAttributeBindings to return. The service may return fewer than this value. If unspecified, at most 10 DataAttributeBindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token received from a previous ListDataAttributeBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributeBindings must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the Location: projects/{project_number}/locations/{location_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dataAttributeBindings",
"response": {
"$ref": "GoogleCloudDataplexV1ListDataAttributeBindingsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"patch": {
"deprecated": true,
"description": "Updates a DataAttributeBinding resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.dataAttributeBindings.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1DataAttributeBinding"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataAttributeBindings.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataAttributeBindings.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"dataDomains": {
"methods": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataDomains/{dataDomainsId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataDomains.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataDomains/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataDomains/{dataDomainsId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataDomains.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataDomains/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataDomains/{dataDomainsId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataDomains.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataDomains/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"dataProducts": {
"methods": {
"create": {
"description": "Creates a data product.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataProducts.create",
"parameterOrder": [
"parent"
],
"parameters": {
"dataProductId": {
"description": "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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource where this data product will be created. Format: projects/{project_id_or_number}/locations/{location_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Validates the request without actually creating the data product. Default: false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/dataProducts",
"request": {
"$ref": "GoogleCloudDataplexV1DataProduct"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes a data product. The deletion will fail if the data product is not empty (i.e. contains at least one data asset).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.dataProducts.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The etag of the data product.If an etag is provided and does not match the current etag of the data product, then the deletion will be blocked and an ABORTED error will be returned.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the data product to delete. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Validates the request without actually deleting the data product. Default: false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets a data product.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataProducts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the data product to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1DataProduct"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataProducts.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists data products for a given project.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataProducts.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter expression that filters data products listed in the response.Example of using this filter is: display_name=\"my-data-product\"",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by expression that orders data products listed in the response.Supported Order by fields are: name or create_time.If not specified, the ordering is undefined.Ordering by create_time is not supported when listing resources across locations (i.e. when request contains /locations/-).",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous ListDataProducts call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to ListDataProducts must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent, which has this collection of data products.Format: projects/{project_id_or_number}/locations/{location_id}.Supports listing across all locations with the wildcard - (hyphen) character. Example: projects/{project_id_or_number}/locations/-",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dataProducts",
"response": {
"$ref": "GoogleCloudDataplexV1ListDataProductsResponse"
},
"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"
]
},
"patch": {
"description": "Updates a data product.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.dataProducts.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. Resource name of the data product. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The list of fields to update. If this is empty or not set, then all the fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Validates the request without actually updating the data product. Default: false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1DataProduct"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"requestAccess": {
"description": "Requests access to a data product. This will trigger an access approval workflow, and the requester will need to wait for the approval to be granted before they will be able to access the data product assets.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}:requestAccess",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataProducts.requestAccess",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:requestAccess",
"request": {
"$ref": "GoogleCloudDataplexV1RequestDataProductAccessRequest"
},
"response": {
"$ref": "GoogleCloudDataplexV1RequestDataProductAccessResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataProducts.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataProducts.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
},
"resources": {
"dataAssets": {
"methods": {
"create": {
"description": "Creates a data asset.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataProducts.dataAssets.create",
"parameterOrder": [
"parent"
],
"parameters": {
"dataAssetId": {
"description": "Optional. The ID of the data asset 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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource where this data asset will be created. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Validates the request without actually creating the data asset. Defaults to false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/dataAssets",
"request": {
"$ref": "GoogleCloudDataplexV1DataAsset"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes a data asset.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets/{dataAssetsId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.dataProducts.dataAssets.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The etag of the data asset. 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"
},
"name": {
"description": "Required. The name of the data asset to delete. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+/dataAssets/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Validates the request without actually deleting the data asset. Defaults to false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets a data asset.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets/{dataAssetsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataProducts.dataAssets.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the data asset to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+/dataAssets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1DataAsset"
},
"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"
]
},
"list": {
"description": "Lists data assets for a given data product.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataProducts.dataAssets.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter expression that filters data assets listed in the response.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by expression that orders data assets listed in the response.Supported order_by fields are: name or create_time.If not specified, the ordering is undefined.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of data assets to return. The service may return fewer than this value. If unspecified, at most 50 data assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous ListDataAssets call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to ListDataAssets must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent, which has this collection of data assets. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dataAssets",
"response": {
"$ref": "GoogleCloudDataplexV1ListDataAssetsResponse"
},
"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"
]
},
"patch": {
"description": "Updates a data asset.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets/{dataAssetsId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.dataProducts.dataAssets.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. Resource name of the data asset. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+/dataAssets/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The list of fields to update. If this is empty or not set, then all the fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Validates the request without actually updating the data asset. Defaults to false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1DataAsset"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
}
}
},
"dataScans": {
"methods": {
"create": {
"description": "Creates a DataScan resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataScans.create",
"parameterOrder": [
"parent"
],
"parameters": {
"dataScanId": {
"description": "Optional. DataScan identifier. If not provided, a unique ID will be generated with the prefix \"data-scan-\". 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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/dataScans",
"request": {
"$ref": "GoogleCloudDataplexV1DataScan"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes a DataScan resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.dataScans.delete",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "Optional. If set to true, any child resources of this data scan will also be deleted. (Otherwise, the request will only work if the data scan has no child resources.)",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where project refers to a project_id or project_number and location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"generateDataQualityRules": {
"description": "Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:generateDataQualityRules",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataScans.generateDataQualityRules",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:generateDataQualityRules",
"request": {
"$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesRequest"
},
"response": {
"$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets a DataScan resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataScans.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where project refers to a project_id or project_number and location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Optional. Select the DataScan view to return. Defaults to BASIC.",
"enum": [
"DATA_SCAN_VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
"The API will default to the BASIC view.",
"Basic view that does not include spec and result.",
"Include everything."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1DataScan"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataScans.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists DataScans.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataScans.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter request.",
"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"
},
"pageSize": {
"description": "Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dataScans",
"response": {
"$ref": "GoogleCloudDataplexV1ListDataScansResponse"
},
"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"
]
},
"patch": {
"description": "Updates a DataScan resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.dataScans.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1DataScan"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"run": {
"description": "Runs an on-demand execution of a DataScan",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:run",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataScans.run",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the DataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}. where project refers to a project_id or project_number and location_id refers to a Google Cloud region.Only OnDemand data scans are allowed.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:run",
"request": {
"$ref": "GoogleCloudDataplexV1RunDataScanRequest"
},
"response": {
"$ref": "GoogleCloudDataplexV1RunDataScanResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataScans.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataScans.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
},
"resources": {
"jobs": {
"methods": {
"cancel": {
"description": "Cancels a running/pending DataScan job.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}:cancel",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataScans.jobs.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the DataScanJob: projects/{project_id_or_number}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id} where project_id_or_number refers to a project_id or project_number and location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "GoogleCloudDataplexV1CancelDataScanJobRequest"
},
"response": {
"$ref": "GoogleCloudDataplexV1CancelDataScanJobResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"generateDataQualityRules": {
"description": "Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}:generateDataQualityRules",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataScans.jobs.generateDataQualityRules",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:generateDataQualityRules",
"request": {
"$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesRequest"
},
"response": {
"$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets a DataScanJob resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataScans.jobs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the DataScanJob: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id} where project refers to a project_id or project_number and location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Optional. Select the DataScanJob view to return. Defaults to BASIC.",
"enum": [
"DATA_SCAN_JOB_VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
"The API will default to the BASIC view.",
"Basic view that does not include spec and result.",
"Include everything."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1DataScanJob"
},
"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"
]
},
"list": {
"description": "Lists DataScanJobs under the given DataScan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataScans.jobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. An expression for filtering the results of the ListDataScanJobs request.If unspecified, all datascan jobs will be returned. Multiple filters can be applied (with AND, OR logical operators). Filters are case-sensitive.Allowed fields are: start_time end_timestart_time and end_time expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00).For instance, 'start_time > 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token received from a previous ListDataScanJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScanJobs must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent environment: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where project refers to a project_id or project_number and location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/jobs",
"response": {
"$ref": "GoogleCloudDataplexV1ListDataScanJobsResponse"
},
"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"
]
}
}
}
}
},
"dataTaxonomies": {
"methods": {
"create": {
"deprecated": true,
"description": "Create a DataTaxonomy resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataTaxonomies.create",
"parameterOrder": [
"parent"
],
"parameters": {
"dataTaxonomyId": {
"description": "Required. DataTaxonomy 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 Project.",
"location": "query",
"type": "string"
},
"parent": {
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/dataTaxonomies",
"request": {
"$ref": "GoogleCloudDataplexV1DataTaxonomy"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"deprecated": true,
"description": "Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.dataTaxonomies.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"deprecated": true,
"description": "Retrieves a DataTaxonomy resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataTaxonomies.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1DataTaxonomy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataTaxonomies.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"deprecated": true,
"description": "Lists DataTaxonomy resources in a project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataTaxonomies.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter request.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by fields for the result.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Maximum number of DataTaxonomies to return. The service may return fewer than this value. If unspecified, at most 10 DataTaxonomies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token received from a previous ListDataTaxonomies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataTaxonomies must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the DataTaxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dataTaxonomies",
"response": {
"$ref": "GoogleCloudDataplexV1ListDataTaxonomiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"patch": {
"deprecated": true,
"description": "Updates a DataTaxonomy resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.dataTaxonomies.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1DataTaxonomy"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataTaxonomies.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataTaxonomies.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
},
"resources": {
"attributes": {
"methods": {
"create": {
"deprecated": true,
"description": "Create a DataAttribute resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataTaxonomies.attributes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"dataAttributeId": {
"description": "Required. DataAttribute 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 DataTaxonomy.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/attributes",
"request": {
"$ref": "GoogleCloudDataplexV1DataAttribute"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"deprecated": true,
"description": "Deletes a Data Attribute resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.dataTaxonomies.attributes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. If the client provided etag value does not match the current etag value, the DeleteDataAttribute method returns an ABORTED error response.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The resource name of the DataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"deprecated": true,
"description": "Retrieves a Data Attribute resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataTaxonomies.attributes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the dataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1DataAttribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataTaxonomies.attributes.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"deprecated": true,
"description": "Lists Data Attribute resources in a DataTaxonomy.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes",
"httpMethod": "GET",
"id": "dataplex.projects.locations.dataTaxonomies.attributes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter request.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by fields for the result.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Maximum number of DataAttributes to return. The service may return fewer than this value. If unspecified, at most 10 dataAttributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token received from a previous ListDataAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributes must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/attributes",
"response": {
"$ref": "GoogleCloudDataplexV1ListDataAttributesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"patch": {
"deprecated": true,
"description": "Updates a DataAttribute resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.dataTaxonomies.attributes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1DataAttribute"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataTaxonomies.attributes.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataTaxonomies.attributes.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
}
}
},
"entryGroups": {
"methods": {
"create": {
"description": "Creates an EntryGroup.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups",
"httpMethod": "POST",
"id": "dataplex.projects.locations.entryGroups.create",
"parameterOrder": [
"parent"
],
"parameters": {
"entryGroupId": {
"description": "Required. EntryGroup identifier.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the entryGroup, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. The service validates the request without performing any mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/entryGroups",
"request": {
"$ref": "GoogleCloudDataplexV1EntryGroup"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes an EntryGroup.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.entryGroups.delete",
"parameterOrder": [
"name"
],
"parameters": {
"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"
},
"name": {
"description": "Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets an EntryGroup.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryGroups.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1EntryGroup"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryGroups.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists EntryGroup resources in a project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryGroups.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter request.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by fields for the result.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListEntryGroups must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"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 Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/entryGroups",
"response": {
"$ref": "GoogleCloudDataplexV1ListEntryGroupsResponse"
},
"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"
]
},
"patch": {
"description": "Updates an EntryGroup.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.entryGroups.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. The service validates the request, without performing any mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1EntryGroup"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.entryGroups.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.entryGroups.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
},
"resources": {
"entries": {
"methods": {
"create": {
"description": "Creates an Entry.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries",
"httpMethod": "POST",
"id": "dataplex.projects.locations.entryGroups.entries.create",
"parameterOrder": [
"parent"
],
"parameters": {
"entryId": {
"description": "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 (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 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 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 providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/entries",
"request": {
"$ref": "GoogleCloudDataplexV1Entry"
},
"response": {
"$ref": "GoogleCloudDataplexV1Entry"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes an Entry.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.entryGroups.entries.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1Entry"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets an Entry.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryGroups.entries.get",
"parameterOrder": [
"name"
],
"parameters": {
"aspectTypes": {
"description": "Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view.",
"location": "query",
"repeated": true,
"type": "string"
},
"name": {
"description": "Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/.*$",
"required": true,
"type": "string"
},
"paths": {
"description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.",
"location": "query",
"repeated": true,
"type": "string"
},
"view": {
"description": "Optional. View to control which parts of an entry the service should return. Please check the limitations on returned aspects in the Entry view documentation. Amount of returned aspects depends on the selected Entry View.",
"enum": [
"ENTRY_VIEW_UNSPECIFIED",
"BASIC",
"FULL",
"CUSTOM",
"ALL"
],
"enumDescriptions": [
"Unspecified EntryView. Defaults to FULL.",
"Returns entry only, without aspects.",
"Returns all required aspects as well as the keys of all non-required aspects.",
"Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.",
"Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1Entry"
},
"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"
]
},
"list": {
"description": "Lists Entries within an EntryGroup.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryGroups.entries.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. A filter on the entries to return. Filters are case-sensitive. You can filter the request by the following fields: entry_type entry_source.display_name parent_entryThe comparison operators are =, !=, <, >, <=, >=. The service compares strings according to lexical order.You can use the logical operators AND, OR, NOT in the filter.You can use Wildcard \"*\", but for entry_type and parent_entry you need to provide the full project id or number.You cannot use parent_entry in conjunction with other fields.Example filter expressions: \"entry_source.display_name=AnExampleDisplayName\" \"entry_type=projects/example-project/locations/global/entryTypes/example-entry_type\" \"entry_type=projects/example-project/locations/us/entryTypes/a* OR entry_type=projects/another-project/locations/*\" \"NOT entry_source.display_name=AnotherExampleDisplayName\" \"parent_entry=projects/example-project/locations/us/entryGroups/example-entry-group/entries/example-entry\"",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/entries",
"response": {
"$ref": "GoogleCloudDataplexV1ListEntriesResponse"
},
"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"
]
},
"patch": {
"description": "Updates an Entry.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.entryGroups.entries.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "Optional. If set to true and the entry doesn't exist, the service will create it.",
"location": "query",
"type": "boolean"
},
"aspectKeys": {
"description": "Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.",
"location": "query",
"repeated": true,
"type": "string"
},
"deleteMissingAspects": {
"description": "Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/.*$",
"required": true,
"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, the service will update all modifiable fields present in the request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1Entry"
},
"response": {
"$ref": "GoogleCloudDataplexV1Entry"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"entryLinks": {
"methods": {
"create": {
"description": "Creates an Entry Link.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entryLinks",
"httpMethod": "POST",
"id": "dataplex.projects.locations.entryGroups.entryLinks.create",
"parameterOrder": [
"parent"
],
"parameters": {
"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"
},
"parent": {
"description": "Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/entryLinks",
"request": {
"$ref": "GoogleCloudDataplexV1EntryLink"
},
"response": {
"$ref": "GoogleCloudDataplexV1EntryLink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes an Entry Link.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entryLinks/{entryLinksId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.entryGroups.entryLinks.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entryLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1EntryLink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets an Entry Link.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entryLinks/{entryLinksId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryGroups.entryLinks.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entryLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1EntryLink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"patch": {
"description": "Updates an Entry Link.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entryLinks/{entryLinksId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.entryGroups.entryLinks.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "Optional. If set to true and the entry link doesn't exist, the service will create it.",
"location": "query",
"type": "boolean"
},
"aspectKeys": {
"description": "Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.",
"location": "query",
"repeated": true,
"type": "string"
},
"name": {
"description": "Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entryLinks/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1EntryLink"
},
"response": {
"$ref": "GoogleCloudDataplexV1EntryLink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
}
}
},
"entryLinkTypes": {
"methods": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryLinkTypes.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryLinkTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.entryLinkTypes.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryLinkTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.entryLinkTypes.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryLinkTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"entryTypes": {
"methods": {
"create": {
"description": "Creates an EntryType.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes",
"httpMethod": "POST",
"id": "dataplex.projects.locations.entryTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"entryTypeId": {
"description": "Required. EntryType identifier.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. The service validates the request without performing any mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/entryTypes",
"request": {
"$ref": "GoogleCloudDataplexV1EntryType"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes an EntryType.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.entryTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"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"
},
"name": {
"description": "Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets an EntryType.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1EntryType"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryTypes.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists EntryType resources in a project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provided to ListEntryTypes must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"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 Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/entryTypes",
"response": {
"$ref": "GoogleCloudDataplexV1ListEntryTypesResponse"
},
"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"
]
},
"patch": {
"description": "Updates an EntryType.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.entryTypes.patch",
"parameterOrder": [
"name"
],
"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}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. The service validates the request without performing any mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1EntryType"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.entryTypes.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.entryTypes.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"glossaries": {
"methods": {
"create": {
"description": "Creates a new Glossary resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries",
"httpMethod": "POST",
"id": "dataplex.projects.locations.glossaries.create",
"parameterOrder": [
"parent"
],
"parameters": {
"glossaryId": {
"description": "Required. Glossary ID: Glossary identifier.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Validates the request without actually creating the Glossary. Default: false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/glossaries",
"request": {
"$ref": "GoogleCloudDataplexV1Glossary"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes a Glossary resource. All the categories and terms within the Glossary must be deleted before the Glossary can be deleted.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.glossaries.delete",
"parameterOrder": [
"name"
],
"parameters": {
"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"
},
"name": {
"description": "Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets a Glossary resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.glossaries.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Glossary to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1Glossary"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.glossaries.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists Glossary resources in a project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries",
"httpMethod": "GET",
"id": "dataplex.projects.locations.glossaries.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter expression that filters Glossaries listed in the response. Filters on proto fields of Glossary are supported. Examples of using a filter are: - display_name=\"my-glossary\" - categoryCount=1 - termCount=0",
"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"
},
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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"
},
"parent": {
"description": "Required. The parent, which has this collection of Glossaries. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/glossaries",
"response": {
"$ref": "GoogleCloudDataplexV1ListGlossariesResponse"
},
"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"
]
},
"patch": {
"description": "Updates a Glossary resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.glossaries.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The list of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Validates the request without actually updating the Glossary. Default: false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1Glossary"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.glossaries.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.glossaries.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
},
"resources": {
"categories": {
"methods": {
"create": {
"description": "Creates a new GlossaryCategory resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories",
"httpMethod": "POST",
"id": "dataplex.projects.locations.glossaries.categories.create",
"parameterOrder": [
"parent"
],
"parameters": {
"categoryId": {
"description": "Required. GlossaryCategory identifier.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/categories",
"request": {
"$ref": "GoogleCloudDataplexV1GlossaryCategory"
},
"response": {
"$ref": "GoogleCloudDataplexV1GlossaryCategory"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes a GlossaryCategory resource. All the GlossaryCategories and GlossaryTerms nested directly under the specified GlossaryCategory will be moved one level up to the parent in the hierarchy.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.glossaries.categories.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/categories/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets a GlossaryCategory resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.glossaries.categories.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the GlossaryCategory to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/categories/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1GlossaryCategory"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.glossaries.categories.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/categories/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists GlossaryCategory resources in a Glossary.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories",
"httpMethod": "GET",
"id": "dataplex.projects.locations.glossaries.categories.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields: - immediate_parentExamples of using a filter are: - immediate_parent=\"projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}\" - immediate_parent=\"projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}\"This will only return the GlossaryCategories that are directly nested under the specified parent.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by expression that orders GlossaryCategories 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"
},
"pageSize": {
"description": "Optional. The maximum number of GlossaryCategories to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryCategories will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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"
},
"parent": {
"description": "Required. The parent, which has this collection of GlossaryCategories. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/categories",
"response": {
"$ref": "GoogleCloudDataplexV1ListGlossaryCategoriesResponse"
},
"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"
]
},
"patch": {
"description": "Updates a GlossaryCategory resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.glossaries.categories.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/categories/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The list of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1GlossaryCategory"
},
"response": {
"$ref": "GoogleCloudDataplexV1GlossaryCategory"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.glossaries.categories.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/categories/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.glossaries.categories.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/categories/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"terms": {
"methods": {
"create": {
"description": "Creates a new GlossaryTerm resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms",
"httpMethod": "POST",
"id": "dataplex.projects.locations.glossaries.terms.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$",
"required": true,
"type": "string"
},
"termId": {
"description": "Required. GlossaryTerm identifier.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/terms",
"request": {
"$ref": "GoogleCloudDataplexV1GlossaryTerm"
},
"response": {
"$ref": "GoogleCloudDataplexV1GlossaryTerm"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes a GlossaryTerm resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.glossaries.terms.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/terms/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets a GlossaryTerm resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.glossaries.terms.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the GlossaryTerm to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/terms/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1GlossaryTerm"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.glossaries.terms.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/terms/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists GlossaryTerm resources in a Glossary.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms",
"httpMethod": "GET",
"id": "dataplex.projects.locations.glossaries.terms.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter expression that filters GlossaryTerms listed in the response. Filters are supported on the following fields: - immediate_parentExamples of using a filter are: - immediate_parent=\"projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}\" - immediate_parent=\"projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}\"This will only return the GlossaryTerms that are directly nested under the specified parent.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by expression that orders GlossaryTerms 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"
},
"pageSize": {
"description": "Optional. The maximum number of GlossaryTerms to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryTerms will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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"
},
"parent": {
"description": "Required. The parent, which has this collection of GlossaryTerms. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/terms",
"response": {
"$ref": "GoogleCloudDataplexV1ListGlossaryTermsResponse"
},
"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"
]
},
"patch": {
"description": "Updates a GlossaryTerm resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.glossaries.terms.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/terms/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The list of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1GlossaryTerm"
},
"response": {
"$ref": "GoogleCloudDataplexV1GlossaryTerm"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.glossaries.terms.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/terms/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.glossaries.terms.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/terms/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
}
}
},
"governanceRules": {
"methods": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/governanceRules/{governanceRulesId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.governanceRules.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/governanceRules/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/governanceRules/{governanceRulesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.governanceRules.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/governanceRules/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/governanceRules/{governanceRulesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.governanceRules.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/governanceRules/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"lakes": {
"methods": {
"create": {
"description": "Creates a lake resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/lakes",
"request": {
"$ref": "GoogleCloudDataplexV1Lake"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.lakes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Retrieves a lake resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1Lake"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists lake resources in a project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter request.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by fields for the result.",
"location": "query",
"type": "string"
},
"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",
"location": "query",
"type": "integer"
},
"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"
},
"parent": {
"description": "Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/lakes",
"response": {
"$ref": "GoogleCloudDataplexV1ListLakesResponse"
},
"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"
]
},
"patch": {
"description": "Updates a lake resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.lakes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1Lake"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
},
"resources": {
"actions": {
"methods": {
"list": {
"description": "Lists action resources in a lake.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/actions",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.actions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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",
"location": "query",
"type": "integer"
},
"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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/actions",
"response": {
"$ref": "GoogleCloudDataplexV1ListActionsResponse"
},
"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"
]
}
}
},
"tasks": {
"methods": {
"create": {
"description": "Creates a task resource within a lake.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.tasks.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
"required": true,
"type": "string"
},
"taskId": {
"description": "Required. Task 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"
}
},
"path": "v1/{+parent}/tasks",
"request": {
"$ref": "GoogleCloudDataplexV1Task"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Delete the task resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.lakes.tasks.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Get task resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.tasks.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1Task"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.tasks.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists tasks under the given lake.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.tasks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter request.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by fields for the result.",
"location": "query",
"type": "string"
},
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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": {
"description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/tasks",
"response": {
"$ref": "GoogleCloudDataplexV1ListTasksResponse"
},
"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"
]
},
"patch": {
"description": "Update the task resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.lakes.tasks.patch",
"parameterOrder": [
"name"
],
"parameters": {
"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",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1Task"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"run": {
"description": "Run an on demand execution of a Task.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:run",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.tasks.run",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:run",
"request": {
"$ref": "GoogleCloudDataplexV1RunTaskRequest"
},
"response": {
"$ref": "GoogleCloudDataplexV1RunTaskResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.tasks.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.tasks.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
},
"resources": {
"jobs": {
"methods": {
"cancel": {
"description": "Cancel jobs running for the task resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}/jobs/{jobsId}:cancel",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.tasks.jobs.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "GoogleCloudDataplexV1CancelJobRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Get job resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}/jobs/{jobsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.tasks.jobs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1Job"
},
"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"
]
},
"list": {
"description": "Lists Jobs under the given task.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}/jobs",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.tasks.jobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/jobs",
"response": {
"$ref": "GoogleCloudDataplexV1ListJobsResponse"
},
"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"
]
}
}
}
}
},
"zones": {
"methods": {
"create": {
"description": "Creates a zone resource within a lake.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.zones.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
},
"zoneId": {
"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\")",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/zones",
"request": {
"$ref": "GoogleCloudDataplexV1Zone"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.lakes.zones.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Retrieves a zone resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1Zone"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists zone resources in a lake.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter request.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by fields for the result.",
"location": "query",
"type": "string"
},
"pageSize": {
"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",
"location": "query",
"type": "integer"
},
"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": {
"description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/zones",
"response": {
"$ref": "GoogleCloudDataplexV1ListZonesResponse"
},
"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"
]
},
"patch": {
"description": "Updates a zone resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.lakes.zones.patch",
"parameterOrder": [
"name"
],
"parameters": {
"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/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1Zone"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.zones.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.zones.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
},
"resources": {
"actions": {
"methods": {
"list": {
"description": "Lists action resources in a zone.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/actions",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.actions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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",
"location": "query",
"type": "integer"
},
"pageToken": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"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/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/actions",
"response": {
"$ref": "GoogleCloudDataplexV1ListActionsResponse"
},
"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"
]
}
}
},
"assets": {
"methods": {
"create": {
"description": "Creates an asset resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.zones.assets.create",
"parameterOrder": [
"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.",
"location": "query",
"type": "string"
},
"parent": {
"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/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/assets",
"request": {
"$ref": "GoogleCloudDataplexV1Asset"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.lakes.zones.assets.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Retrieves an asset resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.assets.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1Asset"
},
"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"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}:getIamPolicy",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.assets.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"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).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists asset resources in a zone.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.assets.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter request.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Order by fields for the result.",
"location": "query",
"type": "string"
},
"pageSize": {
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"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/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/assets",
"response": {
"$ref": "GoogleCloudDataplexV1ListAssetsResponse"
},
"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"
]
},
"patch": {
"description": "Updates an asset resource.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.lakes.zones.assets.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1Asset"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.zones.assets.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.zones.assets.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
},
"resources": {
"actions": {
"methods": {
"list": {
"description": "Lists action resources in an asset.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}/actions",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.assets.actions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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",
"location": "query",
"type": "integer"
},
"pageToken": {
"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",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/actions",
"response": {
"$ref": "GoogleCloudDataplexV1ListActionsResponse"
},
"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"
]
}
}
}
}
},
"entities": {
"methods": {
"create": {
"description": "Create a metadata entity.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.zones.entities.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"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/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/entities",
"request": {
"$ref": "GoogleCloudDataplexV1Entity"
},
"response": {
"$ref": "GoogleCloudDataplexV1Entity"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Delete a metadata entity.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.lakes.zones.entities.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Required. The etag associated with the entity, which can be retrieved with a GetEntity request.",
"location": "query",
"type": "string"
},
"name": {
"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",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Get a metadata entity.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.entities.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Optional. Used to select the subset of entity information to return. Defaults to BASIC.",
"enum": [
"ENTITY_VIEW_UNSPECIFIED",
"BASIC",
"SCHEMA",
"FULL"
],
"enumDescriptions": [
"The API will default to the BASIC view.",
"Minimal view that does not include the schema.",
"Include basic information and schema.",
"Include everything. Currently, this is the same as the SCHEMA view."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1Entity"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "List metadata entities in a zone.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.entities.list",
"parameterOrder": [
"parent"
],
"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\"",
"location": "query",
"type": "string"
},
"pageSize": {
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"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/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Required. Specify the entity view to make a partial list request.",
"enum": [
"ENTITY_VIEW_UNSPECIFIED",
"TABLES",
"FILESETS"
],
"enumDescriptions": [
"The default unset value. Return both table and fileset entities if unspecified.",
"Only list table entities.",
"Only list fileset entities."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/entities",
"response": {
"$ref": "GoogleCloudDataplexV1ListEntitiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"update": {
"description": "Update a metadata entity. Only supports full resource update.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}",
"httpMethod": "PUT",
"id": "dataplex.projects.locations.lakes.zones.entities.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1Entity"
},
"response": {
"$ref": "GoogleCloudDataplexV1Entity"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
},
"resources": {
"partitions": {
"methods": {
"create": {
"description": "Create a metadata partition.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}/partitions",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.zones.entities.partitions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"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/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/partitions",
"request": {
"$ref": "GoogleCloudDataplexV1Partition"
},
"response": {
"$ref": "GoogleCloudDataplexV1Partition"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Delete a metadata partition.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}/partitions/{partitionsId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.lakes.zones.entities.partitions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"deprecated": true,
"description": "Optional. The etag associated with the partition.",
"location": "query",
"type": "string"
},
"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",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+/partitions/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Get a metadata partition of an entity.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}/partitions/{partitionsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.entities.partitions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+/partitions/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1Partition"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "List metadata partitions of an entity.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}/partitions",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lakes.zones.entities.partitions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter the partitions returned to the caller using a key value pair expression. Supported operators and syntax: logic 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",
"type": "string"
},
"pageSize": {
"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",
"location": "query",
"type": "integer"
},
"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"
},
"parent": {
"description": "Required. The resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/entities/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/partitions",
"response": {
"$ref": "GoogleCloudDataplexV1ListPartitionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
}
}
}
}
}
}
},
"metadataFeeds": {
"methods": {
"create": {
"description": "Creates a MetadataFeed.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataFeeds",
"httpMethod": "POST",
"id": "dataplex.projects.locations.metadataFeeds.create",
"parameterOrder": [
"parent"
],
"parameters": {
"metadataFeedId": {
"description": "Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. The service validates the request without performing any mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/metadataFeeds",
"request": {
"$ref": "GoogleCloudDataplexV1MetadataFeed"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"description": "Deletes a MetadataFeed.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataFeeds/{metadataFeedsId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.metadataFeeds.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/MetadataFeeds/{metadata_feed_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/metadataFeeds/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets a MetadataFeed.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataFeeds/{metadataFeedsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.metadataFeeds.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/MetadataFeeds/{metadata_feed_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/metadataFeeds/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1MetadataFeed"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Retrieve a list of MetadataFeeds.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataFeeds",
"httpMethod": "GET",
"id": "dataplex.projects.locations.metadataFeeds.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = \"value1\" labels:key1 name = \"value\"You can combine filters with AND, OR, and NOT operators.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of metadata feeds to return. The service might return fewer feeds than this value. If unspecified, at most 10 feeds are returned. The maximum value is 1,000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The page token received from a previous ListMetadataFeeds call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataFeeds request must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/metadataFeeds",
"response": {
"$ref": "GoogleCloudDataplexV1ListMetadataFeedsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"patch": {
"description": "Updates a MetadataFeed.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataFeeds/{metadataFeedsId}",
"httpMethod": "PATCH",
"id": "dataplex.projects.locations.metadataFeeds.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/metadataFeeds/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Mask of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. Only validate the request, but do not perform mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDataplexV1MetadataFeed"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"metadataJobs": {
"methods": {
"cancel": {
"description": "Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}:cancel",
"httpMethod": "POST",
"id": "dataplex.projects.locations.metadataJobs.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/metadataJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "GoogleCloudDataplexV1CancelMetadataJobRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"create": {
"description": "Creates a metadata job. For example, use a metadata job to import metadata from a third-party system into Dataplex Universal Catalog.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs",
"httpMethod": "POST",
"id": "dataplex.projects.locations.metadataJobs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"metadataJobId": {
"description": "Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "Optional. The service validates the request without performing any mutations. The default is false.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/metadataJobs",
"request": {
"$ref": "GoogleCloudDataplexV1MetadataJob"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"description": "Gets a metadata job.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.metadataJobs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the metadata job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/metadataJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDataplexV1MetadataJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists metadata jobs.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs",
"httpMethod": "GET",
"id": "dataplex.projects.locations.metadataJobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = \"value1\" labels:key1 name = \"value\"You can combine filters with AND, OR, and NOT operators.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The page token received from a previous ListMetadataJobs call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/metadataJobs",
"response": {
"$ref": "GoogleCloudDataplexV1ListMetadataJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
},
"operations": {
"methods": {
"cancel": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "dataplex.projects.locations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "GoogleLongrunningCancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"delete": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "dataplex.projects.locations.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"get": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "dataplex.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"returnPartialSuccess": {
"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to \"projects/example/locations/-\".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dataplex.read-write"
]
}
}
}
}
}
}
}
},
"revision": "20260514",
"rootUrl": "https://dataplex.googleapis.com/",
"schemas": {
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } ",
"id": "Empty",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1Action": {
"description": "Action represents an issue requiring administrator action for resolution.",
"id": "GoogleCloudDataplexV1Action",
"properties": {
"asset": {
"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}.",
"readOnly": true,
"type": "string"
},
"category": {
"description": "The category of issue associated with the action.",
"enum": [
"CATEGORY_UNSPECIFIED",
"RESOURCE_MANAGEMENT",
"SECURITY_POLICY",
"DATA_DISCOVERY"
],
"enumDescriptions": [
"Unspecified category.",
"Resource management related issues.",
"Security policy related issues.",
"Data and discovery related issues."
],
"type": "string"
},
"dataLocations": {
"description": "The list of data locations associated with this action. Cloud Storage locations are represented as URI paths(E.g. gs://bucket/table1/year=2020/month=Jan/). BigQuery locations refer to resource names(E.g. bigquery.googleapis.com/projects/project-id/datasets/dataset-id).",
"items": {
"type": "string"
},
"type": "array"
},
"detectTime": {
"description": "The time that the issue was detected.",
"format": "google-datetime",
"type": "string"
},
"failedSecurityPolicyApply": {
"$ref": "GoogleCloudDataplexV1ActionFailedSecurityPolicyApply",
"description": "Details for issues related to applying security policy."
},
"incompatibleDataSchema": {
"$ref": "GoogleCloudDataplexV1ActionIncompatibleDataSchema",
"description": "Details for issues related to incompatible schemas detected within data."
},
"invalidDataFormat": {
"$ref": "GoogleCloudDataplexV1ActionInvalidDataFormat",
"description": "Details for issues related to invalid or unsupported data formats."
},
"invalidDataOrganization": {
"$ref": "GoogleCloudDataplexV1ActionInvalidDataOrganization",
"description": "Details for issues related to invalid data arrangement."
},
"invalidDataPartition": {
"$ref": "GoogleCloudDataplexV1ActionInvalidDataPartition",
"description": "Details for issues related to invalid or unsupported data partition structure."
},
"issue": {
"description": "Detailed description of the issue requiring action.",
"type": "string"
},
"lake": {
"description": "Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
"readOnly": true,
"type": "string"
},
"missingData": {
"$ref": "GoogleCloudDataplexV1ActionMissingData",
"description": "Details for issues related to absence of data within managed resources."
},
"missingResource": {
"$ref": "GoogleCloudDataplexV1ActionMissingResource",
"description": "Details for issues related to absence of a managed resource."
},
"name": {
"description": "Output only. The relative resource name of the action, of the form: projects/{project}/locations/{location}/lakes/{lake}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action}.",
"readOnly": true,
"type": "string"
},
"unauthorizedResource": {
"$ref": "GoogleCloudDataplexV1ActionUnauthorizedResource",
"description": "Details for issues related to lack of permissions to access data resources."
},
"zone": {
"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}.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ActionFailedSecurityPolicyApply": {
"description": "Failed to apply security policy to the managed resource(s) under a lake, zone or an asset. For a lake or zone resource, one or more underlying assets has a failure applying security policy to the associated managed resource.",
"id": "GoogleCloudDataplexV1ActionFailedSecurityPolicyApply",
"properties": {
"asset": {
"description": "Resource name of one of the assets with failing security policy application. Populated for a lake or zone resource only.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ActionIncompatibleDataSchema": {
"description": "Action details for incompatible schemas detected by discovery.",
"id": "GoogleCloudDataplexV1ActionIncompatibleDataSchema",
"properties": {
"existingSchema": {
"description": "The existing and expected schema of the table. The schema is provided as a JSON formatted structure listing columns and data types.",
"type": "string"
},
"newSchema": {
"description": "The new and incompatible schema within the table. The schema is provided as a JSON formatted structured listing columns and data types.",
"type": "string"
},
"sampledDataLocations": {
"description": "The list of data locations sampled and used for format/schema inference.",
"items": {
"type": "string"
},
"type": "array"
},
"schemaChange": {
"description": "Whether the action relates to a schema that is incompatible or modified.",
"enum": [
"SCHEMA_CHANGE_UNSPECIFIED",
"INCOMPATIBLE",
"MODIFIED"
],
"enumDescriptions": [
"Schema change unspecified.",
"Newly discovered schema is incompatible with existing schema.",
"Newly discovered schema has changed from existing schema for data in a curated zone."
],
"type": "string"
},
"table": {
"description": "The name of the table containing invalid data.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ActionInvalidDataFormat": {
"description": "Action details for invalid or unsupported data files detected by discovery.",
"id": "GoogleCloudDataplexV1ActionInvalidDataFormat",
"properties": {
"expectedFormat": {
"description": "The expected data format of the entity.",
"type": "string"
},
"newFormat": {
"description": "The new unexpected data format within the entity.",
"type": "string"
},
"sampledDataLocations": {
"description": "The list of data locations sampled and used for format/schema inference.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ActionInvalidDataOrganization": {
"description": "Action details for invalid data arrangement.",
"id": "GoogleCloudDataplexV1ActionInvalidDataOrganization",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1ActionInvalidDataPartition": {
"description": "Action details for invalid or unsupported partitions detected by discovery.",
"id": "GoogleCloudDataplexV1ActionInvalidDataPartition",
"properties": {
"expectedStructure": {
"description": "The issue type of InvalidDataPartition.",
"enum": [
"PARTITION_STRUCTURE_UNSPECIFIED",
"CONSISTENT_KEYS",
"HIVE_STYLE_KEYS"
],
"enumDescriptions": [
"PartitionStructure unspecified.",
"Consistent hive-style partition definition (both raw and curated zone).",
"Hive style partition definition (curated zone only)."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ActionMissingData": {
"description": "Action details for absence of data detected by discovery.",
"id": "GoogleCloudDataplexV1ActionMissingData",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1ActionMissingResource": {
"description": "Action details for resource references in assets that cannot be located.",
"id": "GoogleCloudDataplexV1ActionMissingResource",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1ActionUnauthorizedResource": {
"description": "Action details for unauthorized resource issues raised to indicate that the service account associated with the lake instance is not authorized to access or manage the resource associated with an asset.",
"id": "GoogleCloudDataplexV1ActionUnauthorizedResource",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1Aspect": {
"description": "Represents a single piece of metadata describing an entry or entry link.",
"id": "GoogleCloudDataplexV1Aspect",
"properties": {
"aspectSource": {
"$ref": "GoogleCloudDataplexV1AspectSource",
"description": "Optional. Information related to the source system of the aspect."
},
"aspectType": {
"description": "Output only. The resource name of the type used to create this Aspect.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time when the Aspect was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"data": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).",
"type": "object"
},
"path": {
"description": "Output only. The path in the entry under which the aspect is attached.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the Aspect was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AspectSource": {
"description": "Information related to the source system of the aspect.",
"id": "GoogleCloudDataplexV1AspectSource",
"properties": {
"createTime": {
"description": "The time the aspect was created in the source system.",
"format": "google-datetime",
"type": "string"
},
"dataVersion": {
"description": "The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).",
"type": "string"
},
"updateTime": {
"description": "The time the aspect was last updated in the source system.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AspectType": {
"description": "AspectType is a template for creating Aspects, and represents the JSON-schema for a given Entry, for example, BigQuery Table Schema.",
"id": "GoogleCloudDataplexV1AspectType",
"properties": {
"authorization": {
"$ref": "GoogleCloudDataplexV1AspectTypeAuthorization",
"description": "Immutable. Defines the Authorization for this type."
},
"createTime": {
"description": "Output only. The time when the AspectType was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataClassification": {
"description": "Optional. Immutable. Stores data classification of the aspect.",
"enum": [
"DATA_CLASSIFICATION_UNSPECIFIED",
"METADATA_AND_DATA"
],
"enumDescriptions": [
"Denotes that the aspect contains only metadata.",
"Metadata and data classification."
],
"type": "string"
},
"description": {
"description": "Optional. Description of the AspectType.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name.",
"type": "string"
},
"etag": {
"description": "The service computes this checksum. The client may send it on update and delete requests to ensure it has an up-to-date value before proceeding.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the AspectType.",
"type": "object"
},
"metadataTemplate": {
"$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate",
"description": "Required. MetadataTemplate of the aspect."
},
"name": {
"description": "Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.",
"readOnly": true,
"type": "string"
},
"transferStatus": {
"description": "Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.",
"enum": [
"TRANSFER_STATUS_UNSPECIFIED",
"TRANSFER_STATUS_MIGRATED",
"TRANSFER_STATUS_TRANSFERRED"
],
"enumDescriptions": [
"The default value. It is set for resources that were not subject for migration from Data Catalog service.",
"Indicates that a resource was migrated from Data Catalog service but it hasn't been transferred yet. In particular the resource cannot be updated from Dataplex API.",
"Indicates that a resource was transferred from Data Catalog service. The resource can only be updated from Dataplex API."
],
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the AspectType. If you delete and recreate the AspectType with the same name, then this ID will be different.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the AspectType was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AspectTypeAuthorization": {
"description": "Authorization for an AspectType.",
"id": "GoogleCloudDataplexV1AspectTypeAuthorization",
"properties": {
"alternateUsePermission": {
"description": "Immutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex Universal Catalog owned AspectTypes, only settable for Dataplex Universal Catalog owned Types.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AspectTypeMetadataTemplate": {
"description": "MetadataTemplate definition for an AspectType.",
"id": "GoogleCloudDataplexV1AspectTypeMetadataTemplate",
"properties": {
"annotations": {
"$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations",
"description": "Optional. Specifies annotations on this field."
},
"arrayItems": {
"$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate",
"description": "Optional. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload."
},
"constraints": {
"$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints",
"description": "Optional. Specifies the constraints on this field."
},
"enumValues": {
"description": "Optional. The list of values for an enum type. You must define it if the type is enum.",
"items": {
"$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue"
},
"type": "array"
},
"index": {
"description": "Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array \"values\" definitions.",
"format": "int32",
"type": "integer"
},
"mapItems": {
"$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate",
"description": "Optional. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload."
},
"name": {
"description": "Required. The name of the field.",
"type": "string"
},
"recordFields": {
"description": "Optional. Field definition. You must specify it if the type is record. It defines the nested fields.",
"items": {
"$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate"
},
"type": "array"
},
"type": {
"description": "Required. The datatype of this field. The following values are supported:Primitive types: string int bool double datetime. Must be of the format RFC3339 UTC \"Zulu\" (Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\").Complex types: enum array map record",
"type": "string"
},
"typeId": {
"description": "Optional. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it if the field type is record.",
"type": "string"
},
"typeRef": {
"description": "Optional. A reference to another field definition (not an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with record type can refer to other fields.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations": {
"description": "Definition of the annotations of a field.",
"id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations",
"properties": {
"deprecated": {
"description": "Optional. Marks a field as deprecated. You can include a deprecation message.",
"type": "string"
},
"description": {
"description": "Optional. Description for a field.",
"type": "string"
},
"displayName": {
"description": "Optional. Display name for a field.",
"type": "string"
},
"displayOrder": {
"description": "Optional. Display order for a field. You can use this to reorder where a field is rendered.",
"format": "int32",
"type": "integer"
},
"stringType": {
"description": "Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified URL link. resource: A service qualified resource reference.",
"type": "string"
},
"stringValues": {
"description": "Optional. Suggested hints for string fields. You can use them to suggest values to users through console.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints": {
"description": "Definition of the constraints of a field.",
"id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints",
"properties": {
"required": {
"description": "Optional. Marks this field as optional or required.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue": {
"description": "Definition of Enumvalue, to be used for enum fields.",
"id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue",
"properties": {
"deprecated": {
"description": "Optional. You can set this message if you need to deprecate an enum value.",
"type": "string"
},
"index": {
"description": "Required. Index for the enum value. It can't be modified.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Required. Name of the enumvalue. This is the actual value that the aspect can contain.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1Asset": {
"description": "An asset represents a cloud resource that is being managed within a lake as a member of a zone.",
"id": "GoogleCloudDataplexV1Asset",
"properties": {
"createTime": {
"description": "Output only. The time when the asset was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Description of the asset.",
"type": "string"
},
"discoverySpec": {
"$ref": "GoogleCloudDataplexV1AssetDiscoverySpec",
"description": "Optional. Specification of the discovery feature applied to data referenced by this asset. When this spec is left unset, the asset will use the spec set on the parent zone."
},
"discoveryStatus": {
"$ref": "GoogleCloudDataplexV1AssetDiscoveryStatus",
"description": "Output only. Status of the discovery feature applied to data referenced by this asset.",
"readOnly": true
},
"displayName": {
"description": "Optional. User friendly display name.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User defined labels for the asset.",
"type": "object"
},
"name": {
"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}.",
"readOnly": true,
"type": "string"
},
"resourceSpec": {
"$ref": "GoogleCloudDataplexV1AssetResourceSpec",
"description": "Required. Specification of the resource that is referenced by this asset."
},
"resourceStatus": {
"$ref": "GoogleCloudDataplexV1AssetResourceStatus",
"description": "Output only. Status of the resource referenced by this asset.",
"readOnly": true
},
"securityStatus": {
"$ref": "GoogleCloudDataplexV1AssetSecurityStatus",
"description": "Output only. Status of the security policy applied to resource referenced by this asset.",
"readOnly": true
},
"state": {
"description": "Output only. Current state of the asset.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"CREATING",
"DELETING",
"ACTION_REQUIRED"
],
"enumDescriptions": [
"State is not specified.",
"Resource is active, i.e., ready to use.",
"Resource is under creation.",
"Resource is under deletion.",
"Resource is active but has unresolved actions."
],
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the asset was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AssetDiscoverySpec": {
"description": "Settings to manage the metadata discovery and publishing for an asset.",
"id": "GoogleCloudDataplexV1AssetDiscoverySpec",
"properties": {
"csvOptions": {
"$ref": "GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions",
"description": "Optional. Configuration for CSV data."
},
"enabled": {
"description": "Optional. Whether discovery is enabled.",
"type": "boolean"
},
"excludePatterns": {
"description": "Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.",
"items": {
"type": "string"
},
"type": "array"
},
"includePatterns": {
"description": "Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.",
"items": {
"type": "string"
},
"type": "array"
},
"jsonOptions": {
"$ref": "GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions",
"description": "Optional. Configuration for Json data."
},
"schedule": {
"description": "Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes.To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions": {
"description": "Describe CSV and similar semi-structured data formats.",
"id": "GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions",
"properties": {
"delimiter": {
"description": "Optional. The delimiter being used to separate values. This defaults to ','.",
"type": "string"
},
"disableTypeInference": {
"description": "Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.",
"type": "boolean"
},
"encoding": {
"description": "Optional. The character encoding of the data. The default is UTF-8.",
"type": "string"
},
"headerRows": {
"description": "Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions": {
"description": "Describe JSON data format.",
"id": "GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions",
"properties": {
"disableTypeInference": {
"description": "Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).",
"type": "boolean"
},
"encoding": {
"description": "Optional. The character encoding of the data. The default is UTF-8.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AssetDiscoveryStatus": {
"description": "Status of discovery for an asset.",
"id": "GoogleCloudDataplexV1AssetDiscoveryStatus",
"properties": {
"lastRunDuration": {
"description": "The duration of the last discovery run.",
"format": "google-duration",
"type": "string"
},
"lastRunTime": {
"description": "The start time of the last discovery run.",
"format": "google-datetime",
"type": "string"
},
"message": {
"description": "Additional information about the current state.",
"type": "string"
},
"state": {
"description": "The current status of the discovery feature.",
"enum": [
"STATE_UNSPECIFIED",
"SCHEDULED",
"IN_PROGRESS",
"PAUSED",
"DISABLED"
],
"enumDescriptions": [
"State is unspecified.",
"Discovery for the asset is scheduled.",
"Discovery for the asset is running.",
"Discovery for the asset is currently paused (e.g. due to a lack of available resources). It will be automatically resumed.",
"Discovery for the asset is disabled."
],
"type": "string"
},
"stats": {
"$ref": "GoogleCloudDataplexV1AssetDiscoveryStatusStats",
"description": "Data Stats of the asset reported by discovery."
},
"updateTime": {
"description": "Last update time of the status.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AssetDiscoveryStatusStats": {
"description": "The aggregated data statistics for the asset reported by discovery.",
"id": "GoogleCloudDataplexV1AssetDiscoveryStatusStats",
"properties": {
"dataItems": {
"description": "The count of data items within the referenced resource.",
"format": "int64",
"type": "string"
},
"dataSize": {
"description": "The number of stored data bytes within the referenced resource.",
"format": "int64",
"type": "string"
},
"filesets": {
"description": "The count of fileset entities within the referenced resource.",
"format": "int64",
"type": "string"
},
"tables": {
"description": "The count of table entities within the referenced resource.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AssetResourceSpec": {
"description": "Identifies the cloud resource that is referenced by this asset.",
"id": "GoogleCloudDataplexV1AssetResourceSpec",
"properties": {
"name": {
"description": "Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id}",
"type": "string"
},
"readAccessMode": {
"description": "Optional. Determines how read permissions are handled for each asset and their associated tables. Only available to storage buckets assets.",
"enum": [
"ACCESS_MODE_UNSPECIFIED",
"DIRECT",
"MANAGED"
],
"enumDescriptions": [
"Access mode unspecified.",
"Default. Data is accessed directly using storage APIs.",
"Data is accessed through a managed interface using BigQuery APIs."
],
"type": "string"
},
"type": {
"description": "Required. Immutable. Type of resource.",
"enum": [
"TYPE_UNSPECIFIED",
"STORAGE_BUCKET",
"BIGQUERY_DATASET"
],
"enumDescriptions": [
"Type not specified.",
"Cloud Storage bucket.",
"BigQuery dataset."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AssetResourceStatus": {
"description": "Status of the resource referenced by an asset.",
"id": "GoogleCloudDataplexV1AssetResourceStatus",
"properties": {
"managedAccessIdentity": {
"description": "Output only. Service account associated with the BigQuery Connection.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Additional information about the current state.",
"type": "string"
},
"state": {
"description": "The current state of the managed resource.",
"enum": [
"STATE_UNSPECIFIED",
"READY",
"ERROR"
],
"enumDescriptions": [
"State unspecified.",
"Resource does not have any errors.",
"Resource has errors."
],
"type": "string"
},
"updateTime": {
"description": "Last update time of the status.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AssetSecurityStatus": {
"description": "Security policy status of the asset. Data security policy, i.e., readers, writers & owners, should be specified in the lake/zone/asset IAM policy.",
"id": "GoogleCloudDataplexV1AssetSecurityStatus",
"properties": {
"message": {
"description": "Additional information about the current state.",
"type": "string"
},
"state": {
"description": "The current state of the security policy applied to the attached resource.",
"enum": [
"STATE_UNSPECIFIED",
"READY",
"APPLYING",
"ERROR"
],
"enumDescriptions": [
"State unspecified.",
"Security policy has been successfully applied to the attached resource.",
"Security policy is in the process of being applied to the attached resource.",
"Security policy could not be applied to the attached resource due to errors."
],
"type": "string"
},
"updateTime": {
"description": "Last update time of the status.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1AssetStatus": {
"description": "Aggregated status of the underlying assets of a lake or zone.",
"id": "GoogleCloudDataplexV1AssetStatus",
"properties": {
"activeAssets": {
"description": "Number of active assets.",
"format": "int32",
"type": "integer"
},
"securityPolicyApplyingAssets": {
"description": "Number of assets that are in process of updating the security policy on attached resources.",
"format": "int32",
"type": "integer"
},
"updateTime": {
"description": "Last update time of the status.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1BusinessGlossaryEvent": {
"description": "Payload associated with Business Glossary related log events.",
"id": "GoogleCloudDataplexV1BusinessGlossaryEvent",
"properties": {
"eventType": {
"description": "The type of the event.",
"enum": [
"EVENT_TYPE_UNSPECIFIED",
"GLOSSARY_CREATE",
"GLOSSARY_UPDATE",
"GLOSSARY_DELETE",
"GLOSSARY_CATEGORY_CREATE",
"GLOSSARY_CATEGORY_UPDATE",
"GLOSSARY_CATEGORY_DELETE",
"GLOSSARY_TERM_CREATE",
"GLOSSARY_TERM_UPDATE",
"GLOSSARY_TERM_DELETE"
],
"enumDescriptions": [
"An unspecified event type.",
"Glossary create event.",
"Glossary update event.",
"Glossary delete event.",
"Glossary category create event.",
"Glossary category update event.",
"Glossary category delete event.",
"Glossary term create event.",
"Glossary term update event.",
"Glossary term delete event."
],
"type": "string"
},
"message": {
"description": "The log message.",
"type": "string"
},
"resource": {
"description": "Name of the resource.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1CancelDataScanJobRequest": {
"description": "Request message for the CancelDataScanJob method.",
"id": "GoogleCloudDataplexV1CancelDataScanJobRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1CancelDataScanJobResponse": {
"description": "Response message for the CancelDataScanJob method.",
"id": "GoogleCloudDataplexV1CancelDataScanJobResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1CancelJobRequest": {
"description": "Cancel task jobs.",
"id": "GoogleCloudDataplexV1CancelJobRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1CancelMetadataJobRequest": {
"description": "Cancel metadata job request.",
"id": "GoogleCloudDataplexV1CancelMetadataJobRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1ChangeRequest": {
"description": "Represents a proposed change to a metadata resource.",
"id": "GoogleCloudDataplexV1ChangeRequest",
"properties": {
"approver": {
"description": "Output only. The email address of the user who approved/rejected the ChangeRequest.",
"readOnly": true,
"type": "string"
},
"author": {
"description": "Output only. The email address of the user who created the ChangeRequest.",
"readOnly": true,
"type": "string"
},
"changeType": {
"description": "Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.",
"enum": [
"CHANGE_TYPE_UNSPECIFIED",
"CREATE_ENTRY",
"UPDATE_ENTRY",
"DELETE_ENTRY",
"CREATE_ENTRY_LINK",
"DELETE_ENTRY_LINK",
"CREATE_GLOSSARY",
"UPDATE_GLOSSARY",
"DELETE_GLOSSARY",
"CREATE_GLOSSARY_CATEGORY",
"UPDATE_GLOSSARY_CATEGORY",
"DELETE_GLOSSARY_CATEGORY",
"CREATE_GLOSSARY_TERM",
"UPDATE_GLOSSARY_TERM",
"DELETE_GLOSSARY_TERM"
],
"enumDescriptions": [
"State unspecified.",
"Request to create an Entry.",
"Request to update an Entry.",
"Request to delete an Entry.",
"Request to create an EntryLink.",
"Request to delete an EntryLink.",
"Request to create a Glossary.",
"Request to update a Glossary.",
"Request to delete a Glossary.",
"Request to create a GlossaryCategory.",
"Request to update a GlossaryCategory.",
"Request to delete a GlossaryCategory.",
"Request to create a GlossaryTerm.",
"Request to update a GlossaryTerm.",
"Request to delete a GlossaryTerm."
],
"readOnly": true,
"type": "string"
},
"createEntry": {
"$ref": "GoogleCloudDataplexV1CreateEntryRequest",
"description": "Payload for creating an Entry."
},
"createEntryLink": {
"$ref": "GoogleCloudDataplexV1CreateEntryLinkRequest",
"description": "Payload for creating an EntryLink."
},
"createGlossary": {
"$ref": "GoogleCloudDataplexV1CreateGlossaryRequest",
"description": "Payload for creating a Glossary."
},
"createGlossaryCategory": {
"$ref": "GoogleCloudDataplexV1CreateGlossaryCategoryRequest",
"description": "Payload for creating a GlossaryCategory."
},
"createGlossaryTerm": {
"$ref": "GoogleCloudDataplexV1CreateGlossaryTermRequest",
"description": "Payload for creating a GlossaryTerm."
},
"createTime": {
"description": "Output only. The time when the ChangeRequest was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"deleteEntry": {
"$ref": "GoogleCloudDataplexV1DeleteEntryRequest",
"description": "Payload for deleting an Entry."
},
"deleteEntryLink": {
"$ref": "GoogleCloudDataplexV1DeleteEntryLinkRequest",
"description": "Payload for deleting an EntryLink."
},
"deleteGlossary": {
"$ref": "GoogleCloudDataplexV1DeleteGlossaryRequest",
"description": "Payload for deleting a Glossary."
},
"deleteGlossaryCategory": {
"$ref": "GoogleCloudDataplexV1DeleteGlossaryCategoryRequest",
"description": "Payload for deleting a GlossaryCategory."
},
"deleteGlossaryTerm": {
"$ref": "GoogleCloudDataplexV1DeleteGlossaryTermRequest",
"description": "Payload for deleting a GlossaryTerm."
},
"etag": {
"description": "Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
"type": "string"
},
"justification": {
"description": "Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the ChangeRequest.",
"type": "object"
},
"name": {
"description": "Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}",
"type": "string"
},
"rejectionComment": {
"description": "Output only. The reason provided for rejecting the ChangeRequest.",
"readOnly": true,
"type": "string"
},
"resource": {
"description": "Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The current state of the ChangeRequest.",
"enum": [
"STATE_UNSPECIFIED",
"NEW",
"APPROVED",
"REJECTED",
"EXPIRED",
"REVOKED"
],
"enumDescriptions": [
"State unspecified.",
"The change is proposed and new.",
"The change has been approved.",
"The change has been rejected.",
"The change request has expired.",
"The approved change has been revoked."
],
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the ChangeRequest.",
"readOnly": true,
"type": "string"
},
"updateEntry": {
"$ref": "GoogleCloudDataplexV1UpdateEntryRequest",
"description": "Payload for updating an Entry."
},
"updateGlossary": {
"$ref": "GoogleCloudDataplexV1UpdateGlossaryRequest",
"description": "Payload for updating a Glossary."
},
"updateGlossaryCategory": {
"$ref": "GoogleCloudDataplexV1UpdateGlossaryCategoryRequest",
"description": "Payload for updating a GlossaryCategory."
},
"updateGlossaryTerm": {
"$ref": "GoogleCloudDataplexV1UpdateGlossaryTermRequest",
"description": "Payload for updating a GlossaryTerm."
},
"updateTime": {
"description": "Output only. The time when the ChangeRequest was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1CreateEntryLinkRequest": {
"description": "Request message for CreateEntryLink.",
"id": "GoogleCloudDataplexV1CreateEntryLinkRequest",
"properties": {
"entryLink": {
"$ref": "GoogleCloudDataplexV1EntryLink",
"description": "Required. Entry Link resource."
},
"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.",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1CreateEntryRequest": {
"description": "Create Entry request.",
"id": "GoogleCloudDataplexV1CreateEntryRequest",
"properties": {
"entry": {
"$ref": "GoogleCloudDataplexV1Entry",
"description": "Required. Entry resource."
},
"entryId": {
"description": "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 (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 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 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 providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1CreateGlossaryCategoryRequest": {
"description": "Creates a new GlossaryCategory under the specified Glossary.",
"id": "GoogleCloudDataplexV1CreateGlossaryCategoryRequest",
"properties": {
"category": {
"$ref": "GoogleCloudDataplexV1GlossaryCategory",
"description": "Required. The GlossaryCategory to create."
},
"categoryId": {
"description": "Required. GlossaryCategory identifier.",
"type": "string"
},
"parent": {
"description": "Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1CreateGlossaryRequest": {
"description": "Create Glossary Request",
"id": "GoogleCloudDataplexV1CreateGlossaryRequest",
"properties": {
"glossary": {
"$ref": "GoogleCloudDataplexV1Glossary",
"description": "Required. The Glossary to create."
},
"glossaryId": {
"description": "Required. Glossary ID: Glossary identifier.",
"type": "string"
},
"parent": {
"description": "Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.",
"type": "string"
},
"validateOnly": {
"description": "Optional. Validates the request without actually creating the Glossary. Default: false.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDataplexV1CreateGlossaryTermRequest": {
"description": "Creates a new GlossaryTerm under the specified Glossary.",
"id": "GoogleCloudDataplexV1CreateGlossaryTermRequest",
"properties": {
"parent": {
"description": "Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.",
"type": "string"
},
"term": {
"$ref": "GoogleCloudDataplexV1GlossaryTerm",
"description": "Required. The GlossaryTerm to create."
},
"termId": {
"description": "Required. GlossaryTerm identifier.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataAccessSpec": {
"description": "DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access.",
"id": "GoogleCloudDataplexV1DataAccessSpec",
"properties": {
"readers": {
"description": "Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataAsset": {
"description": "Represents a data asset resource that can be packaged and shared via a data product.",
"id": "GoogleCloudDataplexV1DataAsset",
"properties": {
"accessGroupConfigs": {
"additionalProperties": {
"$ref": "GoogleCloudDataplexV1DataAssetAccessGroupConfig"
},
"description": "Optional. Access groups configurations for this data asset.The key is DataProduct.AccessGroup.id and the value is AccessGroupConfig.Example: { \"analyst\": { \"iamRoles\": [\"roles/bigquery.dataViewer\"] } } Currently, at most one IAM role is allowed per access group. For providing multiple predefined IAM roles, wrap them in a custom IAM role as per https://cloud.google.com/iam/docs/creating-custom-roles.",
"type": "object"
},
"createTime": {
"description": "Output only. The time at which the data asset was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"etag": {
"description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the data asset.Example: { \"environment\": \"production\", \"billing\": \"marketing-department\" } ",
"type": "object"
},
"name": {
"description": "Identifier. Resource name of the data asset. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}",
"type": "string"
},
"resource": {
"description": "Required. Immutable. Full resource name of the cloud resource represented by the data asset. This must follow https://cloud.google.com/iam/docs/full-resource-names. Example: //bigquery.googleapis.com/projects/my_project_123/datasets/dataset_456/tables/table_789 Only BigQuery tables and datasets are currently supported. Data asset creator must have getIamPolicy and setIamPolicy permissions on the resource. Data asset creator must also have resource specific get permission, for instance, bigquery.tables.get for BigQuery tables.",
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the data asset. This ID will be different if the data asset is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time at which the data asset was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataAssetAccessGroupConfig": {
"description": "Configuration for access group inherited from the parent data product.",
"id": "GoogleCloudDataplexV1DataAssetAccessGroupConfig",
"properties": {
"iamRoles": {
"description": "Optional. IAM roles granted on the resource to this access group. Role name follows https://cloud.google.com/iam/docs/reference/rest/v1/roles.Example: [ \"roles/bigquery.dataViewer\" ]",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataAttribute": {
"deprecated": true,
"description": "Denotes one dataAttribute in a dataTaxonomy, for example, PII. DataAttribute resources can be defined in a hierarchy. A single dataAttribute resource can contain specs of multiple types PII - ResourceAccessSpec : - readers :foo@bar.com - DataAccessSpec : - readers :bar@foo.com ",
"id": "GoogleCloudDataplexV1DataAttribute",
"properties": {
"attributeCount": {
"description": "Output only. The number of child attributes present for this attribute.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"createTime": {
"description": "Output only. The time when the DataAttribute was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataAccessSpec": {
"$ref": "GoogleCloudDataplexV1DataAccessSpec",
"description": "Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables)."
},
"description": {
"description": "Optional. Description of the DataAttribute.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name.",
"type": "string"
},
"etag": {
"description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the DataAttribute.",
"type": "object"
},
"name": {
"description": "Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.",
"readOnly": true,
"type": "string"
},
"parentId": {
"description": "Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4",
"type": "string"
},
"resourceAccessSpec": {
"$ref": "GoogleCloudDataplexV1ResourceAccessSpec",
"description": "Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table)."
},
"uid": {
"description": "Output only. System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the DataAttribute was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataAttributeBinding": {
"deprecated": true,
"description": "DataAttributeBinding represents binding of attributes to resources. Eg: Bind 'CustomerInfo' entity with 'PII' attribute.",
"id": "GoogleCloudDataplexV1DataAttributeBinding",
"properties": {
"attributes": {
"description": "Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}",
"items": {
"type": "string"
},
"type": "array"
},
"createTime": {
"description": "Output only. The time when the DataAttributeBinding was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Description of the DataAttributeBinding.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name.",
"type": "string"
},
"etag": {
"description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the DataAttributeBinding.",
"type": "object"
},
"name": {
"description": "Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}",
"readOnly": true,
"type": "string"
},
"paths": {
"description": "Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.",
"items": {
"$ref": "GoogleCloudDataplexV1DataAttributeBindingPath"
},
"type": "array"
},
"resource": {
"description": "Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.",
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the DataAttributeBinding was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataAttributeBindingPath": {
"description": "Represents a subresource of the given resource, and associated bindings with it. Currently supported subresources are column and partition schema fields within a table.",
"id": "GoogleCloudDataplexV1DataAttributeBindingPath",
"properties": {
"attributes": {
"description": "Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Required. The name identifier of the path. Nested columns should be of the form: 'address.city'.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDiscoveryResult": {
"description": "The output of a data discovery scan.",
"id": "GoogleCloudDataplexV1DataDiscoveryResult",
"properties": {
"bigqueryPublishing": {
"$ref": "GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing",
"description": "Output only. Configuration for metadata publishing.",
"readOnly": true
},
"scanStatistics": {
"$ref": "GoogleCloudDataplexV1DataDiscoveryResultScanStatistics",
"description": "Output only. Describes result statistics of a data scan discovery job.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing": {
"description": "Describes BigQuery publishing configurations.",
"id": "GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing",
"properties": {
"dataset": {
"description": "Output only. The BigQuery dataset the discovered tables are published to.",
"readOnly": true,
"type": "string"
},
"location": {
"description": "Output only. The location of the BigQuery publishing dataset.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDiscoveryResultScanStatistics": {
"description": "Describes result statistics of a data scan discovery job.",
"id": "GoogleCloudDataplexV1DataDiscoveryResultScanStatistics",
"properties": {
"dataProcessedBytes": {
"description": "The data processed in bytes.",
"format": "int64",
"type": "string"
},
"filesExcluded": {
"description": "The number of files excluded.",
"format": "int32",
"type": "integer"
},
"filesetsCreated": {
"description": "The number of filesets created.",
"format": "int32",
"type": "integer"
},
"filesetsDeleted": {
"description": "The number of filesets deleted.",
"format": "int32",
"type": "integer"
},
"filesetsUpdated": {
"description": "The number of filesets updated.",
"format": "int32",
"type": "integer"
},
"scannedFileCount": {
"description": "The number of files scanned.",
"format": "int32",
"type": "integer"
},
"tablesCreated": {
"description": "The number of tables created.",
"format": "int32",
"type": "integer"
},
"tablesDeleted": {
"description": "The number of tables deleted.",
"format": "int32",
"type": "integer"
},
"tablesUpdated": {
"description": "The number of tables updated.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDiscoverySpec": {
"description": "Spec for a data discovery scan.",
"id": "GoogleCloudDataplexV1DataDiscoverySpec",
"properties": {
"bigqueryPublishingConfig": {
"$ref": "GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig",
"description": "Optional. Configuration for metadata publishing."
},
"storageConfig": {
"$ref": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfig",
"description": "Cloud Storage related configurations."
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig": {
"description": "Describes BigQuery publishing configurations.",
"id": "GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig",
"properties": {
"connection": {
"description": "Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id}",
"type": "string"
},
"location": {
"description": "Optional. The location of the BigQuery dataset to publish BigLake external or non-BigLake external tables to. 1. If the Cloud Storage bucket is located in a multi-region bucket, then BigQuery dataset can be in the same multi-region bucket or any single region that is included in the same multi-region bucket. The datascan can be created in any single region that is included in the same multi-region bucket 2. If the Cloud Storage bucket is located in a dual-region bucket, then BigQuery dataset can be located in regions that are included in the dual-region bucket, or in a multi-region that includes the dual-region. The datascan can be created in any single region that is included in the same dual-region bucket. 3. If the Cloud Storage bucket is located in a single region, then BigQuery dataset can be in the same single region or any multi-region bucket that includes the same single region. The datascan will be created in the same single region as the bucket. 4. If the BigQuery dataset is in single region, it must be in the same single region as the datascan.For supported values, refer to https://cloud.google.com/bigquery/docs/locations#supported_locations.",
"type": "string"
},
"project": {
"description": "Optional. The project of the BigQuery dataset to publish BigLake external or non-BigLake external tables to. If not specified, the project of the Cloud Storage bucket will be used. The format is \"projects/{project_id_or_number}\".",
"type": "string"
},
"tableType": {
"description": "Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables.",
"enum": [
"TABLE_TYPE_UNSPECIFIED",
"EXTERNAL",
"BIGLAKE"
],
"enumDescriptions": [
"Table type unspecified.",
"Default. Discovered tables are published as BigQuery external tables whose data is accessed using the credentials of the user querying the table.",
"Discovered tables are published as BigLake external tables whose data is accessed using the credentials of the associated BigQuery connection."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDiscoverySpecStorageConfig": {
"description": "Configurations related to Cloud Storage as the data source.",
"id": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfig",
"properties": {
"csvOptions": {
"$ref": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions",
"description": "Optional. Configuration for CSV data."
},
"excludePatterns": {
"description": "Optional. Defines the data to exclude during discovery. Provide a list of patterns that identify the data to exclude. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names.",
"items": {
"type": "string"
},
"type": "array"
},
"includePatterns": {
"description": "Optional. Defines the data to include during discovery when only a subset of the data should be considered. Provide a list of patterns that identify the data to include. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names.",
"items": {
"type": "string"
},
"type": "array"
},
"jsonOptions": {
"$ref": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions",
"description": "Optional. Configuration for JSON data."
},
"unstructuredDataOptions": {
"$ref": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigUnstructuredDataOptions",
"description": "Optional. Specifies configuration for unstructured data discovery."
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions": {
"description": "Describes CSV and similar semi-structured data formats.",
"id": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions",
"properties": {
"delimiter": {
"description": "Optional. The delimiter that is used to separate values. The default is , (comma).",
"type": "string"
},
"encoding": {
"description": "Optional. The character encoding of the data. The default is UTF-8.",
"type": "string"
},
"headerRows": {
"description": "Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.",
"format": "int32",
"type": "integer"
},
"quote": {
"description": "Optional. The character used to quote column values. Accepts \" (double quotation mark) or ' (single quotation mark). If unspecified, defaults to \" (double quotation mark).",
"type": "string"
},
"typeInferenceDisabled": {
"description": "Optional. Whether to disable the inference of data types for CSV data. If true, all columns are registered as strings.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions": {
"description": "Describes JSON data format.",
"id": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions",
"properties": {
"encoding": {
"description": "Optional. The character encoding of the data. The default is UTF-8.",
"type": "string"
},
"typeInferenceDisabled": {
"description": "Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean).",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDiscoverySpecStorageConfigUnstructuredDataOptions": {
"description": "Describes options for unstructured data discovery.",
"id": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigUnstructuredDataOptions",
"properties": {
"entityInferenceEnabled": {
"deprecated": true,
"description": "Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled.",
"type": "boolean"
},
"semanticInferenceEnabled": {
"description": "Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDocumentationResult": {
"description": "The output of a DataDocumentation scan.",
"id": "GoogleCloudDataplexV1DataDocumentationResult",
"properties": {
"datasetResult": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResultDatasetResult",
"description": "Output only. Insights for a Dataset resource.",
"readOnly": true
},
"tableResult": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResultTableResult",
"description": "Output only. Insights for a Table resource.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDocumentationResultDatasetResult": {
"description": "Insights for a dataset resource.",
"id": "GoogleCloudDataplexV1DataDocumentationResultDatasetResult",
"properties": {
"overview": {
"description": "Output only. Generated Dataset description.",
"readOnly": true,
"type": "string"
},
"queries": {
"description": "Output only. Sample SQL queries for the dataset.",
"items": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResultQuery"
},
"readOnly": true,
"type": "array"
},
"schemaRelationships": {
"description": "Output only. Relationships suggesting how tables in the dataset are related to each other, based on their schema.",
"items": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResultSchemaRelationship"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDocumentationResultField": {
"description": "Column of a table with generated metadata and nested fields.",
"id": "GoogleCloudDataplexV1DataDocumentationResultField",
"properties": {
"description": {
"description": "Output only. Generated description for columns and fields.",
"readOnly": true,
"type": "string"
},
"fields": {
"description": "Output only. Nested fields.",
"items": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResultField"
},
"readOnly": true,
"type": "array"
},
"name": {
"description": "Output only. The name of the column.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDocumentationResultQuery": {
"description": "A sample SQL query in data documentation.",
"id": "GoogleCloudDataplexV1DataDocumentationResultQuery",
"properties": {
"description": {
"description": "Output only. The description for the query.",
"readOnly": true,
"type": "string"
},
"sql": {
"description": "Output only. The SQL query string which can be executed.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDocumentationResultSchema": {
"description": "Schema of the table with generated metadata of columns.",
"id": "GoogleCloudDataplexV1DataDocumentationResultSchema",
"properties": {
"fields": {
"description": "Output only. The list of columns.",
"items": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResultField"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDocumentationResultSchemaRelationship": {
"description": "Details of the relationship between the schema of two resources.",
"id": "GoogleCloudDataplexV1DataDocumentationResultSchemaRelationship",
"properties": {
"leftSchemaPaths": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResultSchemaRelationshipSchemaPaths",
"description": "Output only. An ordered list of fields for the join from the first table. The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list.",
"readOnly": true
},
"rightSchemaPaths": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResultSchemaRelationshipSchemaPaths",
"description": "Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths. Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list.",
"readOnly": true
},
"sources": {
"description": "Output only. Sources which generated the schema relation edge.",
"items": {
"enum": [
"SOURCE_UNSPECIFIED",
"AGENT",
"QUERY_HISTORY",
"TABLE_CONSTRAINTS"
],
"enumDescriptions": [
"The source of the schema relationship is unspecified.",
"The source of the schema relationship is agent.",
"The source of the schema relationship is query history from the source system.",
"The source of the schema relationship is table constraints added in the source system."
],
"type": "string"
},
"readOnly": true,
"type": "array"
},
"type": {
"description": "Output only. The type of relationship between the schema paths.",
"enum": [
"TYPE_UNSPECIFIED",
"SCHEMA_JOIN"
],
"enumDescriptions": [
"The type of the schema relationship is unspecified.",
"Indicates a join relationship between the schema fields."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDocumentationResultSchemaRelationshipSchemaPaths": {
"description": "Represents an ordered set of paths within a table's schema.",
"id": "GoogleCloudDataplexV1DataDocumentationResultSchemaRelationshipSchemaPaths",
"properties": {
"paths": {
"description": "Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"tableFqn": {
"description": "Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDocumentationResultTableResult": {
"description": "Insights for a table resource.",
"id": "GoogleCloudDataplexV1DataDocumentationResultTableResult",
"properties": {
"name": {
"description": "Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID",
"readOnly": true,
"type": "string"
},
"overview": {
"description": "Output only. Generated description of the table.",
"readOnly": true,
"type": "string"
},
"queries": {
"description": "Output only. Sample SQL queries for the table.",
"items": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResultQuery"
},
"readOnly": true,
"type": "array"
},
"schema": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResultSchema",
"description": "Output only. Schema of the table with generated metadata of the columns in the schema.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataDocumentationSpec": {
"description": "DataDocumentation scan related spec.",
"id": "GoogleCloudDataplexV1DataDocumentationSpec",
"properties": {
"catalogPublishingEnabled": {
"description": "Optional. Whether to publish result to Dataplex Catalog.",
"type": "boolean"
},
"generationScopes": {
"description": "Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.",
"items": {
"enum": [
"GENERATION_SCOPE_UNSPECIFIED",
"ALL",
"TABLE_AND_COLUMN_DESCRIPTIONS",
"SQL_QUERIES"
],
"enumDescriptions": [
"Unspecified generation scope. If no generation scope is specified, all available documentation components will be generated.",
"All the possible results will be generated.",
"Table and column descriptions will be generated.",
"SQL queries will be generated."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProduct": {
"description": "A data product is a curated collection of data assets, packaged to address specific use cases. It's a way to manage and share data in a more organized, product-like manner.",
"id": "GoogleCloudDataplexV1DataProduct",
"properties": {
"accessApprovalConfig": {
"$ref": "GoogleCloudDataplexV1DataProductAccessApprovalConfig",
"description": "Optional. Configuration for access approval for the data product."
},
"accessGroups": {
"additionalProperties": {
"$ref": "GoogleCloudDataplexV1DataProductAccessGroup"
},
"description": "Optional. Data product access groups by access group id as key. If data product is used only for packaging data assets, then access groups may be empty. However, if a data product is used for sharing data assets, then at least one access group must be specified.Example: { \"analyst\": { \"id\": \"analyst\", \"displayName\": \"Analyst\", \"description\": \"Access group for analysts\", \"principal\": { \"googleGroup\": \"analysts@example.com\" } } } ",
"type": "object"
},
"assetCount": {
"description": "Output only. Number of data assets associated with this data product.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"createTime": {
"description": "Output only. The time at which the data product was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Description of the data product.",
"type": "string"
},
"displayName": {
"description": "Required. User-friendly display name of the data product.",
"type": "string"
},
"etag": {
"description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
"type": "string"
},
"icon": {
"description": "Optional. Base64 encoded image representing the data product. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the data product.Example: { \"environment\": \"production\", \"billing\": \"marketing-department\" } ",
"type": "object"
},
"name": {
"description": "Identifier. Resource name of the data product. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}.",
"type": "string"
},
"ownerEmails": {
"description": "Required. Emails of the data product owners.",
"items": {
"type": "string"
},
"type": "array"
},
"uid": {
"description": "Output only. System generated unique ID for the data product. This ID will be different if the data product is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time at which the data product was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProductAccessApprovalConfig": {
"description": "Configuration for access approval for the data product.",
"id": "GoogleCloudDataplexV1DataProductAccessApprovalConfig",
"properties": {
"approverEmails": {
"description": "Optional. Specifies the email addresses of users who are potential approvers and are notified when an access request is made for the data product. The maximum number of emails allowed is 10.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProductAccessGroup": {
"description": "Custom user defined access groups at the data product level. These are used for granting different levels of access (IAM roles) on the individual data product's data assets.",
"id": "GoogleCloudDataplexV1DataProductAccessGroup",
"properties": {
"description": {
"description": "Optional. Description of the access group.",
"type": "string"
},
"displayName": {
"description": "Required. User friendly display name of the access group. Eg. \"Analyst\", \"Developer\", etc.",
"type": "string"
},
"id": {
"description": "Required. Unique identifier of the access group within the data product. User defined. Eg. \"analyst\", \"developer\", etc.",
"type": "string"
},
"principal": {
"$ref": "GoogleCloudDataplexV1DataProductPrincipal",
"description": "Required. The principal entity associated with this access group."
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProductPrincipal": {
"description": "Represents the principal entity associated with an access group, as per https://cloud.google.com/iam/docs/principals-overview.",
"id": "GoogleCloudDataplexV1DataProductPrincipal",
"properties": {
"googleGroup": {
"description": "Optional. Email of the Google Group, as per https://cloud.google.com/iam/docs/principals-overview#google-group.",
"type": "string"
},
"serviceAccount": {
"description": "Optional. Specifies the email of the producer service account, as per https://cloud.google.com/iam/docs/principals-overview#service-account.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileResult": {
"description": "DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result.",
"id": "GoogleCloudDataplexV1DataProfileResult",
"properties": {
"catalogPublishingStatus": {
"$ref": "GoogleCloudDataplexV1DataScanCatalogPublishingStatus",
"description": "Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.",
"readOnly": true
},
"postScanActionsResult": {
"$ref": "GoogleCloudDataplexV1DataProfileResultPostScanActionsResult",
"description": "Output only. The result of post scan actions.",
"readOnly": true
},
"profile": {
"$ref": "GoogleCloudDataplexV1DataProfileResultProfile",
"description": "Output only. The profile information per field.",
"readOnly": true
},
"rowCount": {
"description": "Output only. The count of rows scanned.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"scannedData": {
"$ref": "GoogleCloudDataplexV1ScannedData",
"description": "Output only. The data scanned for this result.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileResultPostScanActionsResult": {
"description": "The result of post scan actions of DataProfileScan job.",
"id": "GoogleCloudDataplexV1DataProfileResultPostScanActionsResult",
"properties": {
"bigqueryExportResult": {
"$ref": "GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult",
"description": "Output only. The result of BigQuery export post scan action.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult": {
"description": "The result of BigQuery export post scan action.",
"id": "GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult",
"properties": {
"message": {
"description": "Output only. Additional information about the BigQuery exporting.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. Execution state for the BigQuery exporting.",
"enum": [
"STATE_UNSPECIFIED",
"SUCCEEDED",
"FAILED",
"SKIPPED"
],
"enumDescriptions": [
"The exporting state is unspecified.",
"The exporting completed successfully.",
"The exporting is no longer running due to an error.",
"The exporting is skipped due to no valid scan result to export (usually caused by scan failed)."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileResultProfile": {
"description": "Contains name, type, mode and field type specific profile information.",
"id": "GoogleCloudDataplexV1DataProfileResultProfile",
"properties": {
"fields": {
"description": "Output only. List of fields with structural and profile information for each field.",
"items": {
"$ref": "GoogleCloudDataplexV1DataProfileResultProfileField"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileResultProfileField": {
"description": "A field within a table.",
"id": "GoogleCloudDataplexV1DataProfileResultProfileField",
"properties": {
"mode": {
"description": "Output only. The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The name of the field.",
"readOnly": true,
"type": "string"
},
"profile": {
"$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo",
"description": "Output only. Profile information for the corresponding field.",
"readOnly": true
},
"type": {
"description": "Output only. The data type retrieved from the schema of the data source. For instance, for a BigQuery native table, it is the BigQuery Table Schema (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablefieldschema). For a Dataplex Universal Catalog Entity, it is the Entity Schema (https://cloud.google.com/dataplex/docs/reference/rpc/google.cloud.dataplex.v1#type_3).",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo": {
"description": "The profile information for each field type.",
"id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo",
"properties": {
"distinctRatio": {
"description": "Output only. Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.",
"format": "double",
"readOnly": true,
"type": "number"
},
"doubleProfile": {
"$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo",
"description": "Double type field information."
},
"integerProfile": {
"$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo",
"description": "Integer type field information."
},
"nullRatio": {
"description": "Output only. Ratio of rows with null value against total scanned rows.",
"format": "double",
"readOnly": true,
"type": "number"
},
"stringProfile": {
"$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo",
"description": "String type field information."
},
"topNValues": {
"description": "Output only. The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.",
"items": {
"$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo": {
"description": "The profile information for a double type field.",
"id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo",
"properties": {
"average": {
"description": "Output only. Average of non-null values in the scanned data. NaN, if the field has a NaN.",
"format": "double",
"readOnly": true,
"type": "number"
},
"max": {
"description": "Output only. Maximum of non-null values in the scanned data. NaN, if the field has a NaN.",
"format": "double",
"readOnly": true,
"type": "number"
},
"min": {
"description": "Output only. Minimum of non-null values in the scanned data. NaN, if the field has a NaN.",
"format": "double",
"readOnly": true,
"type": "number"
},
"quartiles": {
"description": "Output only. A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.",
"items": {
"format": "double",
"type": "number"
},
"readOnly": true,
"type": "array"
},
"standardDeviation": {
"description": "Output only. Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.",
"format": "double",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo": {
"description": "The profile information for an integer type field.",
"id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo",
"properties": {
"average": {
"description": "Output only. Average of non-null values in the scanned data. NaN, if the field has a NaN.",
"format": "double",
"readOnly": true,
"type": "number"
},
"max": {
"description": "Output only. Maximum of non-null values in the scanned data. NaN, if the field has a NaN.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"min": {
"description": "Output only. Minimum of non-null values in the scanned data. NaN, if the field has a NaN.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"quartiles": {
"description": "Output only. A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of approximate quartile values for the scanned data, occurring in order Q1, median, Q3.",
"items": {
"format": "int64",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"standardDeviation": {
"description": "Output only. Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.",
"format": "double",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo": {
"description": "The profile information for a string type field.",
"id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo",
"properties": {
"averageLength": {
"description": "Output only. Average length of non-null values in the scanned data.",
"format": "double",
"readOnly": true,
"type": "number"
},
"maxLength": {
"description": "Output only. Maximum length of non-null values in the scanned data.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"minLength": {
"description": "Output only. Minimum length of non-null values in the scanned data.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue": {
"description": "Top N non-null values in the scanned data.",
"id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue",
"properties": {
"count": {
"description": "Output only. Count of the corresponding value in the scanned data.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"ratio": {
"description": "Output only. Ratio of the corresponding value in the field against the total number of rows in the scanned data.",
"format": "double",
"readOnly": true,
"type": "number"
},
"value": {
"description": "Output only. String value of a top N non-null value.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileSpec": {
"description": "DataProfileScan related setting.",
"id": "GoogleCloudDataplexV1DataProfileSpec",
"properties": {
"catalogPublishingEnabled": {
"description": "Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.",
"type": "boolean"
},
"excludeFields": {
"$ref": "GoogleCloudDataplexV1DataProfileSpecSelectedFields",
"description": "Optional. The fields to exclude from data profile.If specified, the fields will be excluded from data profile, regardless of include_fields value."
},
"includeFields": {
"$ref": "GoogleCloudDataplexV1DataProfileSpecSelectedFields",
"description": "Optional. The fields to include in data profile.If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields."
},
"mode": {
"description": "Optional. The execution mode for the profile scan.",
"enum": [
"MODE_UNSPECIFIED",
"STANDARD",
"LIGHTWEIGHT"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Performs standard profiling. The behavior is controlled by other fields such as sampling_percent, row_filter, and column filters. This mode allows for full scans or custom sampling.",
"Specifies lightweight profiling mode. This mode is optimized for low-latency, low-fidelity profiling.When this mode is selected, the following fields must not be set: sampling_percent, row_filter, include_fields, and exclude_fields."
],
"type": "string"
},
"postScanActions": {
"$ref": "GoogleCloudDataplexV1DataProfileSpecPostScanActions",
"description": "Optional. Actions to take upon job completion.."
},
"rowFilter": {
"description": "Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10",
"type": "string"
},
"samplingPercent": {
"description": "Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileSpecPostScanActions": {
"description": "The configuration of post scan actions of DataProfileScan job.",
"id": "GoogleCloudDataplexV1DataProfileSpecPostScanActions",
"properties": {
"bigqueryExport": {
"$ref": "GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport",
"description": "Optional. If set, results will be exported to the provided BigQuery table."
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport": {
"description": "The configuration of BigQuery export post scan action.",
"id": "GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport",
"properties": {
"resultsTable": {
"description": "Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataProfileSpecSelectedFields": {
"description": "The specification for fields to include or exclude in data profile scan.",
"id": "GoogleCloudDataplexV1DataProfileSpecSelectedFields",
"properties": {
"fieldNames": {
"description": "Optional. Expected input is a list of fully qualified names of fields as in the schema.Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityColumnResult": {
"description": "DataQualityColumnResult provides a more detailed, per-column view of the results.",
"id": "GoogleCloudDataplexV1DataQualityColumnResult",
"properties": {
"column": {
"description": "Output only. The column specified in the DataQualityRule.",
"readOnly": true,
"type": "string"
},
"dimensions": {
"description": "Output only. The dimension-level results for this column.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityDimensionResult"
},
"readOnly": true,
"type": "array"
},
"passed": {
"description": "Output only. Whether the column passed or failed.",
"readOnly": true,
"type": "boolean"
},
"score": {
"description": "Output only. The column-level data quality score for this data scan job if and only if the 'column' field is set.The score ranges between between 0, 100 (up to two decimal points).",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityDimension": {
"description": "A dimension captures data quality intent about a defined subset of the rules specified.",
"id": "GoogleCloudDataplexV1DataQualityDimension",
"properties": {
"name": {
"description": "Output only. The dimension name a rule belongs to. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityDimensionResult": {
"description": "DataQualityDimensionResult provides a more detailed, per-dimension view of the results.",
"id": "GoogleCloudDataplexV1DataQualityDimensionResult",
"properties": {
"dimension": {
"$ref": "GoogleCloudDataplexV1DataQualityDimension",
"description": "Output only. The dimension config specified in the DataQualitySpec, as is.",
"readOnly": true
},
"passed": {
"description": "Output only. Whether the dimension passed or failed.",
"readOnly": true,
"type": "boolean"
},
"score": {
"description": "Output only. The dimension-level data quality score for this data scan job if and only if the 'dimension' field is set.The score ranges between 0, 100 (up to two decimal points).",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityResult": {
"description": "The output of a DataQualityScan.",
"id": "GoogleCloudDataplexV1DataQualityResult",
"properties": {
"anomalyDetectionGeneratedAssets": {
"$ref": "GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets",
"description": "Output only. The generated assets for anomaly detection.",
"readOnly": true
},
"catalogPublishingStatus": {
"$ref": "GoogleCloudDataplexV1DataScanCatalogPublishingStatus",
"description": "Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.",
"readOnly": true
},
"columns": {
"description": "Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityColumnResult"
},
"readOnly": true,
"type": "array"
},
"dimensions": {
"description": "Output only. A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityDimensionResult"
},
"readOnly": true,
"type": "array"
},
"passed": {
"description": "Output only. Overall data quality result -- true if all rules passed.",
"readOnly": true,
"type": "boolean"
},
"postScanActionsResult": {
"$ref": "GoogleCloudDataplexV1DataQualityResultPostScanActionsResult",
"description": "Output only. The result of post scan actions.",
"readOnly": true
},
"rowCount": {
"description": "Output only. The count of rows processed.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"rules": {
"description": "Output only. A list of all the rules in a job, and their results.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleResult"
},
"readOnly": true,
"type": "array"
},
"scannedData": {
"$ref": "GoogleCloudDataplexV1ScannedData",
"description": "Output only. The data scanned for this result.",
"readOnly": true
},
"score": {
"description": "Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points).",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets": {
"description": "The assets generated by Anomaly Detection Data Scan.",
"id": "GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets",
"properties": {
"dataIntermediateTable": {
"description": "Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID",
"readOnly": true,
"type": "string"
},
"freshnessIntermediateTable": {
"description": "Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID",
"readOnly": true,
"type": "string"
},
"resultTable": {
"description": "Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table.",
"readOnly": true,
"type": "string"
},
"volumeIntermediateTable": {
"description": "Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityResultPostScanActionsResult": {
"description": "The result of post scan actions of DataQualityScan job.",
"id": "GoogleCloudDataplexV1DataQualityResultPostScanActionsResult",
"properties": {
"bigqueryExportResult": {
"$ref": "GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult",
"description": "Output only. The result of BigQuery export post scan action.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult": {
"description": "The result of BigQuery export post scan action.",
"id": "GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult",
"properties": {
"message": {
"description": "Output only. Additional information about the BigQuery exporting.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. Execution state for the BigQuery exporting.",
"enum": [
"STATE_UNSPECIFIED",
"SUCCEEDED",
"FAILED",
"SKIPPED"
],
"enumDescriptions": [
"The exporting state is unspecified.",
"The exporting completed successfully.",
"The exporting is no longer running due to an error.",
"The exporting is skipped due to no valid scan result to export (usually caused by scan failed)."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRule": {
"description": "A rule captures data quality intent about a data source.",
"id": "GoogleCloudDataplexV1DataQualityRule",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field.",
"type": "object"
},
"column": {
"description": "Optional. The unnested column which this rule is evaluated against.",
"type": "string"
},
"debugQueries": {
"description": "Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleDebugQuery"
},
"type": "array"
},
"description": {
"description": "Optional. Description of the rule. The maximum length is 1,024 characters.",
"type": "string"
},
"dimension": {
"description": "Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.",
"type": "string"
},
"ignoreNull": {
"description": "Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation",
"type": "boolean"
},
"name": {
"description": "Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.",
"type": "string"
},
"nonNullExpectation": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleNonNullExpectation",
"description": "Row-level rule which evaluates whether each column value is null."
},
"rangeExpectation": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleRangeExpectation",
"description": "Row-level rule which evaluates whether each column value lies between a specified range."
},
"regexExpectation": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleRegexExpectation",
"description": "Row-level rule which evaluates whether each column value matches a specified regex."
},
"rowConditionExpectation": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation",
"description": "Row-level rule which evaluates whether each row in a table passes the specified condition."
},
"ruleSource": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleRuleSource",
"description": "Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable.",
"readOnly": true
},
"setExpectation": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleSetExpectation",
"description": "Row-level rule which evaluates whether each column value is contained by a specified set."
},
"sqlAssertion": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleSqlAssertion",
"description": "Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails."
},
"statisticRangeExpectation": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation",
"description": "Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range."
},
"suspended": {
"description": "Optional. Whether the Rule is active or suspended. Default is false.",
"type": "boolean"
},
"tableConditionExpectation": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation",
"description": "Aggregate rule which evaluates whether the provided expression is true for a table."
},
"templateReference": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleTemplateReference",
"description": "Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails."
},
"threshold": {
"description": "Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules.",
"format": "double",
"type": "number"
},
"uniquenessExpectation": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation",
"description": "Row-level rule which evaluates whether each column value is unique."
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleDebugQuery": {
"description": "Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()}",
"id": "GoogleCloudDataplexV1DataQualityRuleDebugQuery",
"properties": {
"description": {
"description": "Optional. Specifies the description of the debug query. The maximum length is 1,024 characters.",
"type": "string"
},
"sqlStatement": {
"description": "Required. Specifies the SQL statement to be executed.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleNonNullExpectation": {
"description": "Evaluates whether each column value is null.",
"id": "GoogleCloudDataplexV1DataQualityRuleNonNullExpectation",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleRangeExpectation": {
"description": "Evaluates whether each column value lies between a specified range.",
"id": "GoogleCloudDataplexV1DataQualityRuleRangeExpectation",
"properties": {
"maxValue": {
"description": "Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.",
"type": "string"
},
"minValue": {
"description": "Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.",
"type": "string"
},
"strictMaxEnabled": {
"description": "Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.",
"type": "boolean"
},
"strictMinEnabled": {
"description": "Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleRegexExpectation": {
"description": "Evaluates whether each column value matches a specified regex.",
"id": "GoogleCloudDataplexV1DataQualityRuleRegexExpectation",
"properties": {
"regex": {
"description": "Optional. A regular expression the column value is expected to match.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleResult": {
"description": "DataQualityRuleResult provides a more detailed, per-rule view of the results.",
"id": "GoogleCloudDataplexV1DataQualityRuleResult",
"properties": {
"assertionRowCount": {
"description": "Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"debugQueriesResultSets": {
"description": "Output only. Contains the results of all debug queries for this rule. The number of result sets will correspond to the number of debug_queries.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResultSet"
},
"readOnly": true,
"type": "array"
},
"evaluatedCount": {
"description": "Output only. The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"failingRowsQuery": {
"description": "Output only. The query to find rows that did not pass this rule.This field is only valid for row-level type rules.",
"readOnly": true,
"type": "string"
},
"nullCount": {
"description": "Output only. The number of rows with null values in the specified column.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"passRatio": {
"description": "Output only. The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules.",
"format": "double",
"readOnly": true,
"type": "number"
},
"passed": {
"description": "Output only. Whether the rule passed or failed.",
"readOnly": true,
"type": "boolean"
},
"passedCount": {
"description": "Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"rule": {
"$ref": "GoogleCloudDataplexV1DataQualityRule",
"description": "Output only. The rule specified in the DataQualitySpec, as is.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResult": {
"description": "Contains a single result from the debug query.",
"id": "GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResult",
"properties": {
"name": {
"description": "Specifies the name of the result. Available if provided with an explicit alias using [AS] alias.",
"type": "string"
},
"type": {
"description": "Indicates the data type of the result. For more information, see BigQuery data types (https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types).",
"type": "string"
},
"value": {
"description": "Represents the value of the result as a string.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResultSet": {
"description": "Contains all results from a debug query.",
"id": "GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResultSet",
"properties": {
"results": {
"description": "Output only. Contains all results. Up to 10 results can be returned.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResult"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation": {
"description": "Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10",
"id": "GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation",
"properties": {
"sqlExpression": {
"description": "Optional. The SQL expression.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleRuleSource": {
"description": "Represents the rule source information from Catalog.",
"id": "GoogleCloudDataplexV1DataQualityRuleRuleSource",
"properties": {
"rulePathElements": {
"description": "Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElement"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElement": {
"description": "Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself.",
"id": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElement",
"properties": {
"entryLinkSource": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntryLinkSource",
"description": "Output only. Entry link source represents information about the entry link.",
"readOnly": true
},
"entrySource": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntrySource",
"description": "Output only. Entry source represents information about the related source entry.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntryLinkSource": {
"description": "Entry link source represents information about the entry link.",
"id": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntryLinkSource",
"properties": {
"entryLink": {
"description": "Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}",
"readOnly": true,
"type": "string"
},
"entryLinkType": {
"description": "Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntrySource": {
"description": "Entry source represents information about the related source entry.",
"id": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntrySource",
"properties": {
"displayName": {
"description": "Output only. The display name of the entry.",
"readOnly": true,
"type": "string"
},
"entry": {
"description": "Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}",
"readOnly": true,
"type": "string"
},
"entryType": {
"description": "Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleSetExpectation": {
"description": "Evaluates whether each column value is contained by a specified set.",
"id": "GoogleCloudDataplexV1DataQualityRuleSetExpectation",
"properties": {
"values": {
"description": "Optional. Expected values for the column value.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleSqlAssertion": {
"description": "A SQL statement that is evaluated to return rows that match an invalid state. If any rows are are returned, this rule fails.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).Example: SELECT * FROM ${data()} WHERE price < 0",
"id": "GoogleCloudDataplexV1DataQualityRuleSqlAssertion",
"properties": {
"sqlStatement": {
"description": "Optional. The SQL statement.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation": {
"description": "Evaluates whether the column aggregate statistic lies between a specified range.",
"id": "GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation",
"properties": {
"maxValue": {
"description": "Optional. The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.",
"type": "string"
},
"minValue": {
"description": "Optional. The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.",
"type": "string"
},
"statistic": {
"description": "Optional. The aggregate metric to evaluate.",
"enum": [
"STATISTIC_UNDEFINED",
"MEAN",
"MIN",
"MAX"
],
"enumDescriptions": [
"Unspecified statistic type",
"Evaluate the column mean",
"Evaluate the column min",
"Evaluate the column max"
],
"type": "string"
},
"strictMaxEnabled": {
"description": "Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.",
"type": "boolean"
},
"strictMinEnabled": {
"description": "Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation": {
"description": "Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0",
"id": "GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation",
"properties": {
"sqlExpression": {
"description": "Optional. The SQL expression.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleTemplate": {
"description": "DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules.",
"id": "GoogleCloudDataplexV1DataQualityRuleTemplate",
"properties": {
"capabilities": {
"description": "Output only. A list of features or properties supported by this rule template.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"dimension": {
"description": "Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level.",
"readOnly": true,
"type": "string"
},
"inputParameters": {
"additionalProperties": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleTemplateParameterDescription"
},
"description": "Output only. Description for input parameters",
"readOnly": true,
"type": "object"
},
"name": {
"description": "Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}",
"readOnly": true,
"type": "string"
},
"sqlCollection": {
"description": "Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleTemplateSql"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleTemplateParameterDescription": {
"description": "Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template.",
"id": "GoogleCloudDataplexV1DataQualityRuleTemplateParameterDescription",
"properties": {
"defaultValue": {
"description": "Output only. The default value for the parameter if no value is provided.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleTemplateReference": {
"description": "A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails",
"id": "GoogleCloudDataplexV1DataQualityRuleTemplateReference",
"properties": {
"name": {
"description": "Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}",
"type": "string"
},
"resolvedSql": {
"description": "Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result.",
"readOnly": true,
"type": "string"
},
"ruleTemplate": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleTemplate",
"description": "Output only. The rule template used to resolve the rule. It is only populated in the result.",
"readOnly": true
},
"values": {
"additionalProperties": {
"$ref": "GoogleCloudDataplexV1DataQualityRuleTemplateReferenceParameterValue"
},
"description": "Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8).",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleTemplateReferenceParameterValue": {
"description": "Represents a parameter value.",
"id": "GoogleCloudDataplexV1DataQualityRuleTemplateReferenceParameterValue",
"properties": {
"value": {
"description": "Required. Represents the string value of the parameter.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleTemplateSql": {
"description": "Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template.",
"id": "GoogleCloudDataplexV1DataQualityRuleTemplateSql",
"properties": {
"query": {
"description": "Output only. Templatized SQL query for data quality rules.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation": {
"description": "Evaluates whether the column has duplicates.",
"id": "GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1DataQualityScanRuleResult": {
"description": "Information about the result of a data quality rule for data quality scan. The monitored resource is 'DataScan'.",
"id": "GoogleCloudDataplexV1DataQualityScanRuleResult",
"properties": {
"assertionRowCount": {
"description": "The number of rows returned by the SQL statement in a SQL assertion rule. This field is only valid for SQL assertion rules.",
"format": "int64",
"type": "string"
},
"column": {
"description": "The column which this rule is evaluated against.",
"type": "string"
},
"dataSource": {
"description": "The data source of the data scan (e.g. BigQuery table name).",
"type": "string"
},
"evaluatedRowCount": {
"description": "The number of rows evaluated against the data quality rule. This field is only valid for rules of PER_ROW evaluation type.",
"format": "int64",
"type": "string"
},
"evalutionType": {
"description": "The evaluation type of the data quality rule.",
"enum": [
"EVALUATION_TYPE_UNSPECIFIED",
"PER_ROW",
"AGGREGATE"
],
"enumDescriptions": [
"An unspecified evaluation type.",
"The rule evaluation is done at per row level.",
"The rule evaluation is done for an aggregate of rows."
],
"type": "string"
},
"jobId": {
"description": "Identifier of the specific data scan job this log entry is for.",
"type": "string"
},
"nullRowCount": {
"description": "The number of rows with null values in the specified column.",
"format": "int64",
"type": "string"
},
"passedRowCount": {
"description": "The number of rows which passed a rule evaluation. This field is only valid for rules of PER_ROW evaluation type.",
"format": "int64",
"type": "string"
},
"result": {
"description": "The result of the data quality rule.",
"enum": [
"RESULT_UNSPECIFIED",
"PASSED",
"FAILED"
],
"enumDescriptions": [
"An unspecified result.",
"The data quality rule passed.",
"The data quality rule failed."
],
"type": "string"
},
"ruleDimension": {
"description": "The dimension of the data quality rule.",
"type": "string"
},
"ruleName": {
"description": "The name of the data quality rule.",
"type": "string"
},
"ruleType": {
"description": "The type of the data quality rule.",
"enum": [
"RULE_TYPE_UNSPECIFIED",
"NON_NULL_EXPECTATION",
"RANGE_EXPECTATION",
"REGEX_EXPECTATION",
"ROW_CONDITION_EXPECTATION",
"SET_EXPECTATION",
"STATISTIC_RANGE_EXPECTATION",
"TABLE_CONDITION_EXPECTATION",
"UNIQUENESS_EXPECTATION",
"SQL_ASSERTION",
"TEMPLATE_REFERENCE"
],
"enumDescriptions": [
"An unspecified rule type.",
"See DataQualityRule.NonNullExpectation.",
"See DataQualityRule.RangeExpectation.",
"See DataQualityRule.RegexExpectation.",
"See DataQualityRule.RowConditionExpectation.",
"See DataQualityRule.SetExpectation.",
"See DataQualityRule.StatisticRangeExpectation.",
"See DataQualityRule.TableConditionExpectation.",
"See DataQualityRule.UniquenessExpectation.",
"See DataQualityRule.SqlAssertion.",
"See DataQualityRule.TemplateReference."
],
"type": "string"
},
"thresholdPercent": {
"description": "The passing threshold (0.0, 100.0) of the data quality rule.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualitySpec": {
"description": "DataQualityScan related setting.",
"id": "GoogleCloudDataplexV1DataQualitySpec",
"properties": {
"catalogPublishingEnabled": {
"description": "Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.",
"type": "boolean"
},
"enableCatalogBasedRules": {
"description": "Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled.",
"type": "boolean"
},
"filter": {
"description": "Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax (https://docs.cloud.google.com/dataplex/docs/auto-data-quality-overview#rule-filtering) for more details.",
"type": "string"
},
"postScanActions": {
"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActions",
"description": "Optional. Actions to take upon job completion."
},
"rowFilter": {
"description": "Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 >= 0 AND col2 < 10",
"type": "string"
},
"rules": {
"description": "Required. The list of rules to evaluate against a data source. At least one rule is required.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityRule"
},
"type": "array"
},
"samplingPercent": {
"description": "Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualitySpecPostScanActions": {
"description": "The configuration of post scan actions of DataQualityScan.",
"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActions",
"properties": {
"bigqueryExport": {
"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport",
"description": "Optional. If set, results will be exported to the provided BigQuery table."
},
"notificationReport": {
"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport",
"description": "Optional. If set, results will be sent to the provided notification receipts upon triggers."
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport": {
"description": "The configuration of BigQuery export post scan action.",
"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport",
"properties": {
"resultsTable": {
"description": "Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger": {
"description": "This trigger is triggered whenever a scan job run ends, regardless of the result.",
"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger": {
"description": "This trigger is triggered when the scan job itself fails, regardless of the result.",
"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport": {
"description": "The configuration of notification report post scan action.",
"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport",
"properties": {
"jobEndTrigger": {
"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger",
"description": "Optional. If set, report will be sent when a scan job ends."
},
"jobFailureTrigger": {
"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger",
"description": "Optional. If set, report will be sent when a scan job fails."
},
"recipients": {
"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients",
"description": "Required. The recipients who will receive the notification report."
},
"scoreThresholdTrigger": {
"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger",
"description": "Optional. If set, report will be sent when score threshold is met."
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients": {
"description": "The individuals or groups who are designated to receive notifications upon triggers.",
"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients",
"properties": {
"emails": {
"description": "Optional. The email recipients who will receive the DataQualityScan results report.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger": {
"description": "This trigger is triggered when the DQ score in the job result is less than a specified input score.",
"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger",
"properties": {
"scoreThreshold": {
"description": "Optional. The score range is in 0,100.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScan": {
"description": "Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table or dataset metadata and generates insights. For tables, insights include descriptions and sample SQL queries. For datasets, insights include descriptions, schema relationships and sample SQL queries. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights).",
"id": "GoogleCloudDataplexV1DataScan",
"properties": {
"createTime": {
"description": "Output only. The time when the scan was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"data": {
"$ref": "GoogleCloudDataplexV1DataSource",
"description": "Required. The data source for DataScan."
},
"dataDiscoveryResult": {
"$ref": "GoogleCloudDataplexV1DataDiscoveryResult",
"description": "Output only. The result of a data discovery scan.",
"readOnly": true
},
"dataDiscoverySpec": {
"$ref": "GoogleCloudDataplexV1DataDiscoverySpec",
"description": "Settings for a data discovery scan."
},
"dataDocumentationResult": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResult",
"description": "Output only. The result of a data documentation scan.",
"readOnly": true
},
"dataDocumentationSpec": {
"$ref": "GoogleCloudDataplexV1DataDocumentationSpec",
"description": "Settings for a data documentation scan."
},
"dataProfileResult": {
"$ref": "GoogleCloudDataplexV1DataProfileResult",
"description": "Output only. The result of a data profile scan.",
"readOnly": true
},
"dataProfileSpec": {
"$ref": "GoogleCloudDataplexV1DataProfileSpec",
"description": "Settings for a data profile scan."
},
"dataQualityResult": {
"$ref": "GoogleCloudDataplexV1DataQualityResult",
"description": "Output only. The result of a data quality scan.",
"readOnly": true
},
"dataQualitySpec": {
"$ref": "GoogleCloudDataplexV1DataQualitySpec",
"description": "Settings for a data quality scan."
},
"description": {
"description": "Optional. Description of the scan. Must be between 1-1024 characters.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name. Must be between 1-256 characters.",
"type": "string"
},
"executionIdentity": {
"$ref": "GoogleCloudDataplexV1ExecutionIdentity",
"description": "Optional. Immutable. The identity to run the datascan. If not specified, defaults to the Dataplex Service Agent."
},
"executionSpec": {
"$ref": "GoogleCloudDataplexV1DataScanExecutionSpec",
"description": "Optional. DataScan execution settings.If not specified, the fields in it will use their default values."
},
"executionStatus": {
"$ref": "GoogleCloudDataplexV1DataScanExecutionStatus",
"description": "Output only. Status of the data scan execution.",
"readOnly": true
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the scan.",
"type": "object"
},
"name": {
"description": "Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a Google Cloud region.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. Current state of the DataScan.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"CREATING",
"DELETING",
"ACTION_REQUIRED"
],
"enumDescriptions": [
"State is not specified.",
"Resource is active, i.e., ready to use.",
"Resource is under creation.",
"Resource is under deletion.",
"Resource is active but has unresolved actions."
],
"readOnly": true,
"type": "string"
},
"type": {
"description": "Output only. The type of DataScan.",
"enum": [
"DATA_SCAN_TYPE_UNSPECIFIED",
"DATA_QUALITY",
"DATA_PROFILE",
"DATA_DISCOVERY",
"DATA_DOCUMENTATION"
],
"enumDescriptions": [
"The data scan type is unspecified.",
"Data quality scan.",
"Data profile scan.",
"Data discovery scan.",
"Data documentation scan."
],
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the scan was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScanCatalogPublishingStatus": {
"description": "The status of publishing the data scan result as Dataplex Universal Catalog metadata. Multiple DataScan log events may exist, each with different publishing information depending on the type of publishing triggered.",
"id": "GoogleCloudDataplexV1DataScanCatalogPublishingStatus",
"properties": {
"state": {
"description": "Output only. Execution state for publishing.",
"enum": [
"STATE_UNSPECIFIED",
"SUCCEEDED",
"FAILED",
"SKIPPED"
],
"enumDescriptions": [
"The publishing state is unspecified.",
"Publishing to catalog completed successfully.",
"Publish to catalog failed.",
"Publishing to catalog was skipped."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScanEvent": {
"description": "These messages contain information about the execution of a datascan. The monitored resource is 'DataScan'",
"id": "GoogleCloudDataplexV1DataScanEvent",
"properties": {
"catalogPublishingStatus": {
"$ref": "GoogleCloudDataplexV1DataScanCatalogPublishingStatus",
"description": "The status of publishing the data scan as Dataplex Universal Catalog metadata."
},
"createTime": {
"description": "The time when the data scan job was created.",
"format": "google-datetime",
"type": "string"
},
"dataProfile": {
"$ref": "GoogleCloudDataplexV1DataScanEventDataProfileResult",
"description": "Data profile result for data profile type data scan."
},
"dataProfileConfigs": {
"$ref": "GoogleCloudDataplexV1DataScanEventDataProfileAppliedConfigs",
"description": "Applied configs for data profile type data scan."
},
"dataQuality": {
"$ref": "GoogleCloudDataplexV1DataScanEventDataQualityResult",
"description": "Data quality result for data quality type data scan."
},
"dataQualityConfigs": {
"$ref": "GoogleCloudDataplexV1DataScanEventDataQualityAppliedConfigs",
"description": "Applied configs for data quality type data scan."
},
"dataSource": {
"description": "The data source of the data scan",
"type": "string"
},
"endTime": {
"description": "The time when the data scan job finished.",
"format": "google-datetime",
"type": "string"
},
"jobId": {
"description": "The identifier of the specific data scan job this log entry is for.",
"type": "string"
},
"message": {
"description": "The message describing the data scan job event.",
"type": "string"
},
"postScanActionsResult": {
"$ref": "GoogleCloudDataplexV1DataScanEventPostScanActionsResult",
"description": "The result of post scan actions."
},
"scope": {
"description": "The scope of the data scan (e.g. full, incremental).",
"enum": [
"SCOPE_UNSPECIFIED",
"FULL",
"INCREMENTAL"
],
"enumDescriptions": [
"An unspecified scope type.",
"Data scan runs on all of the data.",
"Data scan runs on incremental data."
],
"type": "string"
},
"specVersion": {
"description": "A version identifier of the spec which was used to execute this job.",
"type": "string"
},
"startTime": {
"description": "The time when the data scan job started to run.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "The status of the data scan job.",
"enum": [
"STATE_UNSPECIFIED",
"STARTED",
"SUCCEEDED",
"FAILED",
"CANCELLED",
"CREATED"
],
"enumDescriptions": [
"Unspecified job state.",
"Data scan job started.",
"Data scan job successfully completed.",
"Data scan job was unsuccessful.",
"Data scan job was cancelled.",
"Data scan job was created."
],
"type": "string"
},
"trigger": {
"description": "The trigger type of the data scan job.",
"enum": [
"TRIGGER_UNSPECIFIED",
"ON_DEMAND",
"SCHEDULE",
"ONE_TIME"
],
"enumDescriptions": [
"An unspecified trigger type.",
"Data scan triggers on demand.",
"Data scan triggers as per schedule.",
"Data scan is run one time on creation."
],
"type": "string"
},
"type": {
"description": "The type of the data scan.",
"enum": [
"SCAN_TYPE_UNSPECIFIED",
"DATA_PROFILE",
"DATA_QUALITY",
"DATA_DISCOVERY"
],
"enumDescriptions": [
"An unspecified data scan type.",
"Data scan for data profile.",
"Data scan for data quality.",
"Data scan for data discovery."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScanEventDataProfileAppliedConfigs": {
"description": "Applied configs for data profile type data scan job.",
"id": "GoogleCloudDataplexV1DataScanEventDataProfileAppliedConfigs",
"properties": {
"columnFilterApplied": {
"description": "Boolean indicating whether a column filter was applied in the DataScan job.",
"type": "boolean"
},
"rowFilterApplied": {
"description": "Boolean indicating whether a row filter was applied in the DataScan job.",
"type": "boolean"
},
"samplingPercent": {
"description": "The percentage of the records selected from the dataset for DataScan. Value ranges between 0.0 and 100.0. Value 0.0 or 100.0 imply that sampling was not applied.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScanEventDataProfileResult": {
"description": "Data profile result for data scan job.",
"id": "GoogleCloudDataplexV1DataScanEventDataProfileResult",
"properties": {
"rowCount": {
"description": "The count of rows processed in the data scan job.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScanEventDataQualityAppliedConfigs": {
"description": "Applied configs for data quality type data scan job.",
"id": "GoogleCloudDataplexV1DataScanEventDataQualityAppliedConfigs",
"properties": {
"rowFilterApplied": {
"description": "Boolean indicating whether a row filter was applied in the DataScan job.",
"type": "boolean"
},
"samplingPercent": {
"description": "The percentage of the records selected from the dataset for DataScan. Value ranges between 0.0 and 100.0. Value 0.0 or 100.0 imply that sampling was not applied.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScanEventDataQualityResult": {
"description": "Data quality result for data scan job.",
"id": "GoogleCloudDataplexV1DataScanEventDataQualityResult",
"properties": {
"columnScore": {
"additionalProperties": {
"format": "float",
"type": "number"
},
"description": "The score of each column scanned in the data scan job. The key of the map is the name of the column. The value is the data quality score for the column.The score ranges between 0, 100 (up to two decimal points).",
"type": "object"
},
"dimensionPassed": {
"additionalProperties": {
"type": "boolean"
},
"description": "The result of each dimension for data quality result. The key of the map is the name of the dimension. The value is the bool value depicting whether the dimension result was pass or not.",
"type": "object"
},
"dimensionScore": {
"additionalProperties": {
"format": "float",
"type": "number"
},
"description": "The score of each dimension for data quality result. The key of the map is the name of the dimension. The value is the data quality score for the dimension.The score ranges between 0, 100 (up to two decimal points).",
"type": "object"
},
"passed": {
"description": "Whether the data quality result was pass or not.",
"type": "boolean"
},
"rowCount": {
"description": "The count of rows processed in the data scan job.",
"format": "int64",
"type": "string"
},
"score": {
"description": "The table-level data quality score for the data scan job.The data quality score ranges between 0, 100 (up to two decimal points).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScanEventPostScanActionsResult": {
"description": "Post scan actions result for data scan job.",
"id": "GoogleCloudDataplexV1DataScanEventPostScanActionsResult",
"properties": {
"bigqueryExportResult": {
"$ref": "GoogleCloudDataplexV1DataScanEventPostScanActionsResultBigQueryExportResult",
"description": "The result of BigQuery export post scan action."
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScanEventPostScanActionsResultBigQueryExportResult": {
"description": "The result of BigQuery export post scan action.",
"id": "GoogleCloudDataplexV1DataScanEventPostScanActionsResultBigQueryExportResult",
"properties": {
"message": {
"description": "Additional information about the BigQuery exporting.",
"type": "string"
},
"state": {
"description": "Execution state for the BigQuery exporting.",
"enum": [
"STATE_UNSPECIFIED",
"SUCCEEDED",
"FAILED",
"SKIPPED"
],
"enumDescriptions": [
"The exporting state is unspecified.",
"The exporting completed successfully.",
"The exporting is no longer running due to an error.",
"The exporting is skipped due to no valid scan result to export (usually caused by scan failed)."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScanExecutionSpec": {
"description": "DataScan execution settings.",
"id": "GoogleCloudDataplexV1DataScanExecutionSpec",
"properties": {
"field": {
"description": "Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table.",
"type": "string"
},
"trigger": {
"$ref": "GoogleCloudDataplexV1Trigger",
"description": "Optional. Spec related to how often and when a scan should be triggered.If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API."
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScanExecutionStatus": {
"description": "Status of the data scan execution.",
"id": "GoogleCloudDataplexV1DataScanExecutionStatus",
"properties": {
"latestJobCreateTime": {
"description": "Optional. The time when the DataScanJob execution was created.",
"format": "google-datetime",
"type": "string"
},
"latestJobEndTime": {
"description": "Optional. The time when the latest DataScanJob ended.",
"format": "google-datetime",
"type": "string"
},
"latestJobStartTime": {
"description": "Optional. The time when the latest DataScanJob started.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataScanJob": {
"description": "A DataScanJob represents an instance of DataScan execution.",
"id": "GoogleCloudDataplexV1DataScanJob",
"properties": {
"createTime": {
"description": "Output only. The time when the DataScanJob was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataDiscoveryResult": {
"$ref": "GoogleCloudDataplexV1DataDiscoveryResult",
"description": "Output only. The result of a data discovery scan.",
"readOnly": true
},
"dataDiscoverySpec": {
"$ref": "GoogleCloudDataplexV1DataDiscoverySpec",
"description": "Output only. Settings for a data discovery scan.",
"readOnly": true
},
"dataDocumentationResult": {
"$ref": "GoogleCloudDataplexV1DataDocumentationResult",
"description": "Output only. The result of a data documentation scan.",
"readOnly": true
},
"dataDocumentationSpec": {
"$ref": "GoogleCloudDataplexV1DataDocumentationSpec",
"description": "Output only. Settings for a data documentation scan.",
"readOnly": true
},
"dataProfileResult": {
"$ref": "GoogleCloudDataplexV1DataProfileResult",
"description": "Output only. The result of a data profile scan.",
"readOnly": true
},
"dataProfileSpec": {
"$ref": "GoogleCloudDataplexV1DataProfileSpec",
"description": "Output only. Settings for a data profile scan.",
"readOnly": true
},
"dataQualityResult": {
"$ref": "GoogleCloudDataplexV1DataQualityResult",
"description": "Output only. The result of a data quality scan.",
"readOnly": true
},
"dataQualitySpec": {
"$ref": "GoogleCloudDataplexV1DataQualitySpec",
"description": "Output only. Settings for a data quality scan.",
"readOnly": true
},
"endTime": {
"description": "Output only. The time when the DataScanJob ended.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Output only. Additional information about the current state.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. Identifier. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a Google Cloud region.",
"readOnly": true,
"type": "string"
},
"partialFailureMessage": {
"description": "Output only. A message indicating partial failure details.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. The time when the DataScanJob was started.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. Execution state for the DataScanJob.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELING",
"CANCELLED",
"SUCCEEDED",
"FAILED",
"PENDING",
"SUCCEEDED_WITH_ERRORS"
],
"enumDescriptions": [
"The DataScanJob state is unspecified.",
"The DataScanJob is running.",
"The DataScanJob is canceling.",
"The DataScanJob cancellation was successful.",
"The DataScanJob completed successfully.",
"The DataScanJob is no longer running due to an error.",
"The DataScanJob has been created but not started to run yet.",
"The DataScanJob succeeded with errors."
],
"readOnly": true,
"type": "string"
},
"type": {
"description": "Output only. The type of the parent DataScan.",
"enum": [
"DATA_SCAN_TYPE_UNSPECIFIED",
"DATA_QUALITY",
"DATA_PROFILE",
"DATA_DISCOVERY",
"DATA_DOCUMENTATION"
],
"enumDescriptions": [
"The data scan type is unspecified.",
"Data quality scan.",
"Data profile scan.",
"Data discovery scan.",
"Data documentation scan."
],
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the DataScanJob.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataSource": {
"description": "The data source for DataScan.",
"id": "GoogleCloudDataplexV1DataSource",
"properties": {
"entity": {
"description": "Immutable. The Dataplex Universal Catalog entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.",
"type": "string"
},
"resource": {
"description": "Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type \"TABLE\" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or BigQuery dataset for DataDocumentationScan only Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DataTaxonomy": {
"deprecated": true,
"description": "DataTaxonomy represents a set of hierarchical DataAttributes resources, grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes to manage PII data. It is defined at project level.",
"id": "GoogleCloudDataplexV1DataTaxonomy",
"properties": {
"attributeCount": {
"description": "Output only. The number of attributes in the DataTaxonomy.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"classCount": {
"description": "Output only. The number of classes in the DataTaxonomy.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"createTime": {
"description": "Output only. The time when the DataTaxonomy was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Description of the DataTaxonomy.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name.",
"type": "string"
},
"etag": {
"description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the DataTaxonomy.",
"type": "object"
},
"name": {
"description": "Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.",
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the DataTaxonomy was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DeleteEntryLinkRequest": {
"description": "Request message for DeleteEntryLink.",
"id": "GoogleCloudDataplexV1DeleteEntryLinkRequest",
"properties": {
"name": {
"description": "Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DeleteEntryRequest": {
"description": "Delete Entry request.",
"id": "GoogleCloudDataplexV1DeleteEntryRequest",
"properties": {
"name": {
"description": "Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DeleteGlossaryCategoryRequest": {
"description": "Delete GlossaryCategory Request",
"id": "GoogleCloudDataplexV1DeleteGlossaryCategoryRequest",
"properties": {
"name": {
"description": "Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DeleteGlossaryRequest": {
"description": "Delete Glossary Request",
"id": "GoogleCloudDataplexV1DeleteGlossaryRequest",
"properties": {
"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.",
"type": "string"
},
"name": {
"description": "Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DeleteGlossaryTermRequest": {
"description": "Delete GlossaryTerm Request",
"id": "GoogleCloudDataplexV1DeleteGlossaryTermRequest",
"properties": {
"name": {
"description": "Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DiscoveryEvent": {
"description": "The payload associated with Discovery data processing.",
"id": "GoogleCloudDataplexV1DiscoveryEvent",
"properties": {
"action": {
"$ref": "GoogleCloudDataplexV1DiscoveryEventActionDetails",
"description": "Details about the action associated with the event."
},
"assetId": {
"description": "The id of the associated asset.",
"type": "string"
},
"config": {
"$ref": "GoogleCloudDataplexV1DiscoveryEventConfigDetails",
"description": "Details about discovery configuration in effect."
},
"dataLocation": {
"description": "The data location associated with the event.",
"type": "string"
},
"datascanId": {
"description": "The id of the associated datascan for standalone discovery.",
"type": "string"
},
"entity": {
"$ref": "GoogleCloudDataplexV1DiscoveryEventEntityDetails",
"description": "Details about the entity associated with the event."
},
"lakeId": {
"description": "The id of the associated lake.",
"type": "string"
},
"message": {
"description": "The log message.",
"type": "string"
},
"partition": {
"$ref": "GoogleCloudDataplexV1DiscoveryEventPartitionDetails",
"description": "Details about the partition associated with the event."
},
"table": {
"$ref": "GoogleCloudDataplexV1DiscoveryEventTableDetails",
"description": "Details about the BigQuery table publishing associated with the event."
},
"type": {
"description": "The type of the event being logged.",
"enum": [
"EVENT_TYPE_UNSPECIFIED",
"CONFIG",
"ENTITY_CREATED",
"ENTITY_UPDATED",
"ENTITY_DELETED",
"PARTITION_CREATED",
"PARTITION_UPDATED",
"PARTITION_DELETED",
"TABLE_PUBLISHED",
"TABLE_UPDATED",
"TABLE_IGNORED",
"TABLE_DELETED"
],
"enumDescriptions": [
"An unspecified event type.",
"An event representing discovery configuration in effect.",
"An event representing a metadata entity being created.",
"An event representing a metadata entity being updated.",
"An event representing a metadata entity being deleted.",
"An event representing a partition being created.",
"An event representing a partition being updated.",
"An event representing a partition being deleted.",
"An event representing a table being published.",
"An event representing a table being updated.",
"An event representing a table being skipped in publishing.",
"An event representing a table being deleted."
],
"type": "string"
},
"zoneId": {
"description": "The id of the associated zone.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DiscoveryEventActionDetails": {
"description": "Details about the action.",
"id": "GoogleCloudDataplexV1DiscoveryEventActionDetails",
"properties": {
"issue": {
"description": "The human readable issue associated with the action.",
"type": "string"
},
"type": {
"description": "The type of action. Eg. IncompatibleDataSchema, InvalidDataFormat",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DiscoveryEventConfigDetails": {
"description": "Details about configuration events.",
"id": "GoogleCloudDataplexV1DiscoveryEventConfigDetails",
"properties": {
"parameters": {
"additionalProperties": {
"type": "string"
},
"description": "A list of discovery configuration parameters in effect. The keys are the field paths within DiscoverySpec. Eg. includePatterns, excludePatterns, csvOptions.disableTypeInference, etc.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DiscoveryEventEntityDetails": {
"description": "Details about the entity.",
"id": "GoogleCloudDataplexV1DiscoveryEventEntityDetails",
"properties": {
"entity": {
"description": "The name of the entity resource. The name is the fully-qualified resource name.",
"type": "string"
},
"type": {
"description": "The type of the entity resource.",
"enum": [
"ENTITY_TYPE_UNSPECIFIED",
"TABLE",
"FILESET"
],
"enumDescriptions": [
"An unspecified event type.",
"Entities representing structured data.",
"Entities representing unstructured data."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DiscoveryEventPartitionDetails": {
"description": "Details about the partition.",
"id": "GoogleCloudDataplexV1DiscoveryEventPartitionDetails",
"properties": {
"entity": {
"description": "The name to the containing entity resource. The name is the fully-qualified resource name.",
"type": "string"
},
"partition": {
"description": "The name to the partition resource. The name is the fully-qualified resource name.",
"type": "string"
},
"sampledDataLocations": {
"description": "The locations of the data items (e.g., a Cloud Storage objects) sampled for metadata inference.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "The type of the containing entity resource.",
"enum": [
"ENTITY_TYPE_UNSPECIFIED",
"TABLE",
"FILESET"
],
"enumDescriptions": [
"An unspecified event type.",
"Entities representing structured data.",
"Entities representing unstructured data."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1DiscoveryEventTableDetails": {
"description": "Details about the published table.",
"id": "GoogleCloudDataplexV1DiscoveryEventTableDetails",
"properties": {
"table": {
"description": "The fully-qualified resource name of the table resource.",
"type": "string"
},
"type": {
"description": "The type of the table resource.",
"enum": [
"TABLE_TYPE_UNSPECIFIED",
"EXTERNAL_TABLE",
"BIGLAKE_TABLE",
"OBJECT_TABLE"
],
"enumDescriptions": [
"An unspecified table type.",
"External table type.",
"BigLake table type.",
"Object table type for unstructured data."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EncryptionConfig": {
"description": "A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK).",
"id": "GoogleCloudDataplexV1EncryptionConfig",
"properties": {
"createTime": {
"description": "Output only. The time when the Encryption configuration was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"enableMetastoreEncryption": {
"description": "Optional. Represent the state of CMEK opt-in for metastore.",
"type": "boolean"
},
"encryptionState": {
"description": "Output only. The state of encryption of the databases.",
"enum": [
"ENCRYPTION_STATE_UNSPECIFIED",
"ENCRYPTING",
"COMPLETED",
"FAILED"
],
"enumDescriptions": [
"State is not specified.",
"The encryption state of the database when the EncryptionConfig is created or updated. If the encryption fails, it is retried indefinitely and the state is shown as ENCRYPTING.",
"The encryption of data has completed successfully.",
"The encryption of data has failed. The state is set to FAILED when the encryption fails due to reasons like permission issues, invalid key etc."
],
"readOnly": true,
"type": "string"
},
"etag": {
"description": "Etag of the EncryptionConfig. This is a strong etag.",
"type": "string"
},
"failureDetails": {
"$ref": "GoogleCloudDataplexV1EncryptionConfigFailureDetails",
"description": "Output only. Details of the failure if anything related to Cmek db fails.",
"readOnly": true
},
"key": {
"description": "Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption.",
"type": "string"
},
"name": {
"description": "Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.",
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the Encryption configuration was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EncryptionConfigFailureDetails": {
"description": "Details of the failure if anything related to Cmek db fails.",
"id": "GoogleCloudDataplexV1EncryptionConfigFailureDetails",
"properties": {
"errorCode": {
"description": "Output only. The error code for the failure.",
"enum": [
"UNKNOWN",
"INTERNAL_ERROR",
"REQUIRE_USER_ACTION"
],
"enumDescriptions": [
"The error code is not specified",
"Error because of internal server error, will be retried automatically.",
"User action is required to resolve the error."
],
"readOnly": true,
"type": "string"
},
"errorMessage": {
"description": "Output only. The error message will be shown to the user. Set only if the error code is REQUIRE_USER_ACTION.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1Entity": {
"description": "Represents tables and fileset metadata contained within a zone.",
"id": "GoogleCloudDataplexV1Entity",
"properties": {
"access": {
"$ref": "GoogleCloudDataplexV1StorageAccess",
"description": "Output only. Identifies the access mechanism to the entity. Not user settable.",
"readOnly": true
},
"asset": {
"description": "Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.",
"type": "string"
},
"catalogEntry": {
"description": "Output only. The name of the associated Data Catalog entry.",
"readOnly": true,
"type": "string"
},
"compatibility": {
"$ref": "GoogleCloudDataplexV1EntityCompatibilityStatus",
"description": "Output only. Metadata stores that the entity is compatible with.",
"readOnly": true
},
"createTime": {
"description": "Output only. The time when the entity was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataPath": {
"description": "Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.",
"type": "string"
},
"dataPathPattern": {
"description": "Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.",
"type": "string"
},
"description": {
"description": "Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.",
"type": "string"
},
"displayName": {
"description": "Optional. Display name must be shorter than or equal to 256 characters.",
"type": "string"
},
"etag": {
"description": "Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.",
"type": "string"
},
"format": {
"$ref": "GoogleCloudDataplexV1StorageFormat",
"description": "Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery."
},
"id": {
"description": "Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.",
"type": "string"
},
"name": {
"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}.",
"readOnly": true,
"type": "string"
},
"schema": {
"$ref": "GoogleCloudDataplexV1Schema",
"description": "Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response."
},
"system": {
"description": "Required. Immutable. Identifies the storage system of the entity data.",
"enum": [
"STORAGE_SYSTEM_UNSPECIFIED",
"CLOUD_STORAGE",
"BIGQUERY"
],
"enumDescriptions": [
"Storage system unspecified.",
"The entity data is contained within a Cloud Storage bucket.",
"The entity data is contained within a BigQuery dataset."
],
"type": "string"
},
"type": {
"description": "Required. Immutable. The type of entity.",
"enum": [
"TYPE_UNSPECIFIED",
"TABLE",
"FILESET"
],
"enumDescriptions": [
"Type unspecified.",
"Structured and semi-structured data.",
"Unstructured data."
],
"type": "string"
},
"uid": {
"description": "Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the entity was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EntityCompatibilityStatus": {
"description": "Provides compatibility information for various metadata stores.",
"id": "GoogleCloudDataplexV1EntityCompatibilityStatus",
"properties": {
"bigquery": {
"$ref": "GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility",
"description": "Output only. Whether this entity is compatible with BigQuery.",
"readOnly": true
},
"hiveMetastore": {
"$ref": "GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility",
"description": "Output only. Whether this entity is compatible with Hive Metastore.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility": {
"description": "Provides compatibility information for a specific metadata store.",
"id": "GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility",
"properties": {
"compatible": {
"description": "Output only. Whether the entity is compatible and can be represented in the metadata store.",
"readOnly": true,
"type": "boolean"
},
"reason": {
"description": "Output only. Provides additional detail if the entity is incompatible with the metadata store.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1Entry": {
"description": "An entry is a representation of a data resource that can be described by various metadata.",
"id": "GoogleCloudDataplexV1Entry",
"properties": {
"aspects": {
"additionalProperties": {
"$ref": "GoogleCloudDataplexV1Aspect"
},
"description": "Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}",
"type": "object"
},
"createTime": {
"description": "Output only. The time when the entry was created in Dataplex Universal Catalog.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"entrySource": {
"$ref": "GoogleCloudDataplexV1EntrySource",
"description": "Optional. Information related to the source system of the data resource that is represented by the entry."
},
"entryType": {
"description": "Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.",
"type": "string"
},
"fullyQualifiedName": {
"description": "Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.",
"type": "string"
},
"name": {
"description": "Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.",
"type": "string"
},
"parentEntry": {
"description": "Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.",
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the entry was last updated in Dataplex Universal Catalog.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EntryGroup": {
"description": "An Entry Group represents a logical grouping of one or more Entries.",
"id": "GoogleCloudDataplexV1EntryGroup",
"properties": {
"createTime": {
"description": "Output only. The time when the EntryGroup was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Description of the EntryGroup.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name.",
"type": "string"
},
"etag": {
"description": "This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the EntryGroup.",
"type": "object"
},
"name": {
"description": "Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.",
"readOnly": true,
"type": "string"
},
"transferStatus": {
"description": "Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.",
"enum": [
"TRANSFER_STATUS_UNSPECIFIED",
"TRANSFER_STATUS_MIGRATED",
"TRANSFER_STATUS_TRANSFERRED"
],
"enumDescriptions": [
"The default value. It is set for resources that were not subject for migration from Data Catalog service.",
"Indicates that a resource was migrated from Data Catalog service but it hasn't been transferred yet. In particular the resource cannot be updated from Dataplex API.",
"Indicates that a resource was transferred from Data Catalog service. The resource can only be updated from Dataplex API."
],
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the EntryGroup was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EntryLink": {
"description": "EntryLink represents a link between two Entries.",
"id": "GoogleCloudDataplexV1EntryLink",
"properties": {
"aspects": {
"additionalProperties": {
"$ref": "GoogleCloudDataplexV1Aspect"
},
"description": "Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.",
"type": "object"
},
"createTime": {
"description": "Output only. The time when the Entry Link was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"entryLinkType": {
"description": "Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition",
"type": "string"
},
"entryReferences": {
"description": "Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.",
"items": {
"$ref": "GoogleCloudDataplexV1EntryLinkEntryReference"
},
"type": "array"
},
"name": {
"description": "Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the Entry Link was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EntryLinkEntryReference": {
"description": "Reference to the Entry that is linked through the Entry Link.",
"id": "GoogleCloudDataplexV1EntryLinkEntryReference",
"properties": {
"name": {
"description": "Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}",
"type": "string"
},
"path": {
"description": "Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.",
"type": "string"
},
"type": {
"description": "Required. Immutable. The reference type of the Entry.",
"enum": [
"UNSPECIFIED",
"SOURCE",
"TARGET"
],
"enumDescriptions": [
"Unspecified reference type. Implies that the Entry is referenced in a non-directional Entry Link.",
"The Entry is referenced as the source of the directional Entry Link.",
"The Entry is referenced as the target of the directional Entry Link."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EntryLinkEvent": {
"description": "Payload associated with Entry related log events.",
"id": "GoogleCloudDataplexV1EntryLinkEvent",
"properties": {
"eventType": {
"description": "The type of the event.",
"enum": [
"EVENT_TYPE_UNSPECIFIED",
"ENTRY_LINK_CREATE",
"ENTRY_LINK_DELETE"
],
"enumDescriptions": [
"An unspecified event type.",
"EntryLink create event.",
"EntryLink delete event."
],
"type": "string"
},
"message": {
"description": "The log message.",
"type": "string"
},
"resource": {
"description": "Name of the resource.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EntrySource": {
"description": "Information related to the source system of the data resource that is represented by the entry.",
"id": "GoogleCloudDataplexV1EntrySource",
"properties": {
"ancestors": {
"description": "Immutable. The entries representing the ancestors of the data resource in the source system.",
"items": {
"$ref": "GoogleCloudDataplexV1EntrySourceAncestor"
},
"type": "array"
},
"createTime": {
"description": "The time when the resource was created in the source system.",
"format": "google-datetime",
"type": "string"
},
"description": {
"description": "A description of the data resource. Maximum length is 2,000 characters.",
"type": "string"
},
"displayName": {
"description": "A user-friendly display name. Maximum length is 500 characters.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "User-defined labels. The maximum size of keys and values is 128 characters each.",
"type": "object"
},
"location": {
"description": "Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.",
"readOnly": true,
"type": "string"
},
"platform": {
"description": "The platform containing the source system. Maximum length is 64 characters.",
"type": "string"
},
"resource": {
"description": "The name of the resource in the source system. Maximum length is 4,000 characters.",
"type": "string"
},
"system": {
"description": "The name of the source system. Maximum length is 64 characters.",
"type": "string"
},
"updateTime": {
"description": "The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EntrySourceAncestor": {
"description": "Information about individual items in the hierarchy that is associated with the data resource.",
"id": "GoogleCloudDataplexV1EntrySourceAncestor",
"properties": {
"name": {
"description": "Optional. The name of the ancestor resource.",
"type": "string"
},
"type": {
"description": "Optional. The type of the ancestor resource.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EntryType": {
"description": "Entry Type is a template for creating Entries.",
"id": "GoogleCloudDataplexV1EntryType",
"properties": {
"authorization": {
"$ref": "GoogleCloudDataplexV1EntryTypeAuthorization",
"description": "Immutable. Authorization defined for this type."
},
"createTime": {
"description": "Output only. The time when the EntryType was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Description of the EntryType.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name.",
"type": "string"
},
"etag": {
"description": "Optional. This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the EntryType.",
"type": "object"
},
"name": {
"description": "Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.",
"readOnly": true,
"type": "string"
},
"platform": {
"description": "Optional. The platform that Entries of this type belongs to.",
"type": "string"
},
"requiredAspects": {
"description": "AspectInfo for the entry type.",
"items": {
"$ref": "GoogleCloudDataplexV1EntryTypeAspectInfo"
},
"type": "array"
},
"system": {
"description": "Optional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc",
"type": "string"
},
"typeAliases": {
"description": "Optional. Indicates the classes this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.",
"items": {
"type": "string"
},
"type": "array"
},
"uid": {
"description": "Output only. System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the EntryType was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EntryTypeAspectInfo": {
"id": "GoogleCloudDataplexV1EntryTypeAspectInfo",
"properties": {
"type": {
"description": "Required aspect type for the entry type.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1EntryTypeAuthorization": {
"description": "Authorization for an Entry Type.",
"id": "GoogleCloudDataplexV1EntryTypeAuthorization",
"properties": {
"alternateUsePermission": {
"description": "Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Entries of Dataplex Universal Catalog owned Entry Types, only settable for Dataplex Universal Catalog owned Types.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ExecutionIdentity": {
"description": "The identity to run the datascan.",
"id": "GoogleCloudDataplexV1ExecutionIdentity",
"properties": {
"dataplexServiceAgent": {
"$ref": "GoogleCloudDataplexV1ExecutionIdentityDataplexServiceAgent",
"description": "Optional. The Dataplex service agent associated with the user's project."
},
"serviceAccount": {
"$ref": "GoogleCloudDataplexV1ExecutionIdentityServiceAccount",
"description": "Optional. The provided service account."
},
"userCredential": {
"$ref": "GoogleCloudDataplexV1ExecutionIdentityUserCredential",
"description": "Optional. The credential of the calling user. Supports only ONE_TIME trigger type."
}
},
"type": "object"
},
"GoogleCloudDataplexV1ExecutionIdentityDataplexServiceAgent": {
"description": "The Dataplex service agent associated with the user's project.",
"id": "GoogleCloudDataplexV1ExecutionIdentityDataplexServiceAgent",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1ExecutionIdentityServiceAccount": {
"description": "The service account",
"id": "GoogleCloudDataplexV1ExecutionIdentityServiceAccount",
"properties": {
"email": {
"description": "Required. Service account email. The datascan will execute with this service account's credentials. The user calling this API must have permissions to act as this service account. Dataplex service agent must be granted iam.serviceAccounts.getAccessToken permission on this service account, for example, through the iam.serviceAccountTokenCreator role .",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ExecutionIdentityUserCredential": {
"description": "The credential of the calling user.",
"id": "GoogleCloudDataplexV1ExecutionIdentityUserCredential",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1GenerateDataQualityRulesRequest": {
"description": "Request details for generating data quality rule recommendations.",
"id": "GoogleCloudDataplexV1GenerateDataQualityRulesRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1GenerateDataQualityRulesResponse": {
"description": "Response details for data quality rule recommendations.",
"id": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse",
"properties": {
"rule": {
"description": "The data quality rules that Dataplex Universal Catalog generates based on the results of a data profiling scan.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityRule"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1Glossary": {
"description": "A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it.",
"id": "GoogleCloudDataplexV1Glossary",
"properties": {
"categoryCount": {
"description": "Output only. The number of GlossaryCategories in the Glossary.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"createTime": {
"description": "Output only. The time at which the Glossary was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. The user-mutable description of the Glossary.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.",
"type": "string"
},
"etag": {
"description": "Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the Glossary.",
"type": "object"
},
"name": {
"description": "Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}",
"readOnly": true,
"type": "string"
},
"termCount": {
"description": "Output only. The number of GlossaryTerms in the Glossary.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"uid": {
"description": "Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time at which the Glossary was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1GlossaryCategory": {
"description": "A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other.",
"id": "GoogleCloudDataplexV1GlossaryCategory",
"properties": {
"createTime": {
"description": "Output only. The time at which the GlossaryCategory was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. The user-mutable description of the GlossaryCategory.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the GlossaryCategory.",
"type": "object"
},
"name": {
"description": "Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}",
"readOnly": true,
"type": "string"
},
"parent": {
"description": "Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}",
"type": "string"
},
"uid": {
"description": "Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time at which the GlossaryCategory was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1GlossaryTerm": {
"description": "GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them.",
"id": "GoogleCloudDataplexV1GlossaryTerm",
"properties": {
"createTime": {
"description": "Output only. The time at which the GlossaryTerm was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. The user-mutable description of the GlossaryTerm.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the GlossaryTerm.",
"type": "object"
},
"name": {
"description": "Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}",
"readOnly": true,
"type": "string"
},
"parent": {
"description": "Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}",
"type": "string"
},
"uid": {
"description": "Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time at which the GlossaryTerm was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1GovernanceEvent": {
"description": "Payload associated with Governance related log events.",
"id": "GoogleCloudDataplexV1GovernanceEvent",
"properties": {
"entity": {
"$ref": "GoogleCloudDataplexV1GovernanceEventEntity",
"description": "Entity resource information if the log event is associated with a specific entity."
},
"eventType": {
"description": "The type of the event.",
"enum": [
"EVENT_TYPE_UNSPECIFIED",
"RESOURCE_IAM_POLICY_UPDATE",
"BIGQUERY_TABLE_CREATE",
"BIGQUERY_TABLE_UPDATE",
"BIGQUERY_TABLE_DELETE",
"BIGQUERY_CONNECTION_CREATE",
"BIGQUERY_CONNECTION_UPDATE",
"BIGQUERY_CONNECTION_DELETE",
"BIGQUERY_TAXONOMY_CREATE",
"BIGQUERY_POLICY_TAG_CREATE",
"BIGQUERY_POLICY_TAG_DELETE",
"BIGQUERY_POLICY_TAG_SET_IAM_POLICY",
"ACCESS_POLICY_UPDATE",
"GOVERNANCE_RULE_MATCHED_RESOURCES",
"GOVERNANCE_RULE_SEARCH_LIMIT_EXCEEDS",
"GOVERNANCE_RULE_ERRORS",
"GOVERNANCE_RULE_PROCESSING"
],
"enumDescriptions": [
"An unspecified event type.",
"Resource IAM policy update event.",
"BigQuery table create event.",
"BigQuery table update event.",
"BigQuery table delete event.",
"BigQuery connection create event.",
"BigQuery connection update event.",
"BigQuery connection delete event.",
"BigQuery taxonomy created.",
"BigQuery policy tag created.",
"BigQuery policy tag deleted.",
"BigQuery set iam policy for policy tag.",
"Access policy update event.",
"Number of resources matched with particular Query.",
"Rule processing exceeds the allowed limit.",
"Rule processing errors.",
"Governance rule processing Event."
],
"type": "string"
},
"message": {
"description": "The log message.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1GovernanceEventEntity": {
"description": "Information about Entity resource that the log event is associated with.",
"id": "GoogleCloudDataplexV1GovernanceEventEntity",
"properties": {
"entity": {
"description": "The Entity resource the log event is associated with. Format: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}",
"type": "string"
},
"entityType": {
"description": "Type of entity.",
"enum": [
"ENTITY_TYPE_UNSPECIFIED",
"TABLE",
"FILESET"
],
"enumDescriptions": [
"An unspecified Entity type.",
"Table entity type.",
"Fileset entity type."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ImportItem": {
"description": "An object that describes the values that you want to set for an entry and its attached aspects when you import metadata. Used when you run a metadata import job. See CreateMetadataJob.You provide a collection of import items in a metadata import file. For more information about how to create a metadata import file, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).",
"id": "GoogleCloudDataplexV1ImportItem",
"properties": {
"aspectKeys": {
"description": "The aspects to modify. Supports the following syntaxes: {aspect_type_reference}: matches aspects that belong to the specified aspect type and are attached directly to the entry. {aspect_type_reference}@{path}: matches aspects that belong to the specified aspect type and path. {aspect_type_reference}@* : matches aspects of the given type for all paths. *@path : matches aspects of all types on the given path.Replace {aspect_type_reference} with a reference to the aspect type, in the format {project_id_or_number}.{location_id}.{aspect_type_id}.In FULL entry sync mode, if you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry. Dataplex Universal Catalog implicitly adds the keys for all of the required aspects of an entry.",
"items": {
"type": "string"
},
"type": "array"
},
"entry": {
"$ref": "GoogleCloudDataplexV1Entry",
"description": "Information about an entry and its attached aspects."
},
"entryLink": {
"$ref": "GoogleCloudDataplexV1EntryLink",
"description": "Information about the entry link. User should provide either one of the entry or entry_link. While providing entry_link, user should not provide update_mask and aspect_keys."
},
"updateMask": {
"description": "The fields to update, in paths that are relative to the Entry resource. Separate each field with a comma.In FULL entry sync mode, Dataplex Universal Catalog includes the paths of all of the fields for an entry that can be modified, including aspects. This means that Dataplex Universal Catalog replaces the existing entry with the entry in the metadata import file. All modifiable fields are updated, regardless of the fields that are listed in the update mask, and regardless of whether a field is present in the entry object.The update_mask field is ignored when an entry is created or re-created.In an aspect-only metadata job (when entry sync mode is NONE), set this value to aspects.Dataplex Universal Catalog also determines which entries and aspects to modify by comparing the values and timestamps that you provide in the metadata import file with the values and timestamps that exist in your project. For more information, see Comparison logic (https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic).",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1Job": {
"description": "A job represents an instance of a task.",
"id": "GoogleCloudDataplexV1Job",
"properties": {
"endTime": {
"description": "Output only. The time when the job ended.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"executionSpec": {
"$ref": "GoogleCloudDataplexV1TaskExecutionSpec",
"description": "Output only. Spec related to how a task is executed.",
"readOnly": true
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Output only. User-defined labels for the task.",
"readOnly": true,
"type": "object"
},
"message": {
"description": "Output only. Additional information about the current state.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.",
"readOnly": true,
"type": "string"
},
"retryCount": {
"description": "Output only. The number of times the job has been retried (excluding the initial attempt).",
"format": "uint32",
"readOnly": true,
"type": "integer"
},
"service": {
"description": "Output only. The underlying service running a job.",
"enum": [
"SERVICE_UNSPECIFIED",
"DATAPROC"
],
"enumDescriptions": [
"Service used to run the job is unspecified.",
"Dataproc service is used to run this job."
],
"readOnly": true,
"type": "string"
},
"serviceJob": {
"description": "Output only. The full resource name for the job run under a particular service.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. The time when the job was started.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. Execution state for the job.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"CANCELLED",
"SUCCEEDED",
"FAILED",
"ABORTED"
],
"enumDescriptions": [
"The job state is unknown.",
"The job is running.",
"The job is cancelling.",
"The job cancellation was successful.",
"The job completed successfully.",
"The job is no longer running due to an error.",
"The job was cancelled outside of Dataplex Universal Catalog."
],
"readOnly": true,
"type": "string"
},
"trigger": {
"description": "Output only. Job execution trigger.",
"enum": [
"TRIGGER_UNSPECIFIED",
"TASK_CONFIG",
"RUN_REQUEST"
],
"enumDescriptions": [
"The trigger is unspecified.",
"The job was triggered by Dataplex Universal Catalog based on trigger spec from task definition.",
"The job was triggered by the explicit call of Task API."
],
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the job.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1JobEvent": {
"description": "The payload associated with Job logs that contains events describing jobs that have run within a Lake.",
"id": "GoogleCloudDataplexV1JobEvent",
"properties": {
"endTime": {
"description": "The time when the job ended running.",
"format": "google-datetime",
"type": "string"
},
"executionTrigger": {
"description": "Job execution trigger.",
"enum": [
"EXECUTION_TRIGGER_UNSPECIFIED",
"TASK_CONFIG",
"RUN_REQUEST"
],
"enumDescriptions": [
"The job execution trigger is unspecified.",
"The job was triggered by Dataplex Universal Catalog based on trigger spec from task definition.",
"The job was triggered by the explicit call of Task API."
],
"type": "string"
},
"jobId": {
"description": "The unique id identifying the job.",
"type": "string"
},
"message": {
"description": "The log message.",
"type": "string"
},
"retries": {
"description": "The number of retries.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "The service used to execute the job.",
"enum": [
"SERVICE_UNSPECIFIED",
"DATAPROC"
],
"enumDescriptions": [
"Unspecified service.",
"Cloud Dataproc."
],
"type": "string"
},
"serviceJob": {
"description": "The reference to the job within the service.",
"type": "string"
},
"startTime": {
"description": "The time when the job started running.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "The job state on completion.",
"enum": [
"STATE_UNSPECIFIED",
"SUCCEEDED",
"FAILED",
"CANCELLED",
"ABORTED"
],
"enumDescriptions": [
"Unspecified job state.",
"Job successfully completed.",
"Job was unsuccessful.",
"Job was cancelled by the user.",
"Job was cancelled or aborted via the service executing the job."
],
"type": "string"
},
"type": {
"description": "The type of the job.",
"enum": [
"TYPE_UNSPECIFIED",
"SPARK",
"NOTEBOOK"
],
"enumDescriptions": [
"Unspecified job type.",
"Spark jobs.",
"Notebook jobs."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1Lake": {
"description": "A lake is a centralized repository for managing enterprise data across the organization distributed across many cloud projects, and stored in a variety of storage services such as Google Cloud Storage and BigQuery. The resources attached to a lake are referred to as managed resources. Data within these managed resources can be structured or unstructured. A lake provides data admins with tools to organize, secure and manage their data at scale, and provides data scientists and data engineers an integrated experience to easily search, discover, analyze and transform data and associated metadata.",
"id": "GoogleCloudDataplexV1Lake",
"properties": {
"assetStatus": {
"$ref": "GoogleCloudDataplexV1AssetStatus",
"description": "Output only. Aggregated status of the underlying assets of the lake.",
"readOnly": true
},
"createTime": {
"description": "Output only. The time when the lake was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Description of the lake.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the lake.",
"type": "object"
},
"metastore": {
"$ref": "GoogleCloudDataplexV1LakeMetastore",
"description": "Optional. Settings to manage lake and Dataproc Metastore service instance association."
},
"metastoreStatus": {
"$ref": "GoogleCloudDataplexV1LakeMetastoreStatus",
"description": "Output only. Metastore status of the lake.",
"readOnly": true
},
"name": {
"description": "Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
"readOnly": true,
"type": "string"
},
"serviceAccount": {
"description": "Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. Current state of the lake.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"CREATING",
"DELETING",
"ACTION_REQUIRED"
],
"enumDescriptions": [
"State is not specified.",
"Resource is active, i.e., ready to use.",
"Resource is under creation.",
"Resource is under deletion.",
"Resource is active but has unresolved actions."
],
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the lake was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1LakeMetastore": {
"description": "Settings to manage association of Dataproc Metastore with a lake.",
"id": "GoogleCloudDataplexV1LakeMetastore",
"properties": {
"service": {
"description": "Optional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: projects/{project_id}/locations/{location_id}/services/{service_id}",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1LakeMetastoreStatus": {
"description": "Status of Lake and Dataproc Metastore service instance association.",
"id": "GoogleCloudDataplexV1LakeMetastoreStatus",
"properties": {
"endpoint": {
"description": "The URI of the endpoint used to access the Metastore service.",
"type": "string"
},
"message": {
"description": "Additional information about the current status.",
"type": "string"
},
"state": {
"description": "Current state of association.",
"enum": [
"STATE_UNSPECIFIED",
"NONE",
"READY",
"UPDATING",
"ERROR"
],
"enumDescriptions": [
"Unspecified.",
"A Metastore service instance is not associated with the lake.",
"A Metastore service instance is attached to the lake.",
"Attach/detach is in progress.",
"Attach/detach could not be done due to errors."
],
"type": "string"
},
"updateTime": {
"description": "Last update time of the metastore status of the lake.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListActionsResponse": {
"description": "List actions response.",
"id": "GoogleCloudDataplexV1ListActionsResponse",
"properties": {
"actions": {
"description": "Actions under the given parent lake/zone/asset.",
"items": {
"$ref": "GoogleCloudDataplexV1Action"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListAspectTypesResponse": {
"description": "List AspectTypes response.",
"id": "GoogleCloudDataplexV1ListAspectTypesResponse",
"properties": {
"aspectTypes": {
"description": "AspectTypes under the given parent location.",
"items": {
"$ref": "GoogleCloudDataplexV1AspectType"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"unreachableLocations": {
"description": "Locations that the service couldn't reach.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListAssetsResponse": {
"description": "List assets response.",
"id": "GoogleCloudDataplexV1ListAssetsResponse",
"properties": {
"assets": {
"description": "Asset under the given parent zone.",
"items": {
"$ref": "GoogleCloudDataplexV1Asset"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListDataAssetsResponse": {
"description": "Response message for listing data assets.",
"id": "GoogleCloudDataplexV1ListDataAssetsResponse",
"properties": {
"dataAssets": {
"description": "The data assets for the requested filter criteria.",
"items": {
"$ref": "GoogleCloudDataplexV1DataAsset"
},
"type": "array"
},
"nextPageToken": {
"description": "A token, which can be sent as page_token to retrieve the next page. If this field is empty, then there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListDataAttributeBindingsResponse": {
"description": "List DataAttributeBindings response.",
"id": "GoogleCloudDataplexV1ListDataAttributeBindingsResponse",
"properties": {
"dataAttributeBindings": {
"description": "DataAttributeBindings under the given parent Location.",
"items": {
"$ref": "GoogleCloudDataplexV1DataAttributeBinding"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"unreachableLocations": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListDataAttributesResponse": {
"description": "List DataAttributes response.",
"id": "GoogleCloudDataplexV1ListDataAttributesResponse",
"properties": {
"dataAttributes": {
"description": "DataAttributes under the given parent DataTaxonomy.",
"items": {
"$ref": "GoogleCloudDataplexV1DataAttribute"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"unreachableLocations": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListDataProductsResponse": {
"description": "Response message for listing data products.",
"id": "GoogleCloudDataplexV1ListDataProductsResponse",
"properties": {
"dataProducts": {
"description": "The data products for the requested filter criteria.",
"items": {
"$ref": "GoogleCloudDataplexV1DataProduct"
},
"type": "array"
},
"nextPageToken": {
"description": "A token, which can be sent as page_token to retrieve the next page. If this field is empty, then there are no subsequent pages.",
"type": "string"
},
"unreachable": {
"description": "Unordered list. Locations that the service couldn't reach.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListDataScanJobsResponse": {
"description": "List DataScanJobs response.",
"id": "GoogleCloudDataplexV1ListDataScanJobsResponse",
"properties": {
"dataScanJobs": {
"description": "DataScanJobs (BASIC view only) under a given dataScan.",
"items": {
"$ref": "GoogleCloudDataplexV1DataScanJob"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListDataScansResponse": {
"description": "List dataScans response.",
"id": "GoogleCloudDataplexV1ListDataScansResponse",
"properties": {
"dataScans": {
"description": "DataScans (BASIC view only) under the given parent location.",
"items": {
"$ref": "GoogleCloudDataplexV1DataScan"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListDataTaxonomiesResponse": {
"description": "List DataTaxonomies response.",
"id": "GoogleCloudDataplexV1ListDataTaxonomiesResponse",
"properties": {
"dataTaxonomies": {
"description": "DataTaxonomies under the given parent location.",
"items": {
"$ref": "GoogleCloudDataplexV1DataTaxonomy"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"unreachableLocations": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListEncryptionConfigsResponse": {
"description": "List EncryptionConfigs Response",
"id": "GoogleCloudDataplexV1ListEncryptionConfigsResponse",
"properties": {
"encryptionConfigs": {
"description": "The list of EncryptionConfigs under the given parent location.",
"items": {
"$ref": "GoogleCloudDataplexV1EncryptionConfig"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"unreachableLocations": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListEntitiesResponse": {
"description": "List metadata entities response.",
"id": "GoogleCloudDataplexV1ListEntitiesResponse",
"properties": {
"entities": {
"description": "Entities in the specified parent zone.",
"items": {
"$ref": "GoogleCloudDataplexV1Entity"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no remaining results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListEntriesResponse": {
"description": "List Entries response.",
"id": "GoogleCloudDataplexV1ListEntriesResponse",
"properties": {
"entries": {
"description": "The list of entries under the given parent location.",
"items": {
"$ref": "GoogleCloudDataplexV1Entry"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListEntryGroupsResponse": {
"description": "List entry groups response.",
"id": "GoogleCloudDataplexV1ListEntryGroupsResponse",
"properties": {
"entryGroups": {
"description": "Entry groups under the given parent location.",
"items": {
"$ref": "GoogleCloudDataplexV1EntryGroup"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"unreachableLocations": {
"description": "Locations that the service couldn't reach.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListEntryTypesResponse": {
"description": "List EntryTypes response.",
"id": "GoogleCloudDataplexV1ListEntryTypesResponse",
"properties": {
"entryTypes": {
"description": "EntryTypes under the given parent location.",
"items": {
"$ref": "GoogleCloudDataplexV1EntryType"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"unreachableLocations": {
"description": "Locations that the service couldn't reach.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListGlossariesResponse": {
"description": "List Glossaries Response",
"id": "GoogleCloudDataplexV1ListGlossariesResponse",
"properties": {
"glossaries": {
"description": "Lists the Glossaries in the specified parent.",
"items": {
"$ref": "GoogleCloudDataplexV1Glossary"
},
"type": "array"
},
"nextPageToken": {
"description": "A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"unreachableLocations": {
"description": "Locations that the service couldn't reach.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListGlossaryCategoriesResponse": {
"description": "List GlossaryCategories Response",
"id": "GoogleCloudDataplexV1ListGlossaryCategoriesResponse",
"properties": {
"categories": {
"description": "Lists the GlossaryCategories in the specified parent.",
"items": {
"$ref": "GoogleCloudDataplexV1GlossaryCategory"
},
"type": "array"
},
"nextPageToken": {
"description": "A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"unreachableLocations": {
"description": "Locations that the service couldn't reach.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListGlossaryTermsResponse": {
"description": "List GlossaryTerms Response",
"id": "GoogleCloudDataplexV1ListGlossaryTermsResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"terms": {
"description": "Lists the GlossaryTerms in the specified parent.",
"items": {
"$ref": "GoogleCloudDataplexV1GlossaryTerm"
},
"type": "array"
},
"unreachableLocations": {
"description": "Locations that the service couldn't reach.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListJobsResponse": {
"description": "List jobs response.",
"id": "GoogleCloudDataplexV1ListJobsResponse",
"properties": {
"jobs": {
"description": "Jobs under a given task.",
"items": {
"$ref": "GoogleCloudDataplexV1Job"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListLakesResponse": {
"description": "List lakes response.",
"id": "GoogleCloudDataplexV1ListLakesResponse",
"properties": {
"lakes": {
"description": "Lakes under the given parent location.",
"items": {
"$ref": "GoogleCloudDataplexV1Lake"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"unreachableLocations": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListMetadataFeedsResponse": {
"description": "Response message for ListMetadataFeeds.",
"id": "GoogleCloudDataplexV1ListMetadataFeedsResponse",
"properties": {
"metadataFeeds": {
"description": "List of metadata feeds under the specified parent location.",
"items": {
"$ref": "GoogleCloudDataplexV1MetadataFeed"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. If there are no more results in the list, the value is empty.",
"type": "string"
},
"unreachable": {
"description": "Unordered list. Locations that the service couldn't reach.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListMetadataJobsResponse": {
"description": "List metadata jobs response.",
"id": "GoogleCloudDataplexV1ListMetadataJobsResponse",
"properties": {
"metadataJobs": {
"description": "Metadata jobs under the specified parent location.",
"items": {
"$ref": "GoogleCloudDataplexV1MetadataJob"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. If there are no more results in the list, the value is empty.",
"type": "string"
},
"unreachableLocations": {
"description": "Locations that the service couldn't reach.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListPartitionsResponse": {
"description": "List metadata partitions response.",
"id": "GoogleCloudDataplexV1ListPartitionsResponse",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no remaining results in the list.",
"type": "string"
},
"partitions": {
"description": "Partitions under the specified parent entity.",
"items": {
"$ref": "GoogleCloudDataplexV1Partition"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListTasksResponse": {
"description": "List tasks response.",
"id": "GoogleCloudDataplexV1ListTasksResponse",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"tasks": {
"description": "Tasks under the given parent lake.",
"items": {
"$ref": "GoogleCloudDataplexV1Task"
},
"type": "array"
},
"unreachableLocations": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ListZonesResponse": {
"description": "List zones response.",
"id": "GoogleCloudDataplexV1ListZonesResponse",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"zones": {
"description": "Zones under the given parent lake.",
"items": {
"$ref": "GoogleCloudDataplexV1Zone"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1LookupContextRequest": {
"description": "Lookup Context using permissions in the source system.",
"id": "GoogleCloudDataplexV1LookupContextRequest",
"properties": {
"context": {
"description": "Optional. The text representing contextual information for which metadata context is being requested.",
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Allows to configure the context.Supported options: format - The format of the context (one of yaml, xml, json, default is yaml). context_budget - If provided, the output will be intelligently truncated on a best-effort basis to contain approximately the desired amount of characters. There is no guarantee to achieve the specific amount.",
"type": "object"
},
"resources": {
"description": "Required. The entry names to look up the context for. The maximum number of resources for a request is limited to 10.Examples:projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1LookupContextResponse": {
"description": "Lookup Context response.",
"id": "GoogleCloudDataplexV1LookupContextResponse",
"properties": {
"context": {
"description": "Pre-formatted block of text containing the context for the requested resources.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1LookupEntryLinksResponse": {
"description": "Response message for LookupEntryLinks.",
"id": "GoogleCloudDataplexV1LookupEntryLinksResponse",
"properties": {
"entryLinks": {
"description": "List of entry links that reference the specified entry.",
"items": {
"$ref": "GoogleCloudDataplexV1EntryLink"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1MetadataFeed": {
"description": "MetadataFeed contains information related to the metadata feed.",
"id": "GoogleCloudDataplexV1MetadataFeed",
"properties": {
"createTime": {
"description": "Output only. The time when the feed was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"filters": {
"$ref": "GoogleCloudDataplexV1MetadataFeedFilters",
"description": "Optional. The filters of the metadata feed. Only the changes that match the filters are published."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels.",
"type": "object"
},
"name": {
"description": "Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}.",
"type": "string"
},
"pubsubTopic": {
"description": "Optional. The pubsub topic that you want the metadata feed messages to publish to. Please grant Dataplex service account the permission to publish messages to the topic. The service account is: service-{PROJECT_NUMBER}@gcp-sa-dataplex.iam.gserviceaccount.com.",
"type": "string"
},
"scope": {
"$ref": "GoogleCloudDataplexV1MetadataFeedScope",
"description": "Required. The scope of the metadata feed. Only the in scope changes are published."
},
"uid": {
"description": "Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the feed was updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1MetadataFeedFilters": {
"description": "Filters defines the type of changes that you want to listen to. You can have multiple entry type filters and multiple aspect type filters. All of the entry type filters are OR'ed together. All of the aspect type filters are OR'ed together. All of the entry type filters and aspect type filters are AND'ed together.",
"id": "GoogleCloudDataplexV1MetadataFeedFilters",
"properties": {
"aspectTypes": {
"description": "Optional. The aspect types that you want to listen to. Depending on how the aspect is attached to the entry, in the format: projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}.",
"items": {
"type": "string"
},
"type": "array"
},
"changeTypes": {
"description": "Optional. The type of change that you want to listen to. If not specified, all changes are published.",
"items": {
"enum": [
"CHANGE_TYPE_UNSPECIFIED",
"CREATE",
"UPDATE",
"DELETE"
],
"enumDescriptions": [
"Unspecified change type. Defaults to UNSPECIFIED.",
"The change is a create event.",
"The change is an update event.",
"The change is a delete event."
],
"type": "string"
},
"type": "array"
},
"entryTypes": {
"description": "Optional. The entry types that you want to listen to, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}. Only entries that belong to the specified entry types are published.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1MetadataFeedScope": {
"description": "Scope defines the scope of the metadata feed. Scopes are exclusive. Only one of the scopes can be specified.",
"id": "GoogleCloudDataplexV1MetadataFeedScope",
"properties": {
"entryGroups": {
"description": "Optional. The entry groups whose entries you want to listen to. Must be in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.",
"items": {
"type": "string"
},
"type": "array"
},
"organizationLevel": {
"description": "Optional. Whether the metadata feed is at the organization-level. If true, all changes happened to the entries in the same organization as the feed are published. If false, you must specify a list of projects or a list of entry groups whose entries you want to listen to.The default is false.",
"type": "boolean"
},
"projects": {
"description": "Optional. The projects whose entries you want to listen to. Must be in the same organization as the feed. Must be in the format: projects/{project_id_or_number}.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1MetadataJob": {
"description": "A metadata job resource.",
"id": "GoogleCloudDataplexV1MetadataJob",
"properties": {
"createTime": {
"description": "Output only. The time when the metadata job was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"exportResult": {
"$ref": "GoogleCloudDataplexV1MetadataJobExportJobResult",
"description": "Output only. Export job result.",
"readOnly": true
},
"exportSpec": {
"$ref": "GoogleCloudDataplexV1MetadataJobExportJobSpec",
"description": "Export job specification."
},
"importResult": {
"$ref": "GoogleCloudDataplexV1MetadataJobImportJobResult",
"description": "Output only. Import job result.",
"readOnly": true
},
"importSpec": {
"$ref": "GoogleCloudDataplexV1MetadataJobImportJobSpec",
"description": "Import job specification."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels.",
"type": "object"
},
"name": {
"description": "Output only. Identifier. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.",
"readOnly": true,
"type": "string"
},
"status": {
"$ref": "GoogleCloudDataplexV1MetadataJobStatus",
"description": "Output only. Metadata job status.",
"readOnly": true
},
"type": {
"description": "Required. Metadata job type.",
"enum": [
"TYPE_UNSPECIFIED",
"IMPORT",
"EXPORT"
],
"enumDescriptions": [
"Unspecified.",
"Import job.",
"Export job."
],
"type": "string"
},
"uid": {
"description": "Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the metadata job was updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1MetadataJobExportJobResult": {
"description": "Summary results from a metadata export job. The results are a snapshot of the metadata at the time when the job was created. The exported entries are saved to a Cloud Storage bucket.",
"id": "GoogleCloudDataplexV1MetadataJobExportJobResult",
"properties": {
"errorMessage": {
"description": "Output only. The error message if the metadata export job failed.",
"readOnly": true,
"type": "string"
},
"exportedEntries": {
"description": "Output only. The number of entries that were exported.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1MetadataJobExportJobSpec": {
"description": "Job specification for a metadata export job.",
"id": "GoogleCloudDataplexV1MetadataJobExportJobSpec",
"properties": {
"outputPath": {
"description": "Required. The root path of the Cloud Storage bucket to export the metadata to, in the format gs://{bucket}/. You can optionally specify a custom prefix after the bucket name, in the format gs://{bucket}/{prefix}/. The maximum length of the custom prefix is 128 characters. Dataplex Universal Catalog constructs the object path for the exported files by using the bucket name and prefix that you provide, followed by a system-generated path.The bucket must be in the same VPC Service Controls perimeter as the job.",
"type": "string"
},
"scope": {
"$ref": "GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope",
"description": "Required. The scope of the export job."
}
},
"type": "object"
},
"GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope": {
"description": "The scope of the export job.",
"id": "GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope",
"properties": {
"aspectTypes": {
"description": "The aspect types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}. Only aspects that belong to the specified aspect types are affected by the job.",
"items": {
"type": "string"
},
"type": "array"
},
"entryGroups": {
"description": "The entry groups whose metadata you want to export, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. Only the entries in the specified entry groups are exported.The entry groups must be in the same location and the same VPC Service Controls perimeter as the job.If you set the job scope to be a list of entry groups, then set the organization-level export flag to false and don't provide a list of projects.",
"items": {
"type": "string"
},
"type": "array"
},
"entryTypes": {
"description": "The entry types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}. Only entries that belong to the specified entry types are affected by the job.",
"items": {
"type": "string"
},
"type": "array"
},
"organizationLevel": {
"description": "Whether the metadata export job is an organization-level export job. If true, the job exports the entries from the same organization and VPC Service Controls perimeter as the job. The project that the job belongs to determines the VPC Service Controls perimeter. If you set the job scope to be at the organization level, then don't provide a list of projects or entry groups. If false, you must specify a list of projects or a list of entry groups whose entries you want to export.The default is false.",
"type": "boolean"
},
"projects": {
"description": "The projects whose metadata you want to export, in the format projects/{project_id_or_number}. Only the entries from the specified projects are exported.The projects must be in the same organization and VPC Service Controls perimeter as the job.If you set the job scope to be a list of projects, then set the organization-level export flag to false and don't provide a list of entry groups.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1MetadataJobImportJobResult": {
"description": "Results from a metadata import job.",
"id": "GoogleCloudDataplexV1MetadataJobImportJobResult",
"properties": {
"createdEntries": {
"description": "Output only. The total number of entries that were created.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"createdEntryLinks": {
"description": "Output only. The total number of entry links that were successfully created.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"deletedEntries": {
"description": "Output only. The total number of entries that were deleted.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"deletedEntryLinks": {
"description": "Output only. The total number of entry links that were successfully deleted.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"recreatedEntries": {
"description": "Output only. The total number of entries that were recreated.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"unchangedEntries": {
"description": "Output only. The total number of entries that were unchanged.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"unchangedEntryLinks": {
"description": "Output only. The total number of entry links that were left unchanged.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the status was updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"updatedEntries": {
"description": "Output only. The total number of entries that were updated.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1MetadataJobImportJobSpec": {
"description": "Job specification for a metadata import job.You can run the following kinds of metadata import jobs: Full sync of entries with incremental import of their aspects. Supported for custom entries. Incremental import of aspects only. Supported for aspects that belong to custom entries and system entries. For custom entries, you can modify both optional aspects and required aspects. For system entries, you can modify optional aspects.",
"id": "GoogleCloudDataplexV1MetadataJobImportJobSpec",
"properties": {
"aspectSyncMode": {
"description": "Required. The sync mode for aspects.",
"enum": [
"SYNC_MODE_UNSPECIFIED",
"FULL",
"INCREMENTAL",
"NONE"
],
"enumDescriptions": [
"Sync mode unspecified.",
"All resources in the job's scope are modified. If a resource exists in Dataplex Universal Catalog but isn't included in the metadata import file, the resource is deleted when you run the metadata job. Use this mode to perform a full sync of the set of entries in the job scope.This sync mode is supported for entries.",
"Only the resources that are explicitly included in the metadata import file are modified. Use this mode to modify a subset of resources while leaving unreferenced resources unchanged.This sync mode is supported for aspects.",
"If entry sync mode is NONE, then aspects are modified according to the aspect sync mode. Other metadata that belongs to entries in the job's scope isn't modified.This sync mode is supported for entries."
],
"type": "string"
},
"entrySyncMode": {
"description": "Required. The sync mode for entries.",
"enum": [
"SYNC_MODE_UNSPECIFIED",
"FULL",
"INCREMENTAL",
"NONE"
],
"enumDescriptions": [
"Sync mode unspecified.",
"All resources in the job's scope are modified. If a resource exists in Dataplex Universal Catalog but isn't included in the metadata import file, the resource is deleted when you run the metadata job. Use this mode to perform a full sync of the set of entries in the job scope.This sync mode is supported for entries.",
"Only the resources that are explicitly included in the metadata import file are modified. Use this mode to modify a subset of resources while leaving unreferenced resources unchanged.This sync mode is supported for aspects.",
"If entry sync mode is NONE, then aspects are modified according to the aspect sync mode. Other metadata that belongs to entries in the job's scope isn't modified.This sync mode is supported for entries."
],
"type": "string"
},
"logLevel": {
"description": "Optional. The level of logs to write to Cloud Logging for this job.Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs (https://cloud.google.com/stackdriver/pricing) that might not be merited for all jobs.If unspecified, defaults to INFO.",
"enum": [
"LOG_LEVEL_UNSPECIFIED",
"DEBUG",
"INFO"
],
"enumDescriptions": [
"Log level unspecified.",
"Debug-level logging. Captures detailed logs for each import item. Use debug-level logging to troubleshoot issues with specific import items. For example, use debug-level logging to identify resources that are missing from the job scope, entries or aspects that don't conform to the associated entry type or aspect type, or other misconfigurations with the metadata import file.Depending on the size of your metadata job and the number of logs that are generated, debug-level logging might incur additional costs (https://cloud.google.com/stackdriver/pricing).",
"Info-level logging. Captures logs at the overall job level. Includes aggregate logs about import items, but doesn't specify which import item has an error."
],
"type": "string"
},
"scope": {
"$ref": "GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope",
"description": "Required. A boundary on the scope of impact that the metadata import job can have."
},
"sourceCreateTime": {
"description": "Optional. The time when the process that created the metadata import files began.",
"format": "google-datetime",
"type": "string"
},
"sourceStorageUri": {
"description": "Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata import job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope": {
"description": "A boundary on the scope of impact that the metadata import job can have.",
"id": "GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope",
"properties": {
"aspectTypes": {
"description": "Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.This field is required when creating an aspect-only import job.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.",
"items": {
"type": "string"
},
"type": "array"
},
"entryGroups": {
"description": "Required. The entry groups that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries and aspects that belong to the specified entry groups are affected by the job.The entry groups and the job must be in the same location.",
"items": {
"type": "string"
},
"type": "array"
},
"entryLinkTypes": {
"description": "Optional. The entry link types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}. The job modifies only the entryLinks that belong to these entry link types.If the metadata import file attempts to create or delete an entry link whose entry link type isn't included in this list, the import job will skip those entry links.",
"items": {
"type": "string"
},
"type": "array"
},
"entryTypes": {
"description": "Required. The entry types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}. The job modifies only the entries and aspects that belong to these entry types.If the metadata import file attempts to modify an entry whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an entry type must either match the location of the job, or the entry type must be global.",
"items": {
"type": "string"
},
"type": "array"
},
"glossaries": {
"description": "Optional. The glossaries that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}.While importing Business Glossary entries, the user must provide glossaries. While importing entries, the user does not have to provide glossaries. If the metadata import file attempts to modify Business Glossary entries whose glossary isn't included in this list, the import job will skip those entries.The location of a glossary must either match the location of the job, or the glossary must be global.",
"items": {
"type": "string"
},
"type": "array"
},
"referencedEntryScopes": {
"description": "Optional. Defines the scope of entries that can be referenced in the entry links.Currently, projects are supported as valid scopes. Format: projects/{project_number_or_id}If the metadata import file attempts to create an entry link which references an entry that is not in the scope, the import job will skip that entry link.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1MetadataJobStatus": {
"description": "Metadata job status.",
"id": "GoogleCloudDataplexV1MetadataJobStatus",
"properties": {
"completionPercent": {
"description": "Output only. Progress tracking.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"message": {
"description": "Output only. Message relating to the progression of a metadata job.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. State of the metadata job.",
"enum": [
"STATE_UNSPECIFIED",
"QUEUED",
"RUNNING",
"CANCELING",
"CANCELED",
"SUCCEEDED",
"FAILED",
"SUCCEEDED_WITH_ERRORS"
],
"enumDescriptions": [
"State unspecified.",
"The job is queued.",
"The job is running.",
"The job is being canceled.",
"The job is canceled.",
"The job succeeded.",
"The job failed.",
"The job completed with some errors."
],
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the status was updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ModifyEntryRequest": {
"description": "Modify Entry request using permissions in the source system.",
"id": "GoogleCloudDataplexV1ModifyEntryRequest",
"properties": {
"aspectKeys": {
"description": "Optional. The aspect keys which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.",
"items": {
"type": "string"
},
"type": "array"
},
"deleteMissingAspects": {
"description": "Optional. If set to true, any aspects not specified in the request will be deleted. The default is false.",
"type": "boolean"
},
"entry": {
"$ref": "GoogleCloudDataplexV1Entry",
"description": "Required. The entry to modify."
},
"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, the service will update all modifiable fields present in the request.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1OperationMetadata": {
"description": "Represents the metadata of a long-running operation.",
"id": "GoogleCloudDataplexV1OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1Partition": {
"description": "Represents partition metadata contained within entity instances.",
"id": "GoogleCloudDataplexV1Partition",
"properties": {
"etag": {
"deprecated": true,
"description": "Optional. The etag for this partition.",
"type": "string"
},
"location": {
"description": "Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects//datasets//tables/",
"type": "string"
},
"name": {
"description": "Output only. Partition values used in the HTTP URL must be double encoded. For example, url_encode(url_encode(value)) can be used to encode \"US:CA/CA#Sunnyvale so that the request URL ends with \"/partitions/US%253ACA/CA%2523Sunnyvale\". The name field in the response retains the encoded format.",
"readOnly": true,
"type": "string"
},
"values": {
"description": "Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1RequestDataProductAccessRequest": {
"description": "Message for requesting access to a Data Product.",
"id": "GoogleCloudDataplexV1RequestDataProductAccessRequest",
"properties": {
"changeRequest": {
"$ref": "GoogleCloudDataplexV1ChangeRequest",
"description": "Required. The change request for the data product access request."
},
"validateOnly": {
"description": "Optional. Validates the request without actually creating the access change request. Defaults to false.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDataplexV1RequestDataProductAccessResponse": {
"description": "Response message for requesting access to a Data Product.",
"id": "GoogleCloudDataplexV1RequestDataProductAccessResponse",
"properties": {
"changeRequestName": {
"description": "The resource name of the created ChangeRequest. Format: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ResourceAccessSpec": {
"description": "ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table.",
"id": "GoogleCloudDataplexV1ResourceAccessSpec",
"properties": {
"owners": {
"description": "Optional. The set of principals to be granted owner role on the resource.",
"items": {
"type": "string"
},
"type": "array"
},
"readers": {
"description": "Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.",
"items": {
"type": "string"
},
"type": "array"
},
"writers": {
"description": "Optional. The set of principals to be granted writer role on the resource.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1RunDataScanRequest": {
"description": "Run DataScan Request",
"id": "GoogleCloudDataplexV1RunDataScanRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1RunDataScanResponse": {
"description": "Run DataScan Response.",
"id": "GoogleCloudDataplexV1RunDataScanResponse",
"properties": {
"job": {
"$ref": "GoogleCloudDataplexV1DataScanJob",
"description": "DataScanJob created by RunDataScan request."
}
},
"type": "object"
},
"GoogleCloudDataplexV1RunTaskRequest": {
"id": "GoogleCloudDataplexV1RunTaskRequest",
"properties": {
"args": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Execution spec arguments. If the map is left empty, the task will run with existing execution spec args from task definition. If the map contains an entry with a new key, the same will be added to existing set of args. If the map contains an entry with an existing arg key in task definition, the task will run with new arg value for that entry. Clearing an existing arg will require arg value to be explicitly set to a hyphen \"-\". The arg value cannot be empty.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the task. If the map is left empty, the task will run with existing labels from task definition. If the map contains an entry with a new key, the same will be added to existing set of labels. If the map contains an entry with an existing label key in task definition, the task will run with new label value for that entry. Clearing an existing label will require label value to be explicitly set to a hyphen \"-\". The label value cannot be empty.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDataplexV1RunTaskResponse": {
"id": "GoogleCloudDataplexV1RunTaskResponse",
"properties": {
"job": {
"$ref": "GoogleCloudDataplexV1Job",
"description": "Jobs created by RunTask API."
}
},
"type": "object"
},
"GoogleCloudDataplexV1ScannedData": {
"description": "The data scanned during processing (e.g. in incremental DataScan)",
"id": "GoogleCloudDataplexV1ScannedData",
"properties": {
"incrementalField": {
"$ref": "GoogleCloudDataplexV1ScannedDataIncrementalField",
"description": "The range denoted by values of an incremental field"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ScannedDataIncrementalField": {
"description": "A data range denoted by a pair of start/end values of a field.",
"id": "GoogleCloudDataplexV1ScannedDataIncrementalField",
"properties": {
"end": {
"description": "Output only. Value that marks the end of the range.",
"readOnly": true,
"type": "string"
},
"field": {
"description": "Output only. The field that contains values which monotonically increases over time (e.g. a timestamp column).",
"readOnly": true,
"type": "string"
},
"start": {
"description": "Output only. Value that marks the start of the range.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1Schema": {
"description": "Schema information describing the structure and layout of the data.",
"id": "GoogleCloudDataplexV1Schema",
"properties": {
"fields": {
"description": "Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.",
"items": {
"$ref": "GoogleCloudDataplexV1SchemaSchemaField"
},
"type": "array"
},
"partitionFields": {
"description": "Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.",
"items": {
"$ref": "GoogleCloudDataplexV1SchemaPartitionField"
},
"type": "array"
},
"partitionStyle": {
"description": "Optional. The structure of paths containing partition data within the entity.",
"enum": [
"PARTITION_STYLE_UNSPECIFIED",
"HIVE_COMPATIBLE"
],
"enumDescriptions": [
"PartitionStyle unspecified",
"Partitions are hive-compatible. Examples: gs://bucket/path/to/table/dt=2019-10-31/lang=en, gs://bucket/path/to/table/dt=2019-10-31/lang=en/late."
],
"type": "string"
},
"userManaged": {
"description": "Required. Set to true if user-managed or false if managed by Dataplex Universal Catalog. The default is false (managed by Dataplex Universal Catalog). Set to falseto enable Dataplex Universal Catalog discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex Universal Catalog will not change schema fields.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDataplexV1SchemaPartitionField": {
"description": "Represents a key field within the entity's partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration. Note: Partition fields are immutable.",
"id": "GoogleCloudDataplexV1SchemaPartitionField",
"properties": {
"name": {
"description": "Required. Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..",
"type": "string"
},
"type": {
"description": "Required. Immutable. The type of field.",
"enum": [
"TYPE_UNSPECIFIED",
"BOOLEAN",
"BYTE",
"INT16",
"INT32",
"INT64",
"FLOAT",
"DOUBLE",
"DECIMAL",
"STRING",
"BINARY",
"TIMESTAMP",
"DATE",
"TIME",
"RECORD",
"NULL"
],
"enumDescriptions": [
"SchemaType unspecified.",
"Boolean field.",
"Single byte numeric field.",
"16-bit numeric field.",
"32-bit numeric field.",
"64-bit numeric field.",
"Floating point numeric field.",
"Double precision numeric field.",
"Real value numeric field.",
"Sequence of characters field.",
"Sequence of bytes field.",
"Date and time field.",
"Date field.",
"Time field.",
"Structured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.",
"Null field that does not have values."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1SchemaSchemaField": {
"description": "Represents a column field within a table schema.",
"id": "GoogleCloudDataplexV1SchemaSchemaField",
"properties": {
"description": {
"description": "Optional. User friendly field description. Must be less than or equal to 1024 characters.",
"type": "string"
},
"fields": {
"description": "Optional. Any nested field for complex types.",
"items": {
"$ref": "GoogleCloudDataplexV1SchemaSchemaField"
},
"type": "array"
},
"mode": {
"description": "Required. Additional field semantics.",
"enum": [
"MODE_UNSPECIFIED",
"REQUIRED",
"NULLABLE",
"REPEATED"
],
"enumDescriptions": [
"Mode unspecified.",
"The field has required semantics.",
"The field has optional semantics, and may be null.",
"The field has repeated (0 or more) semantics, and is a list of values."
],
"type": "string"
},
"name": {
"description": "Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.",
"type": "string"
},
"type": {
"description": "Required. The type of field.",
"enum": [
"TYPE_UNSPECIFIED",
"BOOLEAN",
"BYTE",
"INT16",
"INT32",
"INT64",
"FLOAT",
"DOUBLE",
"DECIMAL",
"STRING",
"BINARY",
"TIMESTAMP",
"DATE",
"TIME",
"RECORD",
"NULL"
],
"enumDescriptions": [
"SchemaType unspecified.",
"Boolean field.",
"Single byte numeric field.",
"16-bit numeric field.",
"32-bit numeric field.",
"64-bit numeric field.",
"Floating point numeric field.",
"Double precision numeric field.",
"Real value numeric field.",
"Sequence of characters field.",
"Sequence of bytes field.",
"Date and time field.",
"Date field.",
"Time field.",
"Structured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.",
"Null field that does not have values."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1SearchEntriesResponse": {
"id": "GoogleCloudDataplexV1SearchEntriesResponse",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"results": {
"description": "The results matching the search query.",
"items": {
"$ref": "GoogleCloudDataplexV1SearchEntriesResult"
},
"type": "array"
},
"totalSize": {
"description": "The estimated total number of matching entries. This number isn't guaranteed to be accurate.",
"format": "int32",
"type": "integer"
},
"unreachable": {
"description": "Locations that the service couldn't reach. Search results don't include data from these locations.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1SearchEntriesResult": {
"description": "A single result of a SearchEntries request.",
"id": "GoogleCloudDataplexV1SearchEntriesResult",
"properties": {
"dataplexEntry": {
"$ref": "GoogleCloudDataplexV1Entry"
},
"linkedResource": {
"deprecated": true,
"description": "Linked resource name.",
"type": "string"
},
"snippets": {
"$ref": "GoogleCloudDataplexV1SearchEntriesResultSnippets",
"deprecated": true,
"description": "Snippets."
}
},
"type": "object"
},
"GoogleCloudDataplexV1SearchEntriesResultSnippets": {
"deprecated": true,
"description": "Snippets for the entry, contains HTML-style highlighting for matched tokens, will be used in UI.",
"id": "GoogleCloudDataplexV1SearchEntriesResultSnippets",
"properties": {
"dataplexEntry": {
"$ref": "GoogleCloudDataplexV1Entry",
"deprecated": true,
"description": "Entry"
}
},
"type": "object"
},
"GoogleCloudDataplexV1SessionEvent": {
"description": "These messages contain information about sessions within an environment. The monitored resource is 'Environment'.",
"id": "GoogleCloudDataplexV1SessionEvent",
"properties": {
"eventSucceeded": {
"description": "The status of the event.",
"type": "boolean"
},
"fastStartupEnabled": {
"description": "If the session is associated with an environment with fast startup enabled, and was created before being assigned to a user.",
"type": "boolean"
},
"message": {
"description": "The log message.",
"type": "string"
},
"query": {
"$ref": "GoogleCloudDataplexV1SessionEventQueryDetail",
"description": "The execution details of the query."
},
"sessionId": {
"description": "Unique identifier for the session.",
"type": "string"
},
"type": {
"description": "The type of the event.",
"enum": [
"EVENT_TYPE_UNSPECIFIED",
"START",
"STOP",
"QUERY",
"CREATE"
],
"enumDescriptions": [
"An unspecified event type.",
"Event when the session is assigned to a user.",
"Event for stop of a session.",
"Query events in the session.",
"Event for creation of a cluster. It is not yet assigned to a user. This comes before START in the sequence"
],
"type": "string"
},
"unassignedDuration": {
"description": "The idle duration of a warm pooled session before it is assigned to user.",
"format": "google-duration",
"type": "string"
},
"userId": {
"description": "The information about the user that created the session. It will be the email address of the user.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1SessionEventQueryDetail": {
"description": "Execution details of the query.",
"id": "GoogleCloudDataplexV1SessionEventQueryDetail",
"properties": {
"dataProcessedBytes": {
"description": "The data processed by the query.",
"format": "int64",
"type": "string"
},
"duration": {
"description": "Time taken for execution of the query.",
"format": "google-duration",
"type": "string"
},
"engine": {
"description": "Query Execution engine.",
"enum": [
"ENGINE_UNSPECIFIED",
"SPARK_SQL",
"BIGQUERY"
],
"enumDescriptions": [
"An unspecified Engine type.",
"Spark-sql engine is specified in Query.",
"BigQuery engine is specified in Query."
],
"type": "string"
},
"queryId": {
"description": "The unique Query id identifying the query.",
"type": "string"
},
"queryText": {
"description": "The query text executed.",
"type": "string"
},
"resultSizeBytes": {
"description": "The size of results the query produced.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1StorageAccess": {
"description": "Describes the access mechanism of the data within its storage location.",
"id": "GoogleCloudDataplexV1StorageAccess",
"properties": {
"read": {
"description": "Output only. Describes the read access mechanism of the data. Not user settable.",
"enum": [
"ACCESS_MODE_UNSPECIFIED",
"DIRECT",
"MANAGED"
],
"enumDescriptions": [
"Access mode unspecified.",
"Default. Data is accessed directly using storage APIs.",
"Data is accessed through a managed interface using BigQuery APIs."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1StorageFormat": {
"description": "Describes the format of the data within its storage location.",
"id": "GoogleCloudDataplexV1StorageFormat",
"properties": {
"compressionFormat": {
"description": "Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.",
"enum": [
"COMPRESSION_FORMAT_UNSPECIFIED",
"GZIP",
"BZIP2"
],
"enumDescriptions": [
"CompressionFormat unspecified. Implies uncompressed data.",
"GZip compressed set of files.",
"BZip2 compressed set of files."
],
"type": "string"
},
"csv": {
"$ref": "GoogleCloudDataplexV1StorageFormatCsvOptions",
"description": "Optional. Additional information about CSV formatted data."
},
"format": {
"description": "Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.",
"enum": [
"FORMAT_UNSPECIFIED",
"PARQUET",
"AVRO",
"ORC",
"CSV",
"JSON",
"IMAGE",
"AUDIO",
"VIDEO",
"TEXT",
"TFRECORD",
"OTHER",
"UNKNOWN"
],
"enumDescriptions": [
"Format unspecified.",
"Parquet-formatted structured data.",
"Avro-formatted structured data.",
"Orc-formatted structured data.",
"Csv-formatted semi-structured data.",
"Json-formatted semi-structured data.",
"Image data formats (such as jpg and png).",
"Audio data formats (such as mp3, and wav).",
"Video data formats (such as mp4 and mpg).",
"Textual data formats (such as txt and xml).",
"TensorFlow record format.",
"Data that doesn't match a specific format.",
"Data of an unknown format."
],
"readOnly": true,
"type": "string"
},
"iceberg": {
"$ref": "GoogleCloudDataplexV1StorageFormatIcebergOptions",
"description": "Optional. Additional information about iceberg tables."
},
"json": {
"$ref": "GoogleCloudDataplexV1StorageFormatJsonOptions",
"description": "Optional. Additional information about CSV formatted data."
},
"mimeType": {
"description": "Required. The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1StorageFormatCsvOptions": {
"description": "Describes CSV and similar semi-structured data formats.",
"id": "GoogleCloudDataplexV1StorageFormatCsvOptions",
"properties": {
"delimiter": {
"description": "Optional. The delimiter used to separate values. Defaults to ','.",
"type": "string"
},
"encoding": {
"description": "Optional. The character encoding of the data. Accepts \"US-ASCII\", \"UTF-8\", and \"ISO-8859-1\". Defaults to UTF-8 if unspecified.",
"type": "string"
},
"headerRows": {
"description": "Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.",
"format": "int32",
"type": "integer"
},
"quote": {
"description": "Optional. The character used to quote column values. Accepts '\"' (double quotation mark) or ''' (single quotation mark). Defaults to '\"' (double quotation mark) if unspecified.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1StorageFormatIcebergOptions": {
"description": "Describes Iceberg data format.",
"id": "GoogleCloudDataplexV1StorageFormatIcebergOptions",
"properties": {
"metadataLocation": {
"description": "Optional. The location of where the iceberg metadata is present, must be within the table path",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1StorageFormatJsonOptions": {
"description": "Describes JSON data format.",
"id": "GoogleCloudDataplexV1StorageFormatJsonOptions",
"properties": {
"encoding": {
"description": "Optional. The character encoding of the data. Accepts \"US-ASCII\", \"UTF-8\" and \"ISO-8859-1\". Defaults to UTF-8 if not specified.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1Task": {
"description": "A task represents a user-visible job.",
"id": "GoogleCloudDataplexV1Task",
"properties": {
"createTime": {
"description": "Output only. The time when the task was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Description of the task.",
"type": "string"
},
"displayName": {
"description": "Optional. User friendly display name.",
"type": "string"
},
"executionSpec": {
"$ref": "GoogleCloudDataplexV1TaskExecutionSpec",
"description": "Required. Spec related to how a task is executed."
},
"executionStatus": {
"$ref": "GoogleCloudDataplexV1TaskExecutionStatus",
"description": "Output only. Status of the latest task executions.",
"readOnly": true
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for the task.",
"type": "object"
},
"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}.",
"readOnly": true,
"type": "string"
},
"notebook": {
"$ref": "GoogleCloudDataplexV1TaskNotebookTaskConfig",
"description": "Config related to running scheduled Notebooks."
},
"spark": {
"$ref": "GoogleCloudDataplexV1TaskSparkTaskConfig",
"description": "Config related to running custom Spark tasks."
},
"state": {
"description": "Output only. Current state of the task.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"CREATING",
"DELETING",
"ACTION_REQUIRED"
],
"enumDescriptions": [
"State is not specified.",
"Resource is active, i.e., ready to use.",
"Resource is under creation.",
"Resource is under deletion.",
"Resource is active but has unresolved actions."
],
"readOnly": true,
"type": "string"
},
"triggerSpec": {
"$ref": "GoogleCloudDataplexV1TaskTriggerSpec",
"description": "Required. Spec related to how often and when a task should be triggered."
},
"uid": {
"description": "Output only. System generated globally unique ID for the task. This ID will be different if the task is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the task was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1TaskExecutionSpec": {
"description": "Execution related settings, like retry and service_account.",
"id": "GoogleCloudDataplexV1TaskExecutionSpec",
"properties": {
"args": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The arguments to pass to the task. The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${task_id} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument.",
"type": "object"
},
"kmsKey": {
"description": "Optional. The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}.",
"type": "string"
},
"maxJobExecutionLifetime": {
"description": "Optional. The maximum duration after which the job execution is expired.",
"format": "google-duration",
"type": "string"
},
"project": {
"description": "Optional. The project in which jobs are run. By default, the project containing the Lake is used. If a project is provided, the ExecutionSpec.service_account must belong to this project.",
"type": "string"
},
"serviceAccount": {
"description": "Required. Service account to use to execute a task. If not provided, the default Compute service account for the project is used.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1TaskExecutionStatus": {
"description": "Status of the task execution (e.g. Jobs).",
"id": "GoogleCloudDataplexV1TaskExecutionStatus",
"properties": {
"latestJob": {
"$ref": "GoogleCloudDataplexV1Job",
"description": "Output only. latest job execution",
"readOnly": true
},
"updateTime": {
"description": "Output only. Last update time of the status.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1TaskInfrastructureSpec": {
"description": "Configuration for the underlying infrastructure used to run workloads.",
"id": "GoogleCloudDataplexV1TaskInfrastructureSpec",
"properties": {
"batch": {
"$ref": "GoogleCloudDataplexV1TaskInfrastructureSpecBatchComputeResources",
"description": "Compute resources needed for a Task when using Dataproc Serverless."
},
"containerImage": {
"$ref": "GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime",
"description": "Container Image Runtime Configuration."
},
"vpcNetwork": {
"$ref": "GoogleCloudDataplexV1TaskInfrastructureSpecVpcNetwork",
"description": "Vpc network."
}
},
"type": "object"
},
"GoogleCloudDataplexV1TaskInfrastructureSpecBatchComputeResources": {
"description": "Batch compute resources associated with the task.",
"id": "GoogleCloudDataplexV1TaskInfrastructureSpecBatchComputeResources",
"properties": {
"executorsCount": {
"description": "Optional. Total number of job executors. Executor Count should be between 2 and 100. Default=2",
"format": "int32",
"type": "integer"
},
"maxExecutorsCount": {
"description": "Optional. Max configurable executors. If max_executors_count > executors_count, then auto-scaling is enabled. Max Executor Count should be between 2 and 1000. Default=1000",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime": {
"description": "Container Image Runtime Configuration used with Batch execution.",
"id": "GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime",
"properties": {
"image": {
"description": "Optional. Container image to use.",
"type": "string"
},
"javaJars": {
"description": "Optional. A list of Java JARS to add to the classpath. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar",
"items": {
"type": "string"
},
"type": "array"
},
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Override to common configuration of open source components installed on the Dataproc cluster. The properties to set on daemon config files. Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. For more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).",
"type": "object"
},
"pythonPackages": {
"description": "Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDataplexV1TaskInfrastructureSpecVpcNetwork": {
"description": "Cloud VPC Network used to run the infrastructure.",
"id": "GoogleCloudDataplexV1TaskInfrastructureSpecVpcNetwork",
"properties": {
"network": {
"description": "Optional. The Cloud VPC network in which the job is run. By default, the Cloud VPC network named Default within the project is used.",
"type": "string"
},
"networkTags": {
"description": "Optional. List of network tags to apply to the job.",
"items": {
"type": "string"
},
"type": "array"
},
"subNetwork": {
"description": "Optional. The Cloud VPC sub-network in which the job is run.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1TaskNotebookTaskConfig": {
"description": "Config for running scheduled notebooks.",
"id": "GoogleCloudDataplexV1TaskNotebookTaskConfig",
"properties": {
"archiveUris": {
"description": "Optional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
"items": {
"type": "string"
},
"type": "array"
},
"fileUris": {
"description": "Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.",
"items": {
"type": "string"
},
"type": "array"
},
"infrastructureSpec": {
"$ref": "GoogleCloudDataplexV1TaskInfrastructureSpec",
"description": "Optional. Infrastructure specification for the execution."
},
"notebook": {
"description": "Required. Path to input notebook. This can be the Cloud Storage URI of the notebook file or the path to a Notebook Content. The execution args are accessible as environment variables (TASK_key=value).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1TaskSparkTaskConfig": {
"description": "User-specified config for running a Spark task.",
"id": "GoogleCloudDataplexV1TaskSparkTaskConfig",
"properties": {
"archiveUris": {
"description": "Optional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
"items": {
"type": "string"
},
"type": "array"
},
"fileUris": {
"description": "Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.",
"items": {
"type": "string"
},
"type": "array"
},
"infrastructureSpec": {
"$ref": "GoogleCloudDataplexV1TaskInfrastructureSpec",
"description": "Optional. Infrastructure specification for the execution."
},
"mainClass": {
"description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris. The execution args are passed in as a sequence of named process arguments (--key=value).",
"type": "string"
},
"mainJarFileUri": {
"description": "The Cloud Storage URI of the jar file that contains the main class. The execution args are passed in as a sequence of named process arguments (--key=value).",
"type": "string"
},
"pythonScriptFile": {
"description": "The Gcloud Storage URI of the main Python file to use as the driver. Must be a .py file. The execution args are passed in as a sequence of named process arguments (--key=value).",
"type": "string"
},
"sqlScript": {
"description": "The query text. The execution args are used to declare a set of script variables (set key=\"value\";).",
"type": "string"
},
"sqlScriptFile": {
"description": "A reference to a query file. This should be the Cloud Storage URI of the query file. The execution args are used to declare a set of script variables (set key=\"value\";).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1TaskTriggerSpec": {
"description": "Task scheduling and trigger settings.",
"id": "GoogleCloudDataplexV1TaskTriggerSpec",
"properties": {
"disabled": {
"description": "Optional. Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.",
"type": "boolean"
},
"maxRetries": {
"description": "Optional. Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.",
"format": "int32",
"type": "integer"
},
"schedule": {
"description": "Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or \"TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.",
"type": "string"
},
"startTime": {
"description": "Optional. The first run of the task will be after this time. If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.",
"format": "google-datetime",
"type": "string"
},
"type": {
"description": "Required. Immutable. Trigger type of the user-specified Task.",
"enum": [
"TYPE_UNSPECIFIED",
"ON_DEMAND",
"RECURRING"
],
"enumDescriptions": [
"Unspecified trigger type.",
"The task runs one-time shortly after Task Creation.",
"The task is scheduled to run periodically."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1Trigger": {
"description": "DataScan scheduling and trigger settings.",
"id": "GoogleCloudDataplexV1Trigger",
"properties": {
"onDemand": {
"$ref": "GoogleCloudDataplexV1TriggerOnDemand",
"description": "The scan runs once via RunDataScan API."
},
"oneTime": {
"$ref": "GoogleCloudDataplexV1TriggerOneTime",
"description": "The scan runs once, and does not create an associated ScanJob child resource."
},
"schedule": {
"$ref": "GoogleCloudDataplexV1TriggerSchedule",
"description": "The scan is scheduled to run periodically."
}
},
"type": "object"
},
"GoogleCloudDataplexV1TriggerOnDemand": {
"description": "The scan runs once via RunDataScan API.",
"id": "GoogleCloudDataplexV1TriggerOnDemand",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1TriggerOneTime": {
"description": "The scan runs once using create API.",
"id": "GoogleCloudDataplexV1TriggerOneTime",
"properties": {
"ttlAfterScanCompletion": {
"description": "Optional. Time to live for OneTime scans. default value is 24 hours, minimum value is 0 seconds, and maximum value is 365 days. The time is calculated from the data scan job completion time. If value is set as 0 seconds, the scan will be immediately deleted upon job completion, regardless of whether the job succeeded or failed.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1TriggerSchedule": {
"description": "The scan is scheduled to run periodically.",
"id": "GoogleCloudDataplexV1TriggerSchedule",
"properties": {
"cron": {
"description": "Required. Cron (https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.To explicitly set a timezone in the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or \"TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database (wikipedia (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.This field is required for Schedule scans.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1UpdateEntryRequest": {
"description": "Update Entry request.",
"id": "GoogleCloudDataplexV1UpdateEntryRequest",
"properties": {
"allowMissing": {
"description": "Optional. If set to true and the entry doesn't exist, the service will create it.",
"type": "boolean"
},
"aspectKeys": {
"description": "Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.",
"items": {
"type": "string"
},
"type": "array"
},
"deleteMissingAspects": {
"description": "Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.",
"type": "boolean"
},
"entry": {
"$ref": "GoogleCloudDataplexV1Entry",
"description": "Required. Entry resource."
},
"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, the service will update all modifiable fields present in the request.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1UpdateGlossaryCategoryRequest": {
"description": "Update GlossaryCategory Request",
"id": "GoogleCloudDataplexV1UpdateGlossaryCategoryRequest",
"properties": {
"category": {
"$ref": "GoogleCloudDataplexV1GlossaryCategory",
"description": "Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"
},
"updateMask": {
"description": "Required. The list of fields to update.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1UpdateGlossaryRequest": {
"description": "Update Glossary Request",
"id": "GoogleCloudDataplexV1UpdateGlossaryRequest",
"properties": {
"glossary": {
"$ref": "GoogleCloudDataplexV1Glossary",
"description": "Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}"
},
"updateMask": {
"description": "Required. The list of fields to update.",
"format": "google-fieldmask",
"type": "string"
},
"validateOnly": {
"description": "Optional. Validates the request without actually updating the Glossary. Default: false.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDataplexV1UpdateGlossaryTermRequest": {
"description": "Update GlossaryTerm Request",
"id": "GoogleCloudDataplexV1UpdateGlossaryTermRequest",
"properties": {
"term": {
"$ref": "GoogleCloudDataplexV1GlossaryTerm",
"description": "Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}"
},
"updateMask": {
"description": "Required. The list of fields to update.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1Zone": {
"description": "A zone represents a logical group of related assets within a lake. A zone can be used to map to organizational structure or represent stages of data readiness from raw to curated. It provides managing behavior that is shared or inherited by all contained assets.",
"id": "GoogleCloudDataplexV1Zone",
"properties": {
"assetStatus": {
"$ref": "GoogleCloudDataplexV1AssetStatus",
"description": "Output only. Aggregated status of the underlying assets of the zone.",
"readOnly": true
},
"createTime": {
"description": "Output only. The time when the zone was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Description of the zone.",
"type": "string"
},
"discoverySpec": {
"$ref": "GoogleCloudDataplexV1ZoneDiscoverySpec",
"description": "Optional. Specification of the discovery feature applied to data in this zone."
},
"displayName": {
"description": "Optional. User friendly display name.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User defined labels for the zone.",
"type": "object"
},
"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}.",
"readOnly": true,
"type": "string"
},
"resourceSpec": {
"$ref": "GoogleCloudDataplexV1ZoneResourceSpec",
"description": "Required. Specification of the resources that are referenced by the assets within this zone."
},
"state": {
"description": "Output only. Current state of the zone.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"CREATING",
"DELETING",
"ACTION_REQUIRED"
],
"enumDescriptions": [
"State is not specified.",
"Resource is active, i.e., ready to use.",
"Resource is under creation.",
"Resource is under deletion.",
"Resource is active but has unresolved actions."
],
"readOnly": true,
"type": "string"
},
"type": {
"description": "Required. Immutable. The type of the zone.",
"enum": [
"TYPE_UNSPECIFIED",
"RAW",
"CURATED"
],
"enumDescriptions": [
"Zone type not specified.",
"A zone that contains data that needs further processing before it is considered generally ready for consumption and analytics workloads.",
"A zone that contains data that is considered to be ready for broader consumption and analytics workloads. Curated structured data stored in Cloud Storage must conform to certain file formats (parquet, avro and orc) and organized in a hive-compatible directory layout."
],
"type": "string"
},
"uid": {
"description": "Output only. System generated globally unique ID for the zone. This ID will be different if the zone is deleted and re-created with the same name.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the zone was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ZoneDiscoverySpec": {
"description": "Settings to manage the metadata discovery and publishing in a zone.",
"id": "GoogleCloudDataplexV1ZoneDiscoverySpec",
"properties": {
"csvOptions": {
"$ref": "GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions",
"description": "Optional. Configuration for CSV data."
},
"enabled": {
"description": "Required. Whether discovery is enabled.",
"type": "boolean"
},
"excludePatterns": {
"description": "Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.",
"items": {
"type": "string"
},
"type": "array"
},
"includePatterns": {
"description": "Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.",
"items": {
"type": "string"
},
"type": "array"
},
"jsonOptions": {
"$ref": "GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions",
"description": "Optional. Configuration for Json data."
},
"schedule": {
"description": "Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes.To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions": {
"description": "Describe CSV and similar semi-structured data formats.",
"id": "GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions",
"properties": {
"delimiter": {
"description": "Optional. The delimiter being used to separate values. This defaults to ','.",
"type": "string"
},
"disableTypeInference": {
"description": "Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.",
"type": "boolean"
},
"encoding": {
"description": "Optional. The character encoding of the data. The default is UTF-8.",
"type": "string"
},
"headerRows": {
"description": "Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions": {
"description": "Describe JSON data format.",
"id": "GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions",
"properties": {
"disableTypeInference": {
"description": "Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).",
"type": "boolean"
},
"encoding": {
"description": "Optional. The character encoding of the data. The default is UTF-8.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1ZoneResourceSpec": {
"description": "Settings for resources attached as assets within a zone.",
"id": "GoogleCloudDataplexV1ZoneResourceSpec",
"properties": {
"locationType": {
"description": "Required. Immutable. The location type of the resources that are allowed to be attached to the assets within this zone.",
"enum": [
"LOCATION_TYPE_UNSPECIFIED",
"SINGLE_REGION",
"MULTI_REGION"
],
"enumDescriptions": [
"Unspecified location type.",
"Resources that are associated with a single region.",
"Resources that are associated with a multi-region location."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudLocationListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "GoogleCloudLocationListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleCloudLocationLocation"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudLocationLocation": {
"description": "A resource that represents a Google Cloud location.",
"id": "GoogleCloudLocationLocation",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"} ",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: \"us-east1\".",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1AuditConfig": {
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.",
"id": "GoogleIamV1AuditConfig",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"items": {
"$ref": "GoogleIamV1AuditLogConfig"
},
"type": "array"
},
"service": {
"description": "Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.",
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
"id": "GoogleIamV1AuditLogConfig",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
},
"logType": {
"description": "The log type that this config enables.",
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1Binding": {
"description": "Associates members, or principals, with a role.",
"id": "GoogleIamV1Binding",
"properties": {
"condition": {
"$ref": "GoogleTypeExpr",
"description": "The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { \"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 } YAML example: 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 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).",
"id": "GoogleIamV1Policy",
"properties": {
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "GoogleIamV1AuditConfig"
},
"type": "array"
},
"bindings": {
"description": "Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.",
"items": {
"$ref": "GoogleIamV1Binding"
},
"type": "array"
},
"etag": {
"description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.",
"format": "byte",
"type": "string"
},
"version": {
"description": "Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleIamV1SetIamPolicyRequest": {
"description": "Request message for SetIamPolicy method.",
"id": "GoogleIamV1SetIamPolicyRequest",
"properties": {
"policy": {
"$ref": "GoogleIamV1Policy",
"description": "REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
},
"updateMask": {
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: \"bindings, etag\"",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1TestIamPermissionsRequest": {
"description": "Request message for TestIamPermissions method.",
"id": "GoogleIamV1TestIamPermissionsRequest",
"properties": {
"permissions": {
"description": "The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleIamV1TestIamPermissionsResponse": {
"description": "Response message for TestIamPermissions method.",
"id": "GoogleIamV1TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of TestPermissionsRequest.permissions that the caller is allowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleLongrunningCancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "GoogleLongrunningCancelOperationRequest",
"properties": {},
"type": "object"
},
"GoogleLongrunningListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "GoogleLongrunningListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleLongrunningOperation"
},
"type": "array"
},
"unreachable": {
"description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections. For example, when attempting to list all resources across all supported locations.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "GoogleLongrunningOperation",
"properties": {
"done": {
"description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
"type": "boolean"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
"type": "object"
}
},
"type": "object"
},
"GoogleRpcStatus": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).",
"id": "GoogleRpcStatus",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeExpr": {
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
"id": "GoogleTypeExpr",
"properties": {
"description": {
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in Common Expression Language syntax.",
"type": "string"
},
"location": {
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Dataplex API",
"version": "v1",
"version_module": true
}