# DLP API . inspect . operations

## Instance Methods

Cancels an operation. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.

Schedule a job scanning content in a Google Cloud Platform data repository.

This method is not supported and the server returns `UNIMPLEMENTED`.

Gets the latest state of a long-running operation. Clients can use this

Lists operations that match the specified filter in the request. If the

Retrieves the next page of results.

### Method Details

`cancel(name, body, x__xgafv=None)`

    Cancels an operation. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.

    Args:
      name: string, The name of the operation resource to be cancelled. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # The request message for Operations.CancelOperation.
      }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # 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);
          #     }
          #
          # The JSON representation for `Empty` is empty JSON object `{}`.
      }

`create(body, x__xgafv=None)`

    Schedule a job scanning content in a Google Cloud Platform data repository.

    Args:
      body: object, The request body. (required)
        The object takes the form of:

    { # Request for scheduling a scan of a data subset from a Google Platform data
          # repository.
        "outputConfig": { # Cloud repository for storing output. # Optional location to store findings. The bucket must already exist and
            # the Google APIs service account for DLP must have write permission to
            # write to the given bucket.
            # Results are split over multiple csv files with each file name matching
            # the pattern "[operation_id]_[count].csv", for example
            # `3094877188788974909_1.csv`. The `operation_id` matches the
            # identifier for the Operation, and the `count` is a counter used for
            # tracking the number of files written. The CSV file(s) contain the
            # following columns regardless of storage type scanned: id info_type
            # likelihood byte size of finding quote time_stamp

            # For Cloud Storage the next columns are: file_path
            # start_offset

            # For Cloud Datastore the next columns are: project_id
            # namespace_id path column_name offset
          "storagePath": { # A location in Cloud Storage. # The path to a Google Cloud Storage location to store output.
            "path": "A String", # The url, in the format of `gs://bucket/`.
          },
        },
        "inspectConfig": { # Configuration description of the scanning process. # Configuration for the inspector.
            # When used with redactContent only info_types and min_likelihood are currently
            # used.
          "minLikelihood": "A String", # Only return findings equal or above this threshold.
          "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is
              # included in the response; see Finding.quote.
          "excludeTypes": True or False, # When true, exclude type information of the findings.
          "infoTypes": [ # Restrict what info_types to look for. The values must correspond to
              # InfoType values returned by ListInfoTypes or found in documentation.
              # Empty info_types runs all enabled detectors.
            { # Type of information detected by the API.
              "name": "A String", # Name of the information type. For built-in info types, this is provided by
                  # the API call ListInfoTypes. For user-defined info types, this is
                  # provided by the user. All user-defined info types must have unique names,
                  # and cannot conflict with built-in info type names.
            },
          ],
          "maxFindings": 42, # Limit the number of findings per content item.
        },
        "storageConfig": { # Shared message indicating Cloud storage type. # Specification of the data set to process.
          "datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options specification.
            "kind": { # A representation of a Datastore kind. # The kind to process.
              "name": "A String", # The name of the kind.
            },
            "projection": [ # Properties to scan. If none are specified, all properties will be scanned
                # by default.
              { # A representation of a Datastore property in a projection.
                "property": { # A reference to a property relative to the Datastore kind expressions. # The property to project.
                  "name": "A String", # The name of the property.
                      # If name includes "."s, it may be interpreted as a property name path.
                },
              },
            ],
            "partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always
                # by project and namespace, however the namespace ID may be empty.
                # A partition ID identifies a grouping of entities. The grouping is always
                # by project and namespace, however the namespace ID may be empty.
                #
                # A partition ID contains several dimensions:
                # project ID and namespace ID.
              "projectId": "A String", # The ID of the project to which the entities belong.
              "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
            },
          },
          "cloudStorageOptions": { # Options defining a file or a set of files (path ending with *) within # Google Cloud Storage options specification.
              # a Google Cloud Storage bucket.
            "fileSet": { # Set of files to scan.
              "url": "A String", # The url, in the format `gs:///`. Trailing wildcard in the
                  # path is allowed.
            },
          },
        },
      }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "metadata": { # This field will contain an `InspectOperationMetadata` object.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "done": True or False, # 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.
        "response": { # This field will contain an `InspectOperationResult` object.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/`.
        "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
            # programming environments, including REST APIs and RPC APIs. It is used by
            # [gRPC](https://github.com/grpc). The error model is designed to be:
            #
            # - Simple to use and understand for most users
            # - Flexible enough to meet unexpected needs
            #
            # # Overview
            #
            # The `Status` message contains three pieces of data: error code, error message,
            # and error details. The error code should be an enum value of
            # google.rpc.Code, but it may accept additional error codes if needed.  The
            # error message should be a developer-facing English message that helps
            # developers *understand* and *resolve* the error. If a localized user-facing
            # error message is needed, put the localized message in the error details or
            # localize it in the client. The optional error details may contain arbitrary
            # information about the error. There is a predefined set of error detail types
            # in the package `google.rpc` that can be used for common error conditions.
            #
            # # Language mapping
            #
            # The `Status` message is the logical representation of the error model, but it
            # is not necessarily the actual wire format. When the `Status` message is
            # exposed in different client libraries and different wire protocols, it can be
            # mapped differently. For example, it will likely be mapped to some exceptions
            # in Java, but more likely mapped to some error codes in C.
            #
            # # Other uses
            #
            # The error model and the `Status` message can be used in a variety of
            # environments, either with or without APIs, to provide a
            # consistent developer experience across different environments.
            #
            # Example uses of this error model include:
            #
            # - Partial errors. If a service needs to return partial errors to the client,
            #     it may embed the `Status` in the normal response to indicate the partial
            #     errors.
            #
            # - Workflow errors. A typical workflow has multiple steps. Each step may
            #     have a `Status` message for error reporting.
            #
            # - Batch operations. If a client uses batch request and batch response, the
            #     `Status` message should be used directly inside batch response, one for
            #     each error sub-response.
            #
            # - Asynchronous operations. If an API call embeds asynchronous operation
            #     results in its response, the status of those operations should be
            #     represented directly using the `Status` message.
            #
            # - Logging. If some API errors are stored in logs, the message `Status` could
            #     be used directly after any stripping needed for security/privacy reasons.
          "message": "A String", # 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.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There will be a
              # common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
      }

`delete(name, x__xgafv=None)`

    This method is not supported and the server returns `UNIMPLEMENTED`.

    Args:
      name: string, The name of the operation resource to be deleted. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # 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);
          #     }
          #
          # The JSON representation for `Empty` is empty JSON object `{}`.
      }

`get(name, x__xgafv=None)`

    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.

    Args:
      name: string, The name of the operation resource. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "metadata": { # This field will contain an `InspectOperationMetadata` object.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "done": True or False, # 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.
        "response": { # This field will contain an `InspectOperationResult` object.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/`.
        "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
            # programming environments, including REST APIs and RPC APIs. It is used by
            # [gRPC](https://github.com/grpc). The error model is designed to be:
            #
            # - Simple to use and understand for most users
            # - Flexible enough to meet unexpected needs
            #
            # # Overview
            #
            # The `Status` message contains three pieces of data: error code, error message,
            # and error details. The error code should be an enum value of
            # google.rpc.Code, but it may accept additional error codes if needed.  The
            # error message should be a developer-facing English message that helps
            # developers *understand* and *resolve* the error. If a localized user-facing
            # error message is needed, put the localized message in the error details or
            # localize it in the client. The optional error details may contain arbitrary
            # information about the error. There is a predefined set of error detail types
            # in the package `google.rpc` that can be used for common error conditions.
            #
            # # Language mapping
            #
            # The `Status` message is the logical representation of the error model, but it
            # is not necessarily the actual wire format. When the `Status` message is
            # exposed in different client libraries and different wire protocols, it can be
            # mapped differently. For example, it will likely be mapped to some exceptions
            # in Java, but more likely mapped to some error codes in C.
            #
            # # Other uses
            #
            # The error model and the `Status` message can be used in a variety of
            # environments, either with or without APIs, to provide a
            # consistent developer experience across different environments.
            #
            # Example uses of this error model include:
            #
            # - Partial errors. If a service needs to return partial errors to the client,
            #     it may embed the `Status` in the normal response to indicate the partial
            #     errors.
            #
            # - Workflow errors. A typical workflow has multiple steps. Each step may
            #     have a `Status` message for error reporting.
            #
            # - Batch operations. If a client uses batch request and batch response, the
            #     `Status` message should be used directly inside batch response, one for
            #     each error sub-response.
            #
            # - Asynchronous operations. If an API call embeds asynchronous operation
            #     results in its response, the status of those operations should be
            #     represented directly using the `Status` message.
            #
            # - Logging. If some API errors are stored in logs, the message `Status` could
            #     be used directly after any stripping needed for security/privacy reasons.
          "message": "A String", # 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.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There will be a
              # common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
      }

`list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)`

    Lists operations that match the specified filter in the request. If the
    server doesn't support this method, it returns `UNIMPLEMENTED`.

    NOTE: the `name` binding allows API services to override the binding
    to use different resource name schemes, such as `users/*/operations`. To
    override the binding, API services can add a binding such as
    `"/v1/{name=users/*}/operations"` to their service configuration.
    For backwards compatibility, the default name includes the operations
    collection id, however overriding users must ensure the name binding
    is the parent resource, without the operations collection id.

    Args:
      name: string, The name of the operation's parent resource. (required)
      pageSize: integer, The list page size. The max allowed value is 256 and default is 100.
      filter: string, This parameter supports filtering by done, ie done=true or done=false.
      pageToken: string, The list page token.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # The response message for Operations.ListOperations.
        "nextPageToken": "A String", # The standard List next-page token.
        "operations": [ # A list of operations that matches the specified filter in the request.
          { # This resource represents a long-running operation that is the result of a
              # network API call.
            "metadata": { # This field will contain an `InspectOperationMetadata` object.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
            "done": True or False, # 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.
            "response": { # This field will contain an `InspectOperationResult` object.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
            "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/`.
            "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
                # programming environments, including REST APIs and RPC APIs. It is used by
                # [gRPC](https://github.com/grpc). The error model is designed to be:
                #
                # - Simple to use and understand for most users
                # - Flexible enough to meet unexpected needs
                #
                # # Overview
                #
                # The `Status` message contains three pieces of data: error code, error message,
                # and error details. The error code should be an enum value of
                # google.rpc.Code, but it may accept additional error codes if needed.  The
                # error message should be a developer-facing English message that helps
                # developers *understand* and *resolve* the error. If a localized user-facing
                # error message is needed, put the localized message in the error details or
                # localize it in the client. The optional error details may contain arbitrary
                # information about the error. There is a predefined set of error detail types
                # in the package `google.rpc` that can be used for common error conditions.
                #
                # # Language mapping
                #
                # The `Status` message is the logical representation of the error model, but it
                # is not necessarily the actual wire format. When the `Status` message is
                # exposed in different client libraries and different wire protocols, it can be
                # mapped differently. For example, it will likely be mapped to some exceptions
                # in Java, but more likely mapped to some error codes in C.
                #
                # # Other uses
                #
                # The error model and the `Status` message can be used in a variety of
                # environments, either with or without APIs, to provide a
                # consistent developer experience across different environments.
                #
                # Example uses of this error model include:
                #
                # - Partial errors. If a service needs to return partial errors to the client,
                #     it may embed the `Status` in the normal response to indicate the partial
                #     errors.
                #
                # - Workflow errors. A typical workflow has multiple steps. Each step may
                #     have a `Status` message for error reporting.
                #
                # - Batch operations. If a client uses batch request and batch response, the
                #     `Status` message should be used directly inside batch response, one for
                #     each error sub-response.
                #
                # - Asynchronous operations. If an API call embeds asynchronous operation
                #     results in its response, the status of those operations should be
                #     represented directly using the `Status` message.
                #
                # - Logging. If some API errors are stored in logs, the message `Status` could
                #     be used directly after any stripping needed for security/privacy reasons.
              "message": "A String", # 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.
              "code": 42, # The status code, which should be an enum value of google.rpc.Code.
              "details": [ # A list of messages that carry the error details.  There will be a
                  # common set of message types for APIs to use.
                {
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              ],
            },
          },
        ],
      }

`list_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.