Data Loss Prevention V2 Client - Class ContentLocation (2.2.2)

Reference documentation and code samples for the Data Loss Prevention V2 Client class ContentLocation.

Precise location of the finding within a document, record, image, or metadata container.

Generated from protobuf message google.privacy.dlp.v2.ContentLocation

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ container_name string

Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * * BigQuery tables: {project_id}:{dataset_id}.{table_id} * * Cloud Storage files: gs://{bucket}/{path} * * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document).
↳ record_location RecordLocation

Location within a row or record of a database table.
↳ image_location ImageLocation

Location within an image's pixels.
↳ document_location DocumentLocation

Location data for document files.
↳ metadata_location MetadataLocation

Location within the metadata for inspected content.
↳ container_timestamp Google\Protobuf\Timestamp

Finding 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.
↳ container_version string

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

getContainerName

Name of the container where the finding is located.

The top level name is the source file name or table name. Names of some common storage containers are formatted as follows:

  • BigQuery tables: {project_id}:{dataset_id}.{table_id}
  • Cloud Storage files: gs://{bucket}/{path}
  • Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document).
Returns
Type Description
string

setContainerName

Name of the container where the finding is located.

The top level name is the source file name or table name. Names of some common storage containers are formatted as follows:

  • BigQuery tables: {project_id}:{dataset_id}.{table_id}
  • Cloud Storage files: gs://{bucket}/{path}
  • Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document).
Parameter
Name Description
var string
Returns
Type Description
$this

getRecordLocation

Location within a row or record of a database table.

Returns
Type Description
RecordLocation|null

hasRecordLocation

setRecordLocation

Location within a row or record of a database table.

Parameter
Name Description
var RecordLocation
Returns
Type Description
$this

getImageLocation

Location within an image's pixels.

Returns
Type Description
ImageLocation|null

hasImageLocation

setImageLocation

Location within an image's pixels.

Parameter
Name Description
var ImageLocation
Returns
Type Description
$this

getDocumentLocation

Location data for document files.

Returns
Type Description
DocumentLocation|null

hasDocumentLocation

setDocumentLocation

Location data for document files.

Parameter
Name Description
var DocumentLocation
Returns
Type Description
$this

getMetadataLocation

Location within the metadata for inspected content.

Returns
Type Description
MetadataLocation|null

hasMetadataLocation

setMetadataLocation

Location within the metadata for inspected content.

Parameter
Name Description
var MetadataLocation
Returns
Type Description
$this

getContainerTimestamp

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasContainerTimestamp

clearContainerTimestamp

setContainerTimestamp

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getContainerVersion

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

Returns
Type Description
string

setContainerVersion

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

Parameter
Name Description
var string
Returns
Type Description
$this

getLocation

Returns
Type Description
string