Class DlpServiceClient (2.22.0)

The Cloud Data Loss Prevention (DLP) API is a service that allows clients to detect the presence of Personally Identifiable Information (PII) and other privacy-sensitive data in user-supplied, unstructured data streams, like text blocks or images.

The service also includes methods for sensitive data redaction and scheduling of data scans on Google Cloud Platform based data sets.

To learn more about concepts and find how-to guides see https://cloud.google.com/dlp/docs/.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

DlpServiceClient(DlpServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DlpServiceClient const &`

DlpServiceClient(DlpServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DlpServiceClient &&`

DlpServiceClient(std::shared_ptr< DlpServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< DlpServiceConnection >`
`opts`	`Options`

Operators

operator=(DlpServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DlpServiceClient const &`

Returns
Type	Description
`DlpServiceClient &`

operator=(DlpServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DlpServiceClient &&`

Returns
Type	Description
`DlpServiceClient &`

Functions

InspectContent(google::privacy::dlp::v2::InspectContentRequest const &, Options)

Finds potentially sensitive info in content.

This method has limits on input size, processing time, and output size.

When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text,

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::InspectContentRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.InspectContentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::InspectContentResponse >`	the result of the RPC. The response message type (google.privacy.dlp.v2.InspectContentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RedactImage(google::privacy::dlp::v2::RedactImageRequest const &, Options)

Redacts potentially sensitive info from an image.

This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::RedactImageRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.RedactImageRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::RedactImageResponse >`	the result of the RPC. The response message type (google.privacy.dlp.v2.RedactImageResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeidentifyContent(google::privacy::dlp::v2::DeidentifyContentRequest const &, Options)

De-identifies potentially sensitive info from a ContentItem.

This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::DeidentifyContentRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.DeidentifyContentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DeidentifyContentResponse >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DeidentifyContentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ReidentifyContent(google::privacy::dlp::v2::ReidentifyContentRequest const &, Options)

Re-identifies content that has been de-identified.

See https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::ReidentifyContentRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.ReidentifyContentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::ReidentifyContentResponse >`	the result of the RPC. The response message type (google.privacy.dlp.v2.ReidentifyContentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListInfoTypes(std::string const &, Options)

Returns a list of the sensitive information types that DLP API supports.

See https://cloud.google.com/dlp/docs/infotypes-reference to learn more.

Parameters
Name	Description
`parent`	`std::string const &` The parent resource name. The format of this value is as follows: locations/LOCATION_ID
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::ListInfoTypesResponse >`	the result of the RPC. The response message type (google.privacy.dlp.v2.ListInfoTypesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListInfoTypes(google::privacy::dlp::v2::ListInfoTypesRequest const &, Options)

Returns a list of the sensitive information types that DLP API supports.

See https://cloud.google.com/dlp/docs/infotypes-reference to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::ListInfoTypesRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.ListInfoTypesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::ListInfoTypesResponse >`	the result of the RPC. The response message type (google.privacy.dlp.v2.ListInfoTypesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateInspectTemplate(std::string const &, google::privacy::dlp::v2::InspectTemplate const &, Options)

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage.

See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location: Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3
`inspect_template`	`google::privacy::dlp::v2::InspectTemplate const &` Required. The InspectTemplate to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::InspectTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.InspectTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateInspectTemplate(google::privacy::dlp::v2::CreateInspectTemplateRequest const &, Options)

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage.

See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::CreateInspectTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.CreateInspectTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::InspectTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.InspectTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateInspectTemplate(std::string const &, google::privacy::dlp::v2::InspectTemplate const &, google::protobuf::FieldMask const &, Options)

Updates the InspectTemplate.

See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.
`inspect_template`	`google::privacy::dlp::v2::InspectTemplate const &` New InspectTemplate value.
`update_mask`	`google::protobuf::FieldMask const &` Mask to control which fields get updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::InspectTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.InspectTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateInspectTemplate(google::privacy::dlp::v2::UpdateInspectTemplateRequest const &, Options)

Updates the InspectTemplate.

See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::UpdateInspectTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.UpdateInspectTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::InspectTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.InspectTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetInspectTemplate(std::string const &, Options)

Gets an InspectTemplate.

See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::InspectTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.InspectTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetInspectTemplate(google::privacy::dlp::v2::GetInspectTemplateRequest const &, Options)

Gets an InspectTemplate.

See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::GetInspectTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.GetInspectTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::InspectTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.InspectTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListInspectTemplates(std::string const &, Options)

Lists InspectTemplates.

See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Parameters

Name Description

parent

std::string const &

Required. Parent resource name.
The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_ID
Projects scope, no location specified (defaults to global):
projects/PROJECT_ID
Organizations scope, location specified:
organizations/ORG_ID/locations/LOCATION_ID
Organizations scope, no location specified (defaults to global):
organizations/ORG_ID
The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
parent=projects/example-project/locations/europe-west3

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::InspectTemplate >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.privacy.dlp.v2.InspectTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListInspectTemplates(google::privacy::dlp::v2::ListInspectTemplatesRequest, Options)

Lists InspectTemplates.

See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::ListInspectTemplatesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.ListInspectTemplatesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::InspectTemplate >

DeleteInspectTemplate(std::string const &, Options)

Deletes an InspectTemplate.

See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteInspectTemplate(google::privacy::dlp::v2::DeleteInspectTemplateRequest const &, Options)

Deletes an InspectTemplate.

See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::DeleteInspectTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.DeleteInspectTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CreateDeidentifyTemplate(std::string const &, google::privacy::dlp::v2::DeidentifyTemplate const &, Options)

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage.

See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location: Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3
`deidentify_template`	`google::privacy::dlp::v2::DeidentifyTemplate const &` Required. The DeidentifyTemplate to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DeidentifyTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DeidentifyTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateDeidentifyTemplate(google::privacy::dlp::v2::CreateDeidentifyTemplateRequest const &, Options)

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage.

See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::CreateDeidentifyTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.CreateDeidentifyTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DeidentifyTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DeidentifyTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateDeidentifyTemplate(std::string const &, google::privacy::dlp::v2::DeidentifyTemplate const &, google::protobuf::FieldMask const &, Options)

Updates the DeidentifyTemplate.

See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
`deidentify_template`	`google::privacy::dlp::v2::DeidentifyTemplate const &` New DeidentifyTemplate value.
`update_mask`	`google::protobuf::FieldMask const &` Mask to control which fields get updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DeidentifyTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DeidentifyTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateDeidentifyTemplate(google::privacy::dlp::v2::UpdateDeidentifyTemplateRequest const &, Options)

Updates the DeidentifyTemplate.

See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::UpdateDeidentifyTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.UpdateDeidentifyTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DeidentifyTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DeidentifyTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetDeidentifyTemplate(std::string const &, Options)

Gets a DeidentifyTemplate.

See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DeidentifyTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DeidentifyTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetDeidentifyTemplate(google::privacy::dlp::v2::GetDeidentifyTemplateRequest const &, Options)

Gets a DeidentifyTemplate.

See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::GetDeidentifyTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.GetDeidentifyTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DeidentifyTemplate >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DeidentifyTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListDeidentifyTemplates(std::string const &, Options)

Lists DeidentifyTemplates.

See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Parameters

Name Description

parent

std::string const &

Required. Parent resource name.
The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_ID
Projects scope, no location specified (defaults to global):
projects/PROJECT_ID
Organizations scope, location specified:
organizations/ORG_ID/locations/LOCATION_ID
Organizations scope, no location specified (defaults to global):
organizations/ORG_ID
The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
parent=projects/example-project/locations/europe-west3

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::DeidentifyTemplate >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.privacy.dlp.v2.DeidentifyTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDeidentifyTemplates(google::privacy::dlp::v2::ListDeidentifyTemplatesRequest, Options)

Lists DeidentifyTemplates.

See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::ListDeidentifyTemplatesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.ListDeidentifyTemplatesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::DeidentifyTemplate >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.privacy.dlp.v2.DeidentifyTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteDeidentifyTemplate(std::string const &, Options)

Deletes a DeidentifyTemplate.

See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteDeidentifyTemplate(google::privacy::dlp::v2::DeleteDeidentifyTemplateRequest const &, Options)

Deletes a DeidentifyTemplate.

See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::DeleteDeidentifyTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.DeleteDeidentifyTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CreateJobTrigger(std::string const &, google::privacy::dlp::v2::JobTrigger const &, Options)

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule.

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource name. The format of this value varies depending on whether you have specified a processing location: Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3
`job_trigger`	`google::privacy::dlp::v2::JobTrigger const &` Required. The JobTrigger to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::JobTrigger >`	the result of the RPC. The response message type (google.privacy.dlp.v2.JobTrigger) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateJobTrigger(google::privacy::dlp::v2::CreateJobTriggerRequest const &, Options)

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule.

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::CreateJobTriggerRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.CreateJobTriggerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::JobTrigger >`	the result of the RPC. The response message type (google.privacy.dlp.v2.JobTrigger) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateJobTrigger(std::string const &, google::privacy::dlp::v2::JobTrigger const &, google::protobuf::FieldMask const &, Options)

Updates a job trigger.

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.
`job_trigger`	`google::privacy::dlp::v2::JobTrigger const &` New JobTrigger value.
`update_mask`	`google::protobuf::FieldMask const &` Mask to control which fields get updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::JobTrigger >`	the result of the RPC. The response message type (google.privacy.dlp.v2.JobTrigger) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateJobTrigger(google::privacy::dlp::v2::UpdateJobTriggerRequest const &, Options)

Updates a job trigger.

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::UpdateJobTriggerRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.UpdateJobTriggerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::JobTrigger >`	the result of the RPC. The response message type (google.privacy.dlp.v2.JobTrigger) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

HybridInspectJobTrigger(std::string const &, Options)

Inspect hybrid content and store findings to a trigger.

The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the trigger to execute a hybrid inspect on, for example `projects/dlp-test-project/jobTriggers/53234423`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::HybridInspectResponse >`	the result of the RPC. The response message type (google.privacy.dlp.v2.HybridInspectResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

HybridInspectJobTrigger(google::privacy::dlp::v2::HybridInspectJobTriggerRequest const &, Options)

Inspect hybrid content and store findings to a trigger.

The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::HybridInspectJobTriggerRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.HybridInspectJobTriggerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::HybridInspectResponse >`	the result of the RPC. The response message type (google.privacy.dlp.v2.HybridInspectResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetJobTrigger(std::string const &, Options)

Gets a job trigger.

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::JobTrigger >`	the result of the RPC. The response message type (google.privacy.dlp.v2.JobTrigger) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetJobTrigger(google::privacy::dlp::v2::GetJobTriggerRequest const &, Options)

Gets a job trigger.

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::GetJobTriggerRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.GetJobTriggerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::JobTrigger >`	the result of the RPC. The response message type (google.privacy.dlp.v2.JobTrigger) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListJobTriggers(std::string const &, Options)

Lists job triggers.

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Parameters

Name Description

parent

std::string const &

Required. Parent resource name.
The format of this value varies depending on whether you have specified a processing location:

Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_ID
Projects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
parent=projects/example-project/locations/europe-west3

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::JobTrigger >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.privacy.dlp.v2.JobTrigger, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListJobTriggers(google::privacy::dlp::v2::ListJobTriggersRequest, Options)

Lists job triggers.

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::ListJobTriggersRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.ListJobTriggersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::JobTrigger >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.privacy.dlp.v2.JobTrigger, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteJobTrigger(std::string const &, Options)

Deletes a job trigger.

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteJobTrigger(google::privacy::dlp::v2::DeleteJobTriggerRequest const &, Options)

Deletes a job trigger.

See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::DeleteJobTriggerRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.DeleteJobTriggerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ActivateJobTrigger(google::privacy::dlp::v2::ActivateJobTriggerRequest const &, Options)

Activate a job trigger.

Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::ActivateJobTriggerRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.ActivateJobTriggerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DlpJob >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DlpJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateDiscoveryConfig(std::string const &, google::privacy::dlp::v2::DiscoveryConfig const &, Options)

Creates a config for discovery to scan and profile storage.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource name. The format of this value is as follows: `projects/`PROJECT_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3
`discovery_config`	`google::privacy::dlp::v2::DiscoveryConfig const &` Required. The DiscoveryConfig to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DiscoveryConfig >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DiscoveryConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateDiscoveryConfig(google::privacy::dlp::v2::CreateDiscoveryConfigRequest const &, Options)

Creates a config for discovery to scan and profile storage.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::CreateDiscoveryConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.CreateDiscoveryConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DiscoveryConfig >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DiscoveryConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateDiscoveryConfig(std::string const &, google::privacy::dlp::v2::DiscoveryConfig const &, google::protobuf::FieldMask const &, Options)

Updates a discovery configuration.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the project and the configuration, for example `projects/dlp-test-project/discoveryConfigs/53234423`.
`discovery_config`	`google::privacy::dlp::v2::DiscoveryConfig const &` Required. New DiscoveryConfig value.
`update_mask`	`google::protobuf::FieldMask const &` Mask to control which fields get updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DiscoveryConfig >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DiscoveryConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateDiscoveryConfig(google::privacy::dlp::v2::UpdateDiscoveryConfigRequest const &, Options)

Updates a discovery configuration.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::UpdateDiscoveryConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.UpdateDiscoveryConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DiscoveryConfig >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DiscoveryConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetDiscoveryConfig(std::string const &, Options)

Gets a discovery configuration.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the project and the configuration, for example `projects/dlp-test-project/discoveryConfigs/53234423`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DiscoveryConfig >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DiscoveryConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetDiscoveryConfig(google::privacy::dlp::v2::GetDiscoveryConfigRequest const &, Options)

Gets a discovery configuration.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::GetDiscoveryConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.GetDiscoveryConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DiscoveryConfig >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DiscoveryConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListDiscoveryConfigs(std::string const &, Options)

Lists discovery configurations.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource name. The format of this value is as follows: `projects/`PROJECT_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::DiscoveryConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.privacy.dlp.v2.DiscoveryConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDiscoveryConfigs(google::privacy::dlp::v2::ListDiscoveryConfigsRequest, Options)

Lists discovery configurations.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::ListDiscoveryConfigsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.ListDiscoveryConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::DiscoveryConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.privacy.dlp.v2.DiscoveryConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteDiscoveryConfig(std::string const &, Options)

Deletes a discovery configuration.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the project and the config, for example `projects/dlp-test-project/discoveryConfigs/53234423`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteDiscoveryConfig(google::privacy::dlp::v2::DeleteDiscoveryConfigRequest const &, Options)

Deletes a discovery configuration.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::DeleteDiscoveryConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.DeleteDiscoveryConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CreateDlpJob(std::string const &, google::privacy::dlp::v2::InspectJobConfig const &, Options)

Creates a new job to inspect storage or calculate risk metrics.

See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource name. The format of this value varies depending on whether you have specified a processing location: Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3
`inspect_job`	`google::privacy::dlp::v2::InspectJobConfig const &` An inspection job scans a storage repository for InfoTypes.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DlpJob >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DlpJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateDlpJob(std::string const &, google::privacy::dlp::v2::RiskAnalysisJobConfig const &, Options)

Creates a new job to inspect storage or calculate risk metrics.

See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource name. The format of this value varies depending on whether you have specified a processing location: Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3
`risk_job`	`google::privacy::dlp::v2::RiskAnalysisJobConfig const &` A risk analysis job calculates re-identification risk metrics for a BigQuery table.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DlpJob >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DlpJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateDlpJob(google::privacy::dlp::v2::CreateDlpJobRequest const &, Options)

Creates a new job to inspect storage or calculate risk metrics.

See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::CreateDlpJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.CreateDlpJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DlpJob >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DlpJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListDlpJobs(std::string const &, Options)

Lists DlpJobs that match the specified filter in the request.

See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Parameters

Name Description

parent

std::string const &

Required. Parent resource name.
The format of this value varies depending on whether you have specified a processing location:

Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_ID
Projects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
parent=projects/example-project/locations/europe-west3

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::DlpJob >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.privacy.dlp.v2.DlpJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDlpJobs(google::privacy::dlp::v2::ListDlpJobsRequest, Options)

Lists DlpJobs that match the specified filter in the request.

See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::ListDlpJobsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.ListDlpJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::DlpJob >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.privacy.dlp.v2.DlpJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetDlpJob(std::string const &, Options)

Gets the latest state of a long-running DlpJob.

See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the DlpJob resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DlpJob >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DlpJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetDlpJob(google::privacy::dlp::v2::GetDlpJobRequest const &, Options)

Gets the latest state of a long-running DlpJob.

See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::GetDlpJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.GetDlpJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::DlpJob >`	the result of the RPC. The response message type (google.privacy.dlp.v2.DlpJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteDlpJob(std::string const &, Options)

Deletes a long-running DlpJob.

This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the DlpJob resource to be deleted.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteDlpJob(google::privacy::dlp::v2::DeleteDlpJobRequest const &, Options)

Deletes a long-running DlpJob.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::DeleteDlpJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.DeleteDlpJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CancelDlpJob(google::privacy::dlp::v2::CancelDlpJobRequest const &, Options)

Starts asynchronous cancellation on a long-running DlpJob.

The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::CancelDlpJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.CancelDlpJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CreateStoredInfoType(std::string const &, google::privacy::dlp::v2::StoredInfoTypeConfig const &, Options)

Creates a pre-built stored infoType to be used for inspection.

See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location: Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3
`config`	`google::privacy::dlp::v2::StoredInfoTypeConfig const &` Required. Configuration of the storedInfoType to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::StoredInfoType >`	the result of the RPC. The response message type (google.privacy.dlp.v2.StoredInfoType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateStoredInfoType(google::privacy::dlp::v2::CreateStoredInfoTypeRequest const &, Options)

Creates a pre-built stored infoType to be used for inspection.

See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::CreateStoredInfoTypeRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.CreateStoredInfoTypeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::StoredInfoType >`	the result of the RPC. The response message type (google.privacy.dlp.v2.StoredInfoType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateStoredInfoType(std::string const &, google::privacy::dlp::v2::StoredInfoTypeConfig const &, google::protobuf::FieldMask const &, Options)

Updates the stored infoType by creating a new version.

The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.
`config`	`google::privacy::dlp::v2::StoredInfoTypeConfig const &` Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration.
`update_mask`	`google::protobuf::FieldMask const &` Mask to control which fields get updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::StoredInfoType >`	the result of the RPC. The response message type (google.privacy.dlp.v2.StoredInfoType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateStoredInfoType(google::privacy::dlp::v2::UpdateStoredInfoTypeRequest const &, Options)

Updates the stored infoType by creating a new version.

The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::UpdateStoredInfoTypeRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.UpdateStoredInfoTypeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::StoredInfoType >`	the result of the RPC. The response message type (google.privacy.dlp.v2.StoredInfoType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetStoredInfoType(std::string const &, Options)

Gets a stored infoType.

See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::StoredInfoType >`	the result of the RPC. The response message type (google.privacy.dlp.v2.StoredInfoType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetStoredInfoType(google::privacy::dlp::v2::GetStoredInfoTypeRequest const &, Options)

Gets a stored infoType.

See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::GetStoredInfoTypeRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.GetStoredInfoTypeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::StoredInfoType >`	the result of the RPC. The response message type (google.privacy.dlp.v2.StoredInfoType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListStoredInfoTypes(std::string const &, Options)

Lists stored infoTypes.

See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Parameters

Name Description

parent

std::string const &

Required. Parent resource name.
The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_ID
Projects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
parent=projects/example-project/locations/europe-west3

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::StoredInfoType >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.privacy.dlp.v2.StoredInfoType, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListStoredInfoTypes(google::privacy::dlp::v2::ListStoredInfoTypesRequest, Options)

Lists stored infoTypes.

See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::ListStoredInfoTypesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.ListStoredInfoTypesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::privacy::dlp::v2::StoredInfoType >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.privacy.dlp.v2.StoredInfoType, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteStoredInfoType(std::string const &, Options)

Deletes a stored infoType.

See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteStoredInfoType(google::privacy::dlp::v2::DeleteStoredInfoTypeRequest const &, Options)

Deletes a stored infoType.

See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::DeleteStoredInfoTypeRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.DeleteStoredInfoTypeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

HybridInspectDlpJob(std::string const &, Options)

Inspect hybrid content and store findings to a job.

To review the findings, inspect the job. Inspection will occur asynchronously.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the job to execute a hybrid inspect on, for example `projects/dlp-test-project/dlpJob/53234423`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::HybridInspectResponse >`	the result of the RPC. The response message type (google.privacy.dlp.v2.HybridInspectResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

HybridInspectDlpJob(google::privacy::dlp::v2::HybridInspectDlpJobRequest const &, Options)

Inspect hybrid content and store findings to a job.

To review the findings, inspect the job. Inspection will occur asynchronously.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::HybridInspectDlpJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.HybridInspectDlpJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::privacy::dlp::v2::HybridInspectResponse >`	the result of the RPC. The response message type (google.privacy.dlp.v2.HybridInspectResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

FinishDlpJob(google::privacy::dlp::v2::FinishDlpJobRequest const &, Options)

Finish a running hybrid DlpJob.

Triggers the finalization steps and running of any enabled actions that have not yet run.

Parameters
Name	Description
`request`	`google::privacy::dlp::v2::FinishDlpJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.privacy.dlp.v2.FinishDlpJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.