dlp

Documentation

Overview

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

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

Index

• func DefaultAuthScopes() []string
• func ResultPath(result string) string
• type CallOptions
• type Client
  • func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Connection() *grpc.ClientConn
  • func (c *Client) CreateInspectOperation(ctx context.Context, req *dlppb.CreateInspectOperationRequest, ...) (*CreateInspectOperationHandle, error)
  • func (c *Client) CreateInspectOperationHandle(name string) *CreateInspectOperationHandle
  • func (c *Client) InspectContent(ctx context.Context, req *dlppb.InspectContentRequest, opts ...gax.CallOption) (*dlppb.InspectContentResponse, error)
  • func (c *Client) ListInfoTypes(ctx context.Context, req *dlppb.ListInfoTypesRequest, opts ...gax.CallOption) (*dlppb.ListInfoTypesResponse, error)
  • func (c *Client) ListInspectFindings(ctx context.Context, req *dlppb.ListInspectFindingsRequest, ...) (*dlppb.ListInspectFindingsResponse, error)
  • func (c *Client) ListRootCategories(ctx context.Context, req *dlppb.ListRootCategoriesRequest, ...) (*dlppb.ListRootCategoriesResponse, error)
  • func (c *Client) RedactContent(ctx context.Context, req *dlppb.RedactContentRequest, opts ...gax.CallOption) (*dlppb.RedactContentResponse, error)
• type CreateInspectOperationHandle
  • func (op *CreateInspectOperationHandle) Done() bool
  • func (op *CreateInspectOperationHandle) Metadata() (*dlppb.InspectOperationMetadata, error)
  • func (op *CreateInspectOperationHandle) Name() string
  • func (op *CreateInspectOperationHandle) Poll(ctx context.Context, opts ...gax.CallOption) (*dlppb.InspectOperationResult, error)
  • func (op *CreateInspectOperationHandle) Wait(ctx context.Context, opts ...gax.CallOption) (*dlppb.InspectOperationResult, error)

Examples

• Client.CreateInspectOperation
• Client.InspectContent
• Client.ListInfoTypes
• Client.ListInspectFindings
• Client.ListRootCategories
• Client.RedactContent
• NewClient

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 CallOptions

type CallOptions struct {
	InspectContent         []gax.CallOption
	RedactContent          []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

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

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

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

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

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

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

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.