phishingprotection

Documentation

Overview

Package phishingprotection is an auto-generated package for the Phishing Protection API.

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

General documentation

For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.

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 := phishingprotection.NewPhishingProtectionServiceV1Beta1Client(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 := phishingprotection.NewPhishingProtectionServiceV1Beta1Client(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

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

Use of Context

The ctx passed to NewPhishingProtectionServiceV1Beta1Client 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 PhishingProtectionServiceV1Beta1CallOptions
• type PhishingProtectionServiceV1Beta1Client
  • func NewPhishingProtectionServiceV1Beta1Client(ctx context.Context, opts ...option.ClientOption) (*PhishingProtectionServiceV1Beta1Client, error)
  • func NewPhishingProtectionServiceV1Beta1RESTClient(ctx context.Context, opts ...option.ClientOption) (*PhishingProtectionServiceV1Beta1Client, error)
  • func (c *PhishingProtectionServiceV1Beta1Client) Close() error
  • func (c *PhishingProtectionServiceV1Beta1Client) Connection() *grpc.ClientConn
  • func (c *PhishingProtectionServiceV1Beta1Client) ReportPhishing(ctx context.Context, req *phishingprotectionpb.ReportPhishingRequest, ...) (*phishingprotectionpb.ReportPhishingResponse, error)

Examples

• NewPhishingProtectionServiceV1Beta1Client
• NewPhishingProtectionServiceV1Beta1RESTClient
• PhishingProtectionServiceV1Beta1Client.ReportPhishing

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

Types

type PhishingProtectionServiceV1Beta1CallOptions

type PhishingProtectionServiceV1Beta1CallOptions struct {
	ReportPhishing []gax.CallOption
}

PhishingProtectionServiceV1Beta1CallOptions contains the retry settings for each method of PhishingProtectionServiceV1Beta1Client.

type PhishingProtectionServiceV1Beta1Client

type PhishingProtectionServiceV1Beta1Client struct {

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

PhishingProtectionServiceV1Beta1Client is a client for interacting with Phishing Protection API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service to report phishing URIs.

func NewPhishingProtectionServiceV1Beta1Client

func NewPhishingProtectionServiceV1Beta1Client(ctx context.Context, opts ...option.ClientOption) (*PhishingProtectionServiceV1Beta1Client, error)

NewPhishingProtectionServiceV1Beta1Client creates a new phishing protection 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.

Service to report phishing URIs.

Example

package main

import (
	"context"

	phishingprotection "cloud.google.com/go/phishingprotection/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 := phishingprotection.NewPhishingProtectionServiceV1Beta1Client(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewPhishingProtectionServiceV1Beta1RESTClient

func NewPhishingProtectionServiceV1Beta1RESTClient(ctx context.Context, opts ...option.ClientOption) (*PhishingProtectionServiceV1Beta1Client, error)

NewPhishingProtectionServiceV1Beta1RESTClient creates a new phishing protection service v1 beta1 rest client.

Service to report phishing URIs.

Example

package main

import (
	"context"

	phishingprotection "cloud.google.com/go/phishingprotection/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 := phishingprotection.NewPhishingProtectionServiceV1Beta1RESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*PhishingProtectionServiceV1Beta1Client) Close

func (c *PhishingProtectionServiceV1Beta1Client) Close() error

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

func (*PhishingProtectionServiceV1Beta1Client) Connection

func (c *PhishingProtectionServiceV1Beta1Client) 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 (*PhishingProtectionServiceV1Beta1Client) ReportPhishing

func (c *PhishingProtectionServiceV1Beta1Client) ReportPhishing(ctx context.Context, req *phishingprotectionpb.ReportPhishingRequest, opts ...gax.CallOption) (*phishingprotectionpb.ReportPhishingResponse, error)

ReportPhishing reports a URI suspected of containing phishing content to be reviewed. Once the report review is complete, its result can be found in the Cloud Security Command Center findings dashboard for Phishing Protection. If the result verifies the existence of malicious phishing content, the site will be added the to Google’s Social Engineering lists (at https://support.google.com/webmasters/answer/6350487/) in order to protect users that could get exposed to this threat in the future.

Example

package main

import (
	"context"

	phishingprotection "cloud.google.com/go/phishingprotection/apiv1beta1"
	phishingprotectionpb "cloud.google.com/go/phishingprotection/apiv1beta1/phishingprotectionpb"
)

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 := phishingprotection.NewPhishingProtectionServiceV1Beta1Client(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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