Web Security Scanner API v1 - Package cloud.google.com/go/websecurityscanner/apiv1 (v1.1.0)
Package websecurityscanner is an auto-generated package for theWeb Security Scanner API.
Scans your Compute and App Engine apps for common web vulnerabilities.
Example usage
To get started with this package, create a client.
ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.CreateScanConfigRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#CreateScanConfigRequest.}resp,err:=c.CreateScanConfig(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp
Use of Context
The ctx passed to NewClient is used for authentication requests andfor 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 moreplease visithttps://pkg.go.dev/cloud.google.com/go.
Functions
func DefaultAuthScopes
funcDefaultAuthScopes()[]stringDefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
typeCallOptionsstruct{CreateScanConfig[]gax.CallOptionDeleteScanConfig[]gax.CallOptionGetScanConfig[]gax.CallOptionListScanConfigs[]gax.CallOptionUpdateScanConfig[]gax.CallOptionStartScanRun[]gax.CallOptionGetScanRun[]gax.CallOptionListScanRuns[]gax.CallOptionStopScanRun[]gax.CallOptionListCrawledUrls[]gax.CallOptionGetFinding[]gax.CallOptionListFindings[]gax.CallOptionListFindingTypeStats[]gax.CallOption}CallOptions contains the retry settings for each method of Client.
Client
typeClientstruct{// 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.
Web Security Scanner Service identifies security vulnerabilities in webapplications hosted on Google Cloud. It crawls your application, andattempts to exercise as many user inputs and event handlers as possible.
func NewClient
NewClient creates a new web security scanner client based on gRPC.The returned client must be Closed when it is done being used to clean up its underlying connections.
Web Security Scanner Service identifies security vulnerabilities in webapplications hosted on Google Cloud. It crawls your application, andattempts to exercise as many user inputs and event handlers as possible.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}func (*Client) Close
Close closes the connection to the API service. The user should invoke this whenthe client is no longer required.
func (*Client) Connection
func(c*Client)Connection()*grpc.ClientConnConnection returns a connection to the API service.
Deprecated.
func (*Client) CreateScanConfig
func(c*Client)CreateScanConfig(ctxcontext.Context,req*websecurityscannerpb.CreateScanConfigRequest,opts...gax.CallOption)(*websecurityscannerpb.ScanConfig,error)CreateScanConfig creates a new ScanConfig.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.CreateScanConfigRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#CreateScanConfigRequest.}resp,err:=c.CreateScanConfig(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) DeleteScanConfig
func(c*Client)DeleteScanConfig(ctxcontext.Context,req*websecurityscannerpb.DeleteScanConfigRequest,opts...gax.CallOption)errorDeleteScanConfig deletes an existing ScanConfig and its child resources.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.DeleteScanConfigRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#DeleteScanConfigRequest.}err=c.DeleteScanConfig(ctx,req)iferr!=nil{// TODO: Handle error.}}func (*Client) GetFinding
func(c*Client)GetFinding(ctxcontext.Context,req*websecurityscannerpb.GetFindingRequest,opts...gax.CallOption)(*websecurityscannerpb.Finding,error)GetFinding gets a Finding.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.GetFindingRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#GetFindingRequest.}resp,err:=c.GetFinding(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetScanConfig
func(c*Client)GetScanConfig(ctxcontext.Context,req*websecurityscannerpb.GetScanConfigRequest,opts...gax.CallOption)(*websecurityscannerpb.ScanConfig,error)GetScanConfig gets a ScanConfig.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.GetScanConfigRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#GetScanConfigRequest.}resp,err:=c.GetScanConfig(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetScanRun
func(c*Client)GetScanRun(ctxcontext.Context,req*websecurityscannerpb.GetScanRunRequest,opts...gax.CallOption)(*websecurityscannerpb.ScanRun,error)GetScanRun gets a ScanRun.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.GetScanRunRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#GetScanRunRequest.}resp,err:=c.GetScanRun(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) ListCrawledUrls
func(c*Client)ListCrawledUrls(ctxcontext.Context,req*websecurityscannerpb.ListCrawledUrlsRequest,opts...gax.CallOption)*CrawledUrlIteratorListCrawledUrls list CrawledUrls under a given ScanRun.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1""google.golang.org/api/iterator"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.ListCrawledUrlsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#ListCrawledUrlsRequest.}it:=c.ListCrawledUrls(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}}func (*Client) ListFindingTypeStats
func(c*Client)ListFindingTypeStats(ctxcontext.Context,req*websecurityscannerpb.ListFindingTypeStatsRequest,opts...gax.CallOption)(*websecurityscannerpb.ListFindingTypeStatsResponse,error)ListFindingTypeStats list all FindingTypeStats under a given ScanRun.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.ListFindingTypeStatsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#ListFindingTypeStatsRequest.}resp,err:=c.ListFindingTypeStats(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) ListFindings
func(c*Client)ListFindings(ctxcontext.Context,req*websecurityscannerpb.ListFindingsRequest,opts...gax.CallOption)*FindingIteratorListFindings list Findings under a given ScanRun.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1""google.golang.org/api/iterator"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.ListFindingsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#ListFindingsRequest.}it:=c.ListFindings(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}}func (*Client) ListScanConfigs
func(c*Client)ListScanConfigs(ctxcontext.Context,req*websecurityscannerpb.ListScanConfigsRequest,opts...gax.CallOption)*ScanConfigIteratorListScanConfigs lists ScanConfigs under a given project.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1""google.golang.org/api/iterator"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.ListScanConfigsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#ListScanConfigsRequest.}it:=c.ListScanConfigs(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}}func (*Client) ListScanRuns
func(c*Client)ListScanRuns(ctxcontext.Context,req*websecurityscannerpb.ListScanRunsRequest,opts...gax.CallOption)*ScanRunIteratorListScanRuns lists ScanRuns under a given ScanConfig, in descending order of ScanRunstop time.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1""google.golang.org/api/iterator"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.ListScanRunsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#ListScanRunsRequest.}it:=c.ListScanRuns(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}}func (*Client) StartScanRun
func(c*Client)StartScanRun(ctxcontext.Context,req*websecurityscannerpb.StartScanRunRequest,opts...gax.CallOption)(*websecurityscannerpb.ScanRun,error)StartScanRun start a ScanRun according to the given ScanConfig.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.StartScanRunRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#StartScanRunRequest.}resp,err:=c.StartScanRun(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) StopScanRun
func(c*Client)StopScanRun(ctxcontext.Context,req*websecurityscannerpb.StopScanRunRequest,opts...gax.CallOption)(*websecurityscannerpb.ScanRun,error)StopScanRun stops a ScanRun. The stopped ScanRun is returned.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.StopScanRunRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#StopScanRunRequest.}resp,err:=c.StopScanRun(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) UpdateScanConfig
func(c*Client)UpdateScanConfig(ctxcontext.Context,req*websecurityscannerpb.UpdateScanConfigRequest,opts...gax.CallOption)(*websecurityscannerpb.ScanConfig,error)UpdateScanConfig updates a ScanConfig. This method support partial update of a ScanConfig.
Example
packagemainimport("context"websecurityscanner"cloud.google.com/go/websecurityscanner/apiv1"websecurityscannerpb"google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1")funcmain(){ctx:=context.Background()c,err:=websecurityscanner.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&websecurityscannerpb.UpdateScanConfigRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1#UpdateScanConfigRequest.}resp,err:=c.UpdateScanConfig(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}CrawledUrlIterator
typeCrawledUrlIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*websecurityscannerpb.CrawledUrl,nextPageTokenstring,errerror)// contains filtered or unexported fields}CrawledUrlIterator manages a stream of *websecurityscannerpb.CrawledUrl.
func (*CrawledUrlIterator) Next
func(it*CrawledUrlIterator)Next()(*websecurityscannerpb.CrawledUrl,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*CrawledUrlIterator) PageInfo
func(it*CrawledUrlIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the google.golang.org/api/iterator package for details.
FindingIterator
typeFindingIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*websecurityscannerpb.Finding,nextPageTokenstring,errerror)// contains filtered or unexported fields}FindingIterator manages a stream of *websecurityscannerpb.Finding.
func (*FindingIterator) Next
func(it*FindingIterator)Next()(*websecurityscannerpb.Finding,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*FindingIterator) PageInfo
func(it*FindingIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ScanConfigIterator
typeScanConfigIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*websecurityscannerpb.ScanConfig,nextPageTokenstring,errerror)// contains filtered or unexported fields}ScanConfigIterator manages a stream of *websecurityscannerpb.ScanConfig.
func (*ScanConfigIterator) Next
func(it*ScanConfigIterator)Next()(*websecurityscannerpb.ScanConfig,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*ScanConfigIterator) PageInfo
func(it*ScanConfigIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ScanRunIterator
typeScanRunIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*websecurityscannerpb.ScanRun,nextPageTokenstring,errerror)// contains filtered or unexported fields}ScanRunIterator manages a stream of *websecurityscannerpb.ScanRun.
func (*ScanRunIterator) Next
func(it*ScanRunIterator)Next()(*websecurityscannerpb.ScanRun,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*ScanRunIterator) PageInfo
func(it*ScanRunIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the google.golang.org/api/iterator package for details.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.