Documentation

Overview

Package websecurityscanner is an auto-generated package for the Web Security Scanner API.

Scans your Compute and App Engine apps for common web vulnerabilities.

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 pkg.go.dev/cloud.google.com/go.

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.

    Types

    type CallOptions

    type CallOptions struct {
    	CreateScanConfig     []gax.CallOption
    	DeleteScanConfig     []gax.CallOption
    	GetScanConfig        []gax.CallOption
    	ListScanConfigs      []gax.CallOption
    	UpdateScanConfig     []gax.CallOption
    	StartScanRun         []gax.CallOption
    	GetScanRun           []gax.CallOption
    	ListScanRuns         []gax.CallOption
    	StopScanRun          []gax.CallOption
    	ListCrawledUrls      []gax.CallOption
    	GetFinding           []gax.CallOption
    	ListFindings         []gax.CallOption
    	ListFindingTypeStats []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 Web Security Scanner API.

        Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

        func NewClient

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

          NewClient creates a new web security scanner client.

          Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.

          Example
          Output:
          
          

          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 a connection to the API service.

              Deprecated.

              func (*Client) CreateScanConfig

                CreateScanConfig creates a new ScanConfig.

                Example
                Output:
                
                

                func (*Client) DeleteScanConfig

                func (c *Client) DeleteScanConfig(ctx context.Context, req *websecurityscannerpb.DeleteScanConfigRequest, opts ...gax.CallOption) error

                  DeleteScanConfig deletes an existing ScanConfig and its child resources.

                  Example
                  Output:
                  
                  

                  func (*Client) GetFinding

                    GetFinding gets a Finding.

                    Example
                    Output:
                    
                    

                    func (*Client) GetScanConfig

                      GetScanConfig gets a ScanConfig.

                      Example
                      Output:
                      
                      

                      func (*Client) GetScanRun

                        GetScanRun gets a ScanRun.

                        Example
                        Output:
                        
                        

                        func (*Client) ListCrawledUrls

                          ListCrawledUrls list CrawledUrls under a given ScanRun.

                          Example
                          Output:
                          
                          

                          func (*Client) ListFindingTypeStats

                            ListFindingTypeStats list all FindingTypeStats under a given ScanRun.

                            Example
                            Output:
                            
                            

                            func (*Client) ListFindings

                              ListFindings list Findings under a given ScanRun.

                              Example
                              Output:
                              
                              

                              func (*Client) ListScanConfigs

                                ListScanConfigs lists ScanConfigs under a given project.

                                Example
                                Output:
                                
                                

                                func (*Client) ListScanRuns

                                  ListScanRuns lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.

                                  Example
                                  Output:
                                  
                                  

                                  func (*Client) StartScanRun

                                    StartScanRun start a ScanRun according to the given ScanConfig.

                                    Example
                                    Output:
                                    
                                    

                                    func (*Client) StopScanRun

                                      StopScanRun stops a ScanRun. The stopped ScanRun is returned.

                                      Example
                                      Output:
                                      
                                      

                                      func (*Client) UpdateScanConfig

                                        UpdateScanConfig updates a ScanConfig. This method support partial update of a ScanConfig.

                                        Example
                                        Output:
                                        
                                        

                                        type CrawledUrlIterator

                                        type CrawledUrlIterator struct {
                                        
                                        	// Response is the raw response for the current page.
                                        	// It must be cast to the RPC response type.
                                        	// Calling Next() or InternalFetch() updates this value.
                                        	Response interface{}
                                        
                                        	// 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 []*websecurityscannerpb.CrawledUrl, nextPageToken string, err error)
                                        	// contains filtered or unexported fields
                                        }

                                          CrawledUrlIterator manages a stream of *websecurityscannerpb.CrawledUrl.

                                          func (*CrawledUrlIterator) Next

                                            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 (*CrawledUrlIterator) PageInfo

                                            func (it *CrawledUrlIterator) PageInfo() *iterator.PageInfo

                                              PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

                                              type FindingIterator

                                              type FindingIterator struct {
                                              
                                              	// Response is the raw response for the current page.
                                              	// It must be cast to the RPC response type.
                                              	// Calling Next() or InternalFetch() updates this value.
                                              	Response interface{}
                                              
                                              	// 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 []*websecurityscannerpb.Finding, nextPageToken string, err error)
                                              	// contains filtered or unexported fields
                                              }

                                                FindingIterator manages a stream of *websecurityscannerpb.Finding.

                                                func (*FindingIterator) Next

                                                  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 (*FindingIterator) PageInfo

                                                  func (it *FindingIterator) PageInfo() *iterator.PageInfo

                                                    PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

                                                    type ScanConfigIterator

                                                    type ScanConfigIterator struct {
                                                    
                                                    	// Response is the raw response for the current page.
                                                    	// It must be cast to the RPC response type.
                                                    	// Calling Next() or InternalFetch() updates this value.
                                                    	Response interface{}
                                                    
                                                    	// 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 []*websecurityscannerpb.ScanConfig, nextPageToken string, err error)
                                                    	// contains filtered or unexported fields
                                                    }

                                                      ScanConfigIterator manages a stream of *websecurityscannerpb.ScanConfig.

                                                      func (*ScanConfigIterator) Next

                                                        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 (*ScanConfigIterator) PageInfo

                                                        func (it *ScanConfigIterator) PageInfo() *iterator.PageInfo

                                                          PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

                                                          type ScanRunIterator

                                                          type ScanRunIterator struct {
                                                          
                                                          	// Response is the raw response for the current page.
                                                          	// It must be cast to the RPC response type.
                                                          	// Calling Next() or InternalFetch() updates this value.
                                                          	Response interface{}
                                                          
                                                          	// 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 []*websecurityscannerpb.ScanRun, nextPageToken string, err error)
                                                          	// contains filtered or unexported fields
                                                          }

                                                            ScanRunIterator manages a stream of *websecurityscannerpb.ScanRun.

                                                            func (*ScanRunIterator) Next

                                                              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 (*ScanRunIterator) PageInfo

                                                              func (it *ScanRunIterator) PageInfo() *iterator.PageInfo

                                                                PageInfo supports pagination. See the google.golang.org/api/iterator package for details.