dlp

package
v0.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 11, 2017 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package dlp is an auto-generated package for the DLP API. 

NOTE: This package is in alpha. It is not stable, and is likely to change.

The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.

Index

Examples

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.

func ResultPath 

func ResultPath(result string) string

ResultPath returns the path for the result resource.

Types

type AnalyzeDataSourceRiskOperation added in v0.16.0 

type AnalyzeDataSourceRiskOperation struct {
	// contains filtered or unexported fields
}

AnalyzeDataSourceRiskOperation manages a long-running operation from AnalyzeDataSourceRisk.

func (*AnalyzeDataSourceRiskOperation) Done added in v0.16.0 

func (op *AnalyzeDataSourceRiskOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*AnalyzeDataSourceRiskOperation) Metadata added in v0.16.0 

func (op *AnalyzeDataSourceRiskOperation) Metadata() (*dlppb.RiskAnalysisOperationMetadata, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*AnalyzeDataSourceRiskOperation) Name added in v0.16.0 

func (op *AnalyzeDataSourceRiskOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*AnalyzeDataSourceRiskOperation) Poll added in v0.16.0 

func (op *AnalyzeDataSourceRiskOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dlppb.RiskAnalysisOperationResult, error)

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*AnalyzeDataSourceRiskOperation) Wait added in v0.16.0 

func (op *AnalyzeDataSourceRiskOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dlppb.RiskAnalysisOperationResult, error)

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type CallOptions 

type CallOptions struct {
	InspectContent         []gax.CallOption
	RedactContent          []gax.CallOption
	DeidentifyContent      []gax.CallOption
	AnalyzeDataSourceRisk  []gax.CallOption
	CreateInspectOperation []gax.CallOption
	ListInspectFindings    []gax.CallOption
	ListInfoTypes          []gax.CallOption
	ListRootCategories     []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

type Client 

type Client struct {

	// LROClient is used internally to handle longrunning operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient

	// The call options for this service.
	CallOptions *CallOptions
	// contains filtered or unexported fields
}

Client is a client for interacting with DLP API.

func NewClient 

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new dlp service client.

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

Example 
ctx := context.Background()
c, err := dlp.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use client.
_ = c

Output:

func (*Client) AnalyzeDataSourceRisk added in v0.16.0 

func (c *Client) AnalyzeDataSourceRisk(ctx context.Context, req *dlppb.AnalyzeDataSourceRiskRequest, opts ...gax.CallOption) (*AnalyzeDataSourceRiskOperation, error)

AnalyzeDataSourceRisk schedules a job to compute risk analysis metrics over content in a Google Cloud Platform repository.

Example 
ctx := context.Background()
c, err := dlp.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &dlppb.AnalyzeDataSourceRiskRequest{
	// TODO: Fill request struct fields.
}
op, err := c.AnalyzeDataSourceRisk(ctx, req)
if err != nil {
	// TODO: Handle error.
}

resp, err := op.Wait(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Output:

func (*Client) AnalyzeDataSourceRiskOperation added in v0.16.0 

func (c *Client) AnalyzeDataSourceRiskOperation(name string) *AnalyzeDataSourceRiskOperation

AnalyzeDataSourceRiskOperation returns a new AnalyzeDataSourceRiskOperation from a given name. The name must be that of a previously created AnalyzeDataSourceRiskOperation, possibly from a different process.

func (*Client) Close 

func (c *Client) Close() error

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) CreateInspectOperation 

func (c *Client) CreateInspectOperation(ctx context.Context, req *dlppb.CreateInspectOperationRequest, opts ...gax.CallOption) (*CreateInspectOperationHandle, error)

CreateInspectOperation schedules a job scanning content in a Google Cloud Platform data repository.

Example 
ctx := context.Background()
c, err := dlp.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &dlppb.CreateInspectOperationRequest{
	// TODO: Fill request struct fields.
}
op, err := c.CreateInspectOperation(ctx, req)
if err != nil {
	// TODO: Handle error.
}

resp, err := op.Wait(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Output:

func (*Client) CreateInspectOperationHandle 

func (c *Client) CreateInspectOperationHandle(name string) *CreateInspectOperationHandle

CreateInspectOperationHandle returns a new CreateInspectOperationHandle from a given name. The name must be that of a previously created CreateInspectOperationHandle, possibly from a different process.

func (*Client) DeidentifyContent added in v0.16.0 

func (c *Client) DeidentifyContent(ctx context.Context, req *dlppb.DeidentifyContentRequest, opts ...gax.CallOption) (*dlppb.DeidentifyContentResponse, error)

DeidentifyContent de-identifies potentially sensitive info from a list of strings. This method has limits on input size and output size.

Example 
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) InspectContent 

func (c *Client) InspectContent(ctx context.Context, req *dlppb.InspectContentRequest, opts ...gax.CallOption) (*dlppb.InspectContentResponse, error)

InspectContent finds potentially sensitive info in a list of strings. This method has limits on input size, processing time, and output size.

Example 
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) ListInfoTypes 

func (c *Client) ListInfoTypes(ctx context.Context, req *dlppb.ListInfoTypesRequest, opts ...gax.CallOption) (*dlppb.ListInfoTypesResponse, error)

ListInfoTypes returns sensitive information types for given category.

Example 
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) ListInspectFindings 

func (c *Client) ListInspectFindings(ctx context.Context, req *dlppb.ListInspectFindingsRequest, opts ...gax.CallOption) (*dlppb.ListInspectFindingsResponse, error)

ListInspectFindings returns list of results for given inspect operation result set id.

Example 
ctx := context.Background()
c, err := dlp.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &dlppb.ListInspectFindingsRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.ListInspectFindings(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Output:

func (*Client) ListRootCategories 

func (c *Client) ListRootCategories(ctx context.Context, req *dlppb.ListRootCategoriesRequest, opts ...gax.CallOption) (*dlppb.ListRootCategoriesResponse, error)

ListRootCategories returns the list of root categories of sensitive information.

Example 
ctx := context.Background()
c, err := dlp.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &dlppb.ListRootCategoriesRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.ListRootCategories(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Output:

func (*Client) RedactContent 

func (c *Client) RedactContent(ctx context.Context, req *dlppb.RedactContentRequest, opts ...gax.CallOption) (*dlppb.RedactContentResponse, error)

RedactContent redacts potentially sensitive info from a list of strings. This method has limits on input size, processing time, and output size.

Example 
ctx := context.Background()
c, err := dlp.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &dlppb.RedactContentRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.RedactContent(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Output:

type CreateInspectOperationHandle 

type CreateInspectOperationHandle struct {
	// contains filtered or unexported fields
}

CreateInspectOperationHandle manages a long-running operation from CreateInspectOperation.

func (*CreateInspectOperationHandle) Done 

func (op *CreateInspectOperationHandle) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateInspectOperationHandle) Metadata 

func (op *CreateInspectOperationHandle) Metadata() (*dlppb.InspectOperationMetadata, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateInspectOperationHandle) Name 

func (op *CreateInspectOperationHandle) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateInspectOperationHandle) Poll 

func (op *CreateInspectOperationHandle) Poll(ctx context.Context, opts ...gax.CallOption) (*dlppb.InspectOperationResult, error)

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateInspectOperationHandle) Wait 

func (op *CreateInspectOperationHandle) Wait(ctx context.Context, opts ...gax.CallOption) (*dlppb.InspectOperationResult, error)

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.