Documentation ¶
Overview ¶
Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.
Use of Context ¶
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
For information about setting deadlines, reusing contexts, and more please visit godoc.org/cloud.google.com/go.
Index ¶
- func DefaultAuthScopes() []string
- type CallOptions
- type Client
- func (c *Client) CancelDlpJob(ctx context.Context, req *dlppb.CancelDlpJobRequest, opts ...gax.CallOption) error
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConn
- func (c *Client) CreateDeidentifyTemplate(ctx context.Context, req *dlppb.CreateDeidentifyTemplateRequest, ...) (*dlppb.DeidentifyTemplate, error)
- func (c *Client) CreateDlpJob(ctx context.Context, req *dlppb.CreateDlpJobRequest, opts ...gax.CallOption) (*dlppb.DlpJob, error)
- func (c *Client) CreateInspectTemplate(ctx context.Context, req *dlppb.CreateInspectTemplateRequest, ...) (*dlppb.InspectTemplate, error)
- func (c *Client) CreateJobTrigger(ctx context.Context, req *dlppb.CreateJobTriggerRequest, ...) (*dlppb.JobTrigger, error)
- func (c *Client) CreateStoredInfoType(ctx context.Context, req *dlppb.CreateStoredInfoTypeRequest, ...) (*dlppb.StoredInfoType, error)
- func (c *Client) DeidentifyContent(ctx context.Context, req *dlppb.DeidentifyContentRequest, ...) (*dlppb.DeidentifyContentResponse, error)
- func (c *Client) DeleteDeidentifyTemplate(ctx context.Context, req *dlppb.DeleteDeidentifyTemplateRequest, ...) error
- func (c *Client) DeleteDlpJob(ctx context.Context, req *dlppb.DeleteDlpJobRequest, opts ...gax.CallOption) error
- func (c *Client) DeleteInspectTemplate(ctx context.Context, req *dlppb.DeleteInspectTemplateRequest, ...) error
- func (c *Client) DeleteJobTrigger(ctx context.Context, req *dlppb.DeleteJobTriggerRequest, ...) error
- func (c *Client) DeleteStoredInfoType(ctx context.Context, req *dlppb.DeleteStoredInfoTypeRequest, ...) error
- func (c *Client) GetDeidentifyTemplate(ctx context.Context, req *dlppb.GetDeidentifyTemplateRequest, ...) (*dlppb.DeidentifyTemplate, error)
- func (c *Client) GetDlpJob(ctx context.Context, req *dlppb.GetDlpJobRequest, opts ...gax.CallOption) (*dlppb.DlpJob, error)
- func (c *Client) GetInspectTemplate(ctx context.Context, req *dlppb.GetInspectTemplateRequest, ...) (*dlppb.InspectTemplate, error)
- func (c *Client) GetJobTrigger(ctx context.Context, req *dlppb.GetJobTriggerRequest, opts ...gax.CallOption) (*dlppb.JobTrigger, error)
- func (c *Client) GetStoredInfoType(ctx context.Context, req *dlppb.GetStoredInfoTypeRequest, ...) (*dlppb.StoredInfoType, error)
- func (c *Client) InspectContent(ctx context.Context, req *dlppb.InspectContentRequest, opts ...gax.CallOption) (*dlppb.InspectContentResponse, error)
- func (c *Client) ListDeidentifyTemplates(ctx context.Context, req *dlppb.ListDeidentifyTemplatesRequest, ...) *DeidentifyTemplateIterator
- func (c *Client) ListDlpJobs(ctx context.Context, req *dlppb.ListDlpJobsRequest, opts ...gax.CallOption) *DlpJobIterator
- func (c *Client) ListInfoTypes(ctx context.Context, req *dlppb.ListInfoTypesRequest, opts ...gax.CallOption) (*dlppb.ListInfoTypesResponse, error)
- func (c *Client) ListInspectTemplates(ctx context.Context, req *dlppb.ListInspectTemplatesRequest, ...) *InspectTemplateIterator
- func (c *Client) ListJobTriggers(ctx context.Context, req *dlppb.ListJobTriggersRequest, opts ...gax.CallOption) *JobTriggerIterator
- func (c *Client) ListStoredInfoTypes(ctx context.Context, req *dlppb.ListStoredInfoTypesRequest, ...) *StoredInfoTypeIterator
- func (c *Client) RedactImage(ctx context.Context, req *dlppb.RedactImageRequest, opts ...gax.CallOption) (*dlppb.RedactImageResponse, error)
- func (c *Client) ReidentifyContent(ctx context.Context, req *dlppb.ReidentifyContentRequest, ...) (*dlppb.ReidentifyContentResponse, error)
- func (c *Client) UpdateDeidentifyTemplate(ctx context.Context, req *dlppb.UpdateDeidentifyTemplateRequest, ...) (*dlppb.DeidentifyTemplate, error)
- func (c *Client) UpdateInspectTemplate(ctx context.Context, req *dlppb.UpdateInspectTemplateRequest, ...) (*dlppb.InspectTemplate, error)
- func (c *Client) UpdateJobTrigger(ctx context.Context, req *dlppb.UpdateJobTriggerRequest, ...) (*dlppb.JobTrigger, error)
- func (c *Client) UpdateStoredInfoType(ctx context.Context, req *dlppb.UpdateStoredInfoTypeRequest, ...) (*dlppb.StoredInfoType, error)
- type DeidentifyTemplateIterator
- type DlpJobIterator
- type InspectTemplateIterator
- type JobTriggerIterator
- type StoredInfoTypeIterator
Examples ¶
- Client.CancelDlpJob
- Client.CreateDeidentifyTemplate
- Client.CreateDlpJob
- Client.CreateInspectTemplate
- Client.CreateJobTrigger
- Client.CreateStoredInfoType
- Client.DeidentifyContent
- Client.DeleteDeidentifyTemplate
- Client.DeleteDlpJob
- Client.DeleteInspectTemplate
- Client.DeleteJobTrigger
- Client.DeleteStoredInfoType
- Client.GetDeidentifyTemplate
- Client.GetDlpJob
- Client.GetInspectTemplate
- Client.GetJobTrigger
- Client.GetStoredInfoType
- Client.InspectContent
- Client.ListDeidentifyTemplates
- Client.ListDlpJobs
- Client.ListInfoTypes
- Client.ListInspectTemplates
- Client.ListJobTriggers
- Client.ListStoredInfoTypes
- Client.RedactImage
- Client.ReidentifyContent
- Client.UpdateDeidentifyTemplate
- Client.UpdateInspectTemplate
- Client.UpdateJobTrigger
- Client.UpdateStoredInfoType
- NewClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type CallOptions ¶
type CallOptions struct { InspectContent []gax.CallOption RedactImage []gax.CallOption DeidentifyContent []gax.CallOption ReidentifyContent []gax.CallOption ListInfoTypes []gax.CallOption CreateInspectTemplate []gax.CallOption UpdateInspectTemplate []gax.CallOption GetInspectTemplate []gax.CallOption ListInspectTemplates []gax.CallOption DeleteInspectTemplate []gax.CallOption CreateDeidentifyTemplate []gax.CallOption UpdateDeidentifyTemplate []gax.CallOption GetDeidentifyTemplate []gax.CallOption ListDeidentifyTemplates []gax.CallOption DeleteDeidentifyTemplate []gax.CallOption CreateDlpJob []gax.CallOption ListDlpJobs []gax.CallOption GetDlpJob []gax.CallOption DeleteDlpJob []gax.CallOption CancelDlpJob []gax.CallOption ListJobTriggers []gax.CallOption GetJobTrigger []gax.CallOption DeleteJobTrigger []gax.CallOption UpdateJobTrigger []gax.CallOption CreateJobTrigger []gax.CallOption CreateStoredInfoType []gax.CallOption UpdateStoredInfoType []gax.CallOption GetStoredInfoType []gax.CallOption ListStoredInfoTypes []gax.CallOption DeleteStoredInfoType []gax.CallOption }
CallOptions contains the retry settings for each method of Client.
type Client ¶
type Client struct { // The call options for this service. CallOptions *CallOptions // contains filtered or unexported fields }
Client is a client for interacting with Cloud Data Loss Prevention (DLP) API.
Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
func NewClient ¶
NewClient creates a new dlp service client.
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/.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } // TODO: Use client. _ = c }
Output:
func (*Client) CancelDlpJob ¶
func (c *Client) CancelDlpJob(ctx context.Context, req *dlppb.CancelDlpJobRequest, opts ...gax.CallOption) error
CancelDlpJob 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.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.CancelDlpJobRequest{ // TODO: Fill request struct fields. } err = c.CancelDlpJob(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) Close ¶
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection ¶
func (c *Client) Connection() *grpc.ClientConn
Connection returns the client's connection to the API service.
func (*Client) CreateDeidentifyTemplate ¶
func (c *Client) CreateDeidentifyTemplate(ctx context.Context, req *dlppb.CreateDeidentifyTemplateRequest, opts ...gax.CallOption) (*dlppb.DeidentifyTemplate, error)
CreateDeidentifyTemplate creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.CreateDeidentifyTemplateRequest{ // TODO: Fill request struct fields. } resp, err := c.CreateDeidentifyTemplate(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateDlpJob ¶
func (c *Client) CreateDlpJob(ctx context.Context, req *dlppb.CreateDlpJobRequest, opts ...gax.CallOption) (*dlppb.DlpJob, error)
CreateDlpJob 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.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.CreateDlpJobRequest{ // TODO: Fill request struct fields. } resp, err := c.CreateDlpJob(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateInspectTemplate ¶
func (c *Client) CreateInspectTemplate(ctx context.Context, req *dlppb.CreateInspectTemplateRequest, opts ...gax.CallOption) (*dlppb.InspectTemplate, error)
CreateInspectTemplate creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.CreateInspectTemplateRequest{ // TODO: Fill request struct fields. } resp, err := c.CreateInspectTemplate(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateJobTrigger ¶
func (c *Client) CreateJobTrigger(ctx context.Context, req *dlppb.CreateJobTriggerRequest, opts ...gax.CallOption) (*dlppb.JobTrigger, error)
CreateJobTrigger 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.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.CreateJobTriggerRequest{ // TODO: Fill request struct fields. } resp, err := c.CreateJobTrigger(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateStoredInfoType ¶ added in v0.31.0
func (c *Client) CreateStoredInfoType(ctx context.Context, req *dlppb.CreateStoredInfoTypeRequest, opts ...gax.CallOption) (*dlppb.StoredInfoType, error)
CreateStoredInfoType creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.CreateStoredInfoTypeRequest{ // TODO: Fill request struct fields. } resp, err := c.CreateStoredInfoType(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) DeidentifyContent ¶
func (c *Client) DeidentifyContent(ctx context.Context, req *dlppb.DeidentifyContentRequest, opts ...gax.CallOption) (*dlppb.DeidentifyContentResponse, error)
DeidentifyContent 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.
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.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.DeidentifyContentRequest{ // TODO: Fill request struct fields. } resp, err := c.DeidentifyContent(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) DeleteDeidentifyTemplate ¶
func (c *Client) DeleteDeidentifyTemplate(ctx context.Context, req *dlppb.DeleteDeidentifyTemplateRequest, opts ...gax.CallOption) error
DeleteDeidentifyTemplate deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.DeleteDeidentifyTemplateRequest{ // TODO: Fill request struct fields. } err = c.DeleteDeidentifyTemplate(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteDlpJob ¶
func (c *Client) DeleteDlpJob(ctx context.Context, req *dlppb.DeleteDlpJobRequest, opts ...gax.CallOption) error
DeleteDlpJob deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be cancelled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.DeleteDlpJobRequest{ // TODO: Fill request struct fields. } err = c.DeleteDlpJob(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteInspectTemplate ¶
func (c *Client) DeleteInspectTemplate(ctx context.Context, req *dlppb.DeleteInspectTemplateRequest, opts ...gax.CallOption) error
DeleteInspectTemplate deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.DeleteInspectTemplateRequest{ // TODO: Fill request struct fields. } err = c.DeleteInspectTemplate(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteJobTrigger ¶
func (c *Client) DeleteJobTrigger(ctx context.Context, req *dlppb.DeleteJobTriggerRequest, opts ...gax.CallOption) error
DeleteJobTrigger deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.DeleteJobTriggerRequest{ // TODO: Fill request struct fields. } err = c.DeleteJobTrigger(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteStoredInfoType ¶ added in v0.31.0
func (c *Client) DeleteStoredInfoType(ctx context.Context, req *dlppb.DeleteStoredInfoTypeRequest, opts ...gax.CallOption) error
DeleteStoredInfoType deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.DeleteStoredInfoTypeRequest{ // TODO: Fill request struct fields. } err = c.DeleteStoredInfoType(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) GetDeidentifyTemplate ¶
func (c *Client) GetDeidentifyTemplate(ctx context.Context, req *dlppb.GetDeidentifyTemplateRequest, opts ...gax.CallOption) (*dlppb.DeidentifyTemplate, error)
GetDeidentifyTemplate gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.GetDeidentifyTemplateRequest{ // TODO: Fill request struct fields. } resp, err := c.GetDeidentifyTemplate(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetDlpJob ¶
func (c *Client) GetDlpJob(ctx context.Context, req *dlppb.GetDlpJobRequest, opts ...gax.CallOption) (*dlppb.DlpJob, error)
GetDlpJob 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.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.GetDlpJobRequest{ // TODO: Fill request struct fields. } resp, err := c.GetDlpJob(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetInspectTemplate ¶
func (c *Client) GetInspectTemplate(ctx context.Context, req *dlppb.GetInspectTemplateRequest, opts ...gax.CallOption) (*dlppb.InspectTemplate, error)
GetInspectTemplate gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.GetInspectTemplateRequest{ // TODO: Fill request struct fields. } resp, err := c.GetInspectTemplate(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetJobTrigger ¶
func (c *Client) GetJobTrigger(ctx context.Context, req *dlppb.GetJobTriggerRequest, opts ...gax.CallOption) (*dlppb.JobTrigger, error)
GetJobTrigger gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.GetJobTriggerRequest{ // TODO: Fill request struct fields. } resp, err := c.GetJobTrigger(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetStoredInfoType ¶ added in v0.31.0
func (c *Client) GetStoredInfoType(ctx context.Context, req *dlppb.GetStoredInfoTypeRequest, opts ...gax.CallOption) (*dlppb.StoredInfoType, error)
GetStoredInfoType gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.GetStoredInfoTypeRequest{ // TODO: Fill request struct fields. } resp, err := c.GetStoredInfoType(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) InspectContent ¶
func (c *Client) InspectContent(ctx context.Context, req *dlppb.InspectContentRequest, opts ...gax.CallOption) (*dlppb.InspectContentResponse, error)
InspectContent 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,
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.InspectContentRequest{ // TODO: Fill request struct fields. } resp, err := c.InspectContent(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ListDeidentifyTemplates ¶
func (c *Client) ListDeidentifyTemplates(ctx context.Context, req *dlppb.ListDeidentifyTemplatesRequest, opts ...gax.CallOption) *DeidentifyTemplateIterator
ListDeidentifyTemplates lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" "google.golang.org/api/iterator" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.ListDeidentifyTemplatesRequest{ // TODO: Fill request struct fields. } it := c.ListDeidentifyTemplates(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListDlpJobs ¶
func (c *Client) ListDlpJobs(ctx context.Context, req *dlppb.ListDlpJobsRequest, opts ...gax.CallOption) *DlpJobIterator
ListDlpJobs 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.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" "google.golang.org/api/iterator" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.ListDlpJobsRequest{ // TODO: Fill request struct fields. } it := c.ListDlpJobs(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListInfoTypes ¶
func (c *Client) ListInfoTypes(ctx context.Context, req *dlppb.ListInfoTypesRequest, opts ...gax.CallOption) (*dlppb.ListInfoTypesResponse, error)
ListInfoTypes returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.ListInfoTypesRequest{ // TODO: Fill request struct fields. } resp, err := c.ListInfoTypes(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ListInspectTemplates ¶
func (c *Client) ListInspectTemplates(ctx context.Context, req *dlppb.ListInspectTemplatesRequest, opts ...gax.CallOption) *InspectTemplateIterator
ListInspectTemplates lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" "google.golang.org/api/iterator" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.ListInspectTemplatesRequest{ // TODO: Fill request struct fields. } it := c.ListInspectTemplates(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListJobTriggers ¶
func (c *Client) ListJobTriggers(ctx context.Context, req *dlppb.ListJobTriggersRequest, opts ...gax.CallOption) *JobTriggerIterator
ListJobTriggers lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" "google.golang.org/api/iterator" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.ListJobTriggersRequest{ // TODO: Fill request struct fields. } it := c.ListJobTriggers(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListStoredInfoTypes ¶ added in v0.31.0
func (c *Client) ListStoredInfoTypes(ctx context.Context, req *dlppb.ListStoredInfoTypesRequest, opts ...gax.CallOption) *StoredInfoTypeIterator
ListStoredInfoTypes lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" "google.golang.org/api/iterator" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.ListStoredInfoTypesRequest{ // TODO: Fill request struct fields. } it := c.ListStoredInfoTypes(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) RedactImage ¶
func (c *Client) RedactImage(ctx context.Context, req *dlppb.RedactImageRequest, opts ...gax.CallOption) (*dlppb.RedactImageResponse, error)
RedactImage 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.
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.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.RedactImageRequest{ // TODO: Fill request struct fields. } resp, err := c.RedactImage(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ReidentifyContent ¶
func (c *Client) ReidentifyContent(ctx context.Context, req *dlppb.ReidentifyContentRequest, opts ...gax.CallOption) (*dlppb.ReidentifyContentResponse, error)
ReidentifyContent 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.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.ReidentifyContentRequest{ // TODO: Fill request struct fields. } resp, err := c.ReidentifyContent(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateDeidentifyTemplate ¶
func (c *Client) UpdateDeidentifyTemplate(ctx context.Context, req *dlppb.UpdateDeidentifyTemplateRequest, opts ...gax.CallOption) (*dlppb.DeidentifyTemplate, error)
UpdateDeidentifyTemplate updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.UpdateDeidentifyTemplateRequest{ // TODO: Fill request struct fields. } resp, err := c.UpdateDeidentifyTemplate(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateInspectTemplate ¶
func (c *Client) UpdateInspectTemplate(ctx context.Context, req *dlppb.UpdateInspectTemplateRequest, opts ...gax.CallOption) (*dlppb.InspectTemplate, error)
UpdateInspectTemplate updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.UpdateInspectTemplateRequest{ // TODO: Fill request struct fields. } resp, err := c.UpdateInspectTemplate(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateJobTrigger ¶
func (c *Client) UpdateJobTrigger(ctx context.Context, req *dlppb.UpdateJobTriggerRequest, opts ...gax.CallOption) (*dlppb.JobTrigger, error)
UpdateJobTrigger updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.UpdateJobTriggerRequest{ // TODO: Fill request struct fields. } resp, err := c.UpdateJobTrigger(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateStoredInfoType ¶ added in v0.31.0
func (c *Client) UpdateStoredInfoType(ctx context.Context, req *dlppb.UpdateStoredInfoTypeRequest, opts ...gax.CallOption) (*dlppb.StoredInfoType, error)
UpdateStoredInfoType 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.
Example ¶
package main import ( "context" dlp "cloud.google.com/go/dlp/apiv2" dlppb "google.golang.org/genproto/googleapis/privacy/dlp/v2" ) func main() { ctx := context.Background() c, err := dlp.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &dlppb.UpdateStoredInfoTypeRequest{ // TODO: Fill request struct fields. } resp, err := c.UpdateStoredInfoType(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
type DeidentifyTemplateIterator ¶
type DeidentifyTemplateIterator struct { // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dlppb.DeidentifyTemplate, nextPageToken string, err error) // contains filtered or unexported fields }
DeidentifyTemplateIterator manages a stream of *dlppb.DeidentifyTemplate.
func (*DeidentifyTemplateIterator) Next ¶
func (it *DeidentifyTemplateIterator) Next() (*dlppb.DeidentifyTemplate, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*DeidentifyTemplateIterator) PageInfo ¶
func (it *DeidentifyTemplateIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type DlpJobIterator ¶
type DlpJobIterator struct { // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dlppb.DlpJob, nextPageToken string, err error) // contains filtered or unexported fields }
DlpJobIterator manages a stream of *dlppb.DlpJob.
func (*DlpJobIterator) Next ¶
func (it *DlpJobIterator) Next() (*dlppb.DlpJob, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*DlpJobIterator) PageInfo ¶
func (it *DlpJobIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type InspectTemplateIterator ¶
type InspectTemplateIterator struct { // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dlppb.InspectTemplate, nextPageToken string, err error) // contains filtered or unexported fields }
InspectTemplateIterator manages a stream of *dlppb.InspectTemplate.
func (*InspectTemplateIterator) Next ¶
func (it *InspectTemplateIterator) Next() (*dlppb.InspectTemplate, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*InspectTemplateIterator) PageInfo ¶
func (it *InspectTemplateIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type JobTriggerIterator ¶
type JobTriggerIterator struct { // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dlppb.JobTrigger, nextPageToken string, err error) // contains filtered or unexported fields }
JobTriggerIterator manages a stream of *dlppb.JobTrigger.
func (*JobTriggerIterator) Next ¶
func (it *JobTriggerIterator) Next() (*dlppb.JobTrigger, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*JobTriggerIterator) PageInfo ¶
func (it *JobTriggerIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type StoredInfoTypeIterator ¶ added in v0.31.0
type StoredInfoTypeIterator struct { // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dlppb.StoredInfoType, nextPageToken string, err error) // contains filtered or unexported fields }
StoredInfoTypeIterator manages a stream of *dlppb.StoredInfoType.
func (*StoredInfoTypeIterator) Next ¶ added in v0.31.0
func (it *StoredInfoTypeIterator) Next() (*dlppb.StoredInfoType, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*StoredInfoTypeIterator) PageInfo ¶ added in v0.31.0
func (it *StoredInfoTypeIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.