# The DLP API Definition.

type: google.api.Service
config_version: 3
name: dlp.googleapis.com

title: DLP API

documentation:
  summary:
     The Google Data Loss Prevention API provides methods for detection
     of privacy-sensitive fragments in text, images, and Google Cloud
     Platform storage repositories.
  overview: |
    (== suppress_warning documentation-presence ==)
  rules:
  - selector: google.longrunning.ListOperationsRequest
    description: Fetch the list of long running operations.`

  - selector: google.longrunning.ListOperationsRequest.filter
    description: This parameter supports filtering by done, ie done=true or done=false.

  - selector: google.longrunning.ListOperationsRequest.page_size
    description: The list page size. The max allowed value is 256 and default is 100.

  - selector: google.longrunning.ListOperationsRequest.page_token
    description: The list page token.

  - selector: google.longrunning.Operation.name
    description: >
      The server-assigned name, The `name`
      should have the format of `inspect/operations/<identifier>`.

  - selector: google.longrunning.Operation.metadata
    description: >
     This field will contain an
     [`InspectOperationMetdata`][google.privacy.dlp.v2beta1.InspectOperationMetadata] object.

  - selector: google.longrunning.Operation.response
    description: >
      This field will contain an
      [`InspectOperationResult`][google.privacy.dlp.v2beta1.InspectOperationResult] object.

  - selector: google.longrunning.Operations.CancelOperation
    description: >
      Cancels an operation. Use the get method to check whether the cancellation
      succeeded or whether the operation completed despite cancellation.

  - selector: google.longrunning.Operations.DeleteOperation
    description: This method is not supported and the server returns `UNIMPLEMENTED`.

apis:
  - name: google.privacy.dlp.v2beta1.DlpService

authentication:
  rules:
    - selector: '*'
      oauth:
        canonical_scopes: https://www.googleapis.com/auth/cloud-platform