Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: dlp2 --scope <scope> projects locations-dlp-jobs-hybrid-inspect ...

Required Scalar Argument

• <name> (string)
  • Required. Resource name of the job to execute a hybrid inspect on, for example projects/dlp-test-project/dlpJob/53234423.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GooglePrivacyDlpV2HybridInspectDlpJobRequest:
  hybrid-item:
    finding-details:
      container-details:
        full-path: string
        project-id: string
        relative-path: string
        root-path: string
        type: string
        update-time: string
        version: string
      file-offset: string
      labels: { string: string }
      row-offset: string
    item:
      byte-item:
        data: string
        type: string
      value: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r .hybrid-item.finding-details.container-details full-path=lorem
  • A string representation of the full container name. Examples: - BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: 'gs://Bucket/folders/filename.txt'
• project-id=amet.
  • Project where the finding was found. Can be different from the project that owns the finding.
• relative-path=diam
  • The rest of the path after the root. Examples: - For BigQuery table project_id:dataset_id.table_id, the relative path is table_id - For Cloud Storage file gs://bucket/folder/filename.txt, the relative path is folder/filename.txt
• root-path=diam
  • The root of the container. Examples: - For BigQuery table project_id:dataset_id.table_id, the root is dataset_id - For Cloud Storage file gs://bucket/folder/filename.txt, the root is gs://bucket
• type=et
  • Container type, for example BigQuery or Cloud Storage.
• update-time=takimata
  • Findings container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated.

• version=et

  • Findings container version, if available ("generation" for Cloud Storage).

• .. file-offset=dolores

  • Offset in bytes of the line, from the beginning of the file, where the finding is located. Populate if the item being scanned is only part of a bigger item, such as a shard of a file and you want to track the absolute position of the finding.
• labels=key=dolores
  • Labels to represent user provided metadata about the data being inspected. If configured by the job, some key values may be required. The labels associated with Finding's produced by hybrid inspection. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 10 labels can be associated with a given finding. Examples: * "environment" : "production" * "pipeline" : "etl"
  • the value will be associated with the given key

• row-offset=diam

  • Offset of the row for tables. Populate if the row(s) being scanned are part of a bigger dataset and you want to keep track of their absolute position.

• ..item.byte-item data=ea

  • Content data to inspect or redact.

• type=sea

  • The type of data stored in the bytes string. Default will be TEXT_UTF8.

• .. value=dolore

  • String data to inspect or redact.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • 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.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • 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.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").