Class WebSecurityScannerClient (2.16.0)

Version 2.16.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

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.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

WebSecurityScannerClient(WebSecurityScannerClient const &)

Copy and move support

Parameter
Name	Description
	WebSecurityScannerClient const &

WebSecurityScannerClient(WebSecurityScannerClient &&)

Copy and move support

Parameter
Name	Description
	WebSecurityScannerClient &&

WebSecurityScannerClient(std::shared_ptr< WebSecurityScannerConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< WebSecurityScannerConnection >
opts	Options

Operators

operator=(WebSecurityScannerClient const &)

Copy and move support

Parameter
Name	Description
	WebSecurityScannerClient const &

Returns
Type	Description
WebSecurityScannerClient &

operator=(WebSecurityScannerClient &&)

Copy and move support

Parameter
Name	Description
	WebSecurityScannerClient &&

Returns
Type	Description
WebSecurityScannerClient &

Functions

CreateScanConfig(google::cloud::websecurityscanner::v1::CreateScanConfigRequest const &, Options)

Creates a new ScanConfig.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::CreateScanConfigRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.CreateScanConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::websecurityscanner::v1::ScanConfig >	the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteScanConfig(google::cloud::websecurityscanner::v1::DeleteScanConfigRequest const &, Options)

Deletes an existing ScanConfig and its child resources.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::DeleteScanConfigRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.DeleteScanConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

GetScanConfig(google::cloud::websecurityscanner::v1::GetScanConfigRequest const &, Options)

Gets a ScanConfig.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::GetScanConfigRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.GetScanConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::websecurityscanner::v1::ScanConfig >	the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListScanConfigs(google::cloud::websecurityscanner::v1::ListScanConfigsRequest, Options)

Lists ScanConfigs under a given project.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::ListScanConfigsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.ListScanConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::websecurityscanner::v1::ScanConfig >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.websecurityscanner.v1.ScanConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateScanConfig(google::cloud::websecurityscanner::v1::UpdateScanConfigRequest const &, Options)

Updates a ScanConfig.

This method support partial update of a ScanConfig.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::UpdateScanConfigRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.UpdateScanConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::websecurityscanner::v1::ScanConfig >	the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

StartScanRun(google::cloud::websecurityscanner::v1::StartScanRunRequest const &, Options)

Start a ScanRun according to the given ScanConfig.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::StartScanRunRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.StartScanRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::websecurityscanner::v1::ScanRun >	the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetScanRun(google::cloud::websecurityscanner::v1::GetScanRunRequest const &, Options)

Gets a ScanRun.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::GetScanRunRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.GetScanRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::websecurityscanner::v1::ScanRun >	the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListScanRuns(google::cloud::websecurityscanner::v1::ListScanRunsRequest, Options)

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

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::ListScanRunsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.ListScanRunsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::websecurityscanner::v1::ScanRun >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.websecurityscanner.v1.ScanRun, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

StopScanRun(google::cloud::websecurityscanner::v1::StopScanRunRequest const &, Options)

Stops a ScanRun.

The stopped ScanRun is returned.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::StopScanRunRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.StopScanRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::websecurityscanner::v1::ScanRun >	the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListCrawledUrls(google::cloud::websecurityscanner::v1::ListCrawledUrlsRequest, Options)

List CrawledUrls under a given ScanRun.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::ListCrawledUrlsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.ListCrawledUrlsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::websecurityscanner::v1::CrawledUrl >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.websecurityscanner.v1.CrawledUrl, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetFinding(google::cloud::websecurityscanner::v1::GetFindingRequest const &, Options)

Gets a Finding.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::GetFindingRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.GetFindingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::websecurityscanner::v1::Finding >	the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListFindings(google::cloud::websecurityscanner::v1::ListFindingsRequest, Options)

List Findings under a given ScanRun.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::ListFindingsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.ListFindingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::websecurityscanner::v1::Finding >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.websecurityscanner.v1.Finding, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListFindingTypeStats(google::cloud::websecurityscanner::v1::ListFindingTypeStatsRequest const &, Options)

List all FindingTypeStats under a given ScanRun.

Parameters
Name	Description
request	google::cloud::websecurityscanner::v1::ListFindingTypeStatsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.websecurityscanner.v1.ListFindingTypeStatsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::websecurityscanner::v1::ListFindingTypeStatsResponse >	the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ListFindingTypeStatsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.