webrisk

Documentation

Overview

Package webrisk is an auto-generated package for the Web Risk API.

NOTE: This package is in beta. It is not stable, and may be subject to changes.

General documentation

For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:

• Authentication and Authorization
• Timeouts and Cancellation
• Testing against Client Libraries
• Debugging Client Libraries
• Inspecting errors

Example usage

To get started with this package, create a client.

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := webrisk.NewWebRiskServiceV1Beta1Client(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client.

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := webrisk.NewWebRiskServiceV1Beta1Client(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

req := &webriskpb.ComputeThreatListDiffRequest{
	// TODO: Fill request struct fields.
	// See https://pkg.go.dev/cloud.google.com/go/webrisk/apiv1beta1/webriskpb#ComputeThreatListDiffRequest.
}
resp, err := c.ComputeThreatListDiff(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewWebRiskServiceV1Beta1Client 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.

Index

• func DefaultAuthScopes() []string
• type WebRiskServiceV1Beta1CallOptions
• type WebRiskServiceV1Beta1Client
  • func NewWebRiskServiceV1Beta1Client(ctx context.Context, opts ...option.ClientOption) (*WebRiskServiceV1Beta1Client, error)
  • func NewWebRiskServiceV1Beta1RESTClient(ctx context.Context, opts ...option.ClientOption) (*WebRiskServiceV1Beta1Client, error)
  • func (c *WebRiskServiceV1Beta1Client) Close() error
  • func (c *WebRiskServiceV1Beta1Client) ComputeThreatListDiff(ctx context.Context, req *webriskpb.ComputeThreatListDiffRequest, ...) (*webriskpb.ComputeThreatListDiffResponse, error)
  • func (c *WebRiskServiceV1Beta1Client) Connection() *grpc.ClientConn
  • func (c *WebRiskServiceV1Beta1Client) SearchHashes(ctx context.Context, req *webriskpb.SearchHashesRequest, ...) (*webriskpb.SearchHashesResponse, error)
  • func (c *WebRiskServiceV1Beta1Client) SearchUris(ctx context.Context, req *webriskpb.SearchUrisRequest, opts ...gax.CallOption) (*webriskpb.SearchUrisResponse, error)

Examples

• NewWebRiskServiceV1Beta1Client
• NewWebRiskServiceV1Beta1RESTClient
• WebRiskServiceV1Beta1Client.ComputeThreatListDiff
• WebRiskServiceV1Beta1Client.SearchHashes
• WebRiskServiceV1Beta1Client.SearchUris

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

Types

type WebRiskServiceV1Beta1CallOptions

type WebRiskServiceV1Beta1CallOptions struct {
	ComputeThreatListDiff []gax.CallOption
	SearchUris            []gax.CallOption
	SearchHashes          []gax.CallOption
}

WebRiskServiceV1Beta1CallOptions contains the retry settings for each method of WebRiskServiceV1Beta1Client.

type WebRiskServiceV1Beta1Client

type WebRiskServiceV1Beta1Client struct {

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

WebRiskServiceV1Beta1Client is a client for interacting with Web Risk API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Web Risk v1beta1 API defines an interface to detect malicious URLs on your website and in client applications.

func NewWebRiskServiceV1Beta1Client

func NewWebRiskServiceV1Beta1Client(ctx context.Context, opts ...option.ClientOption) (*WebRiskServiceV1Beta1Client, error)

NewWebRiskServiceV1Beta1Client creates a new web risk service v1 beta1 client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Web Risk v1beta1 API defines an interface to detect malicious URLs on your website and in client applications.

Example

package main

import (
	"context"

	webrisk "cloud.google.com/go/webrisk/apiv1beta1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := webrisk.NewWebRiskServiceV1Beta1Client(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewWebRiskServiceV1Beta1RESTClient

func NewWebRiskServiceV1Beta1RESTClient(ctx context.Context, opts ...option.ClientOption) (*WebRiskServiceV1Beta1Client, error)

NewWebRiskServiceV1Beta1RESTClient creates a new web risk service v1 beta1 rest client.

Web Risk v1beta1 API defines an interface to detect malicious URLs on your website and in client applications.

Example

package main

import (
	"context"

	webrisk "cloud.google.com/go/webrisk/apiv1beta1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := webrisk.NewWebRiskServiceV1Beta1RESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*WebRiskServiceV1Beta1Client) Close

func (c *WebRiskServiceV1Beta1Client) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*WebRiskServiceV1Beta1Client) ComputeThreatListDiff

func (c *WebRiskServiceV1Beta1Client) ComputeThreatListDiff(ctx context.Context, req *webriskpb.ComputeThreatListDiffRequest, opts ...gax.CallOption) (*webriskpb.ComputeThreatListDiffResponse, error)

ComputeThreatListDiff gets the most recent threat list diffs.

Example

package main

import (
	"context"

	webrisk "cloud.google.com/go/webrisk/apiv1beta1"
	webriskpb "cloud.google.com/go/webrisk/apiv1beta1/webriskpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := webrisk.NewWebRiskServiceV1Beta1Client(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &webriskpb.ComputeThreatListDiffRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/webrisk/apiv1beta1/webriskpb#ComputeThreatListDiffRequest.
	}
	resp, err := c.ComputeThreatListDiff(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*WebRiskServiceV1Beta1Client) Connection

func (c *WebRiskServiceV1Beta1Client) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not always return the same resource.

func (*WebRiskServiceV1Beta1Client) SearchHashes

func (c *WebRiskServiceV1Beta1Client) SearchHashes(ctx context.Context, req *webriskpb.SearchHashesRequest, opts ...gax.CallOption) (*webriskpb.SearchHashesResponse, error)

SearchHashes gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.

Example

package main

import (
	"context"

	webrisk "cloud.google.com/go/webrisk/apiv1beta1"
	webriskpb "cloud.google.com/go/webrisk/apiv1beta1/webriskpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := webrisk.NewWebRiskServiceV1Beta1Client(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &webriskpb.SearchHashesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/webrisk/apiv1beta1/webriskpb#SearchHashesRequest.
	}
	resp, err := c.SearchHashes(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*WebRiskServiceV1Beta1Client) SearchUris

func (c *WebRiskServiceV1Beta1Client) SearchUris(ctx context.Context, req *webriskpb.SearchUrisRequest, opts ...gax.CallOption) (*webriskpb.SearchUrisResponse, error)

SearchUris this method is used to check whether a URI is on a given threatList.

Example

package main

import (
	"context"

	webrisk "cloud.google.com/go/webrisk/apiv1beta1"
	webriskpb "cloud.google.com/go/webrisk/apiv1beta1/webriskpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := webrisk.NewWebRiskServiceV1Beta1Client(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &webriskpb.SearchUrisRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/webrisk/apiv1beta1/webriskpb#SearchUrisRequest.
	}
	resp, err := c.SearchUris(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}