- 2.52.0 (latest)
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 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.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.4
- 2.1.1
- 2.0.15
GitHub Repository | Product Reference |
Service Description: Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
ScanConfig scanConfig = ScanConfig.newBuilder().build();
ScanConfig response = webSecurityScannerClient.createScanConfig(parent, scanConfig);
}
Note: close() needs to be called on the WebSecurityScannerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
CreateScanConfig |
Creates a new ScanConfig. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteScanConfig |
Deletes an existing ScanConfig and its child resources. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetScanConfig |
Gets a ScanConfig. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListScanConfigs |
Lists ScanConfigs under a given project. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateScanConfig |
Updates a ScanConfig. This method support partial update of a ScanConfig. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
StartScanRun |
Start a ScanRun according to the given ScanConfig. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetScanRun |
Gets a ScanRun. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListScanRuns |
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
StopScanRun |
Stops a ScanRun. The stopped ScanRun is returned. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListCrawledUrls |
List CrawledUrls under a given ScanRun. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetFinding |
Gets a Finding. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListFindings |
List Findings under a given ScanRun. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListFindingTypeStats |
List all FindingTypeStats under a given ScanRun. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of WebSecurityScannerSettings to create(). For example:
To customize credentials:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
WebSecurityScannerSettings webSecurityScannerSettings =
WebSecurityScannerSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
WebSecurityScannerClient webSecurityScannerClient =
WebSecurityScannerClient.create(webSecurityScannerSettings);
To customize the endpoint:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
WebSecurityScannerSettings webSecurityScannerSettings =
WebSecurityScannerSettings.newBuilder().setEndpoint(myEndpoint).build();
WebSecurityScannerClient webSecurityScannerClient =
WebSecurityScannerClient.create(webSecurityScannerSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
WebSecurityScannerSettings webSecurityScannerSettings =
WebSecurityScannerSettings.newHttpJsonBuilder().build();
WebSecurityScannerClient webSecurityScannerClient =
WebSecurityScannerClient.create(webSecurityScannerSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final WebSecurityScannerClient create()
Constructs an instance of WebSecurityScannerClient with default settings.
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(WebSecurityScannerSettings settings)
public static final WebSecurityScannerClient create(WebSecurityScannerSettings settings)
Constructs an instance of WebSecurityScannerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings |
WebSecurityScannerSettings |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(WebSecurityScannerStub stub)
public static final WebSecurityScannerClient create(WebSecurityScannerStub stub)
Constructs an instance of WebSecurityScannerClient, using the given stub for making calls. This is for advanced usage - prefer using create(WebSecurityScannerSettings).
Parameter | |
---|---|
Name | Description |
stub |
WebSecurityScannerStub |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient |
Constructors
WebSecurityScannerClient(WebSecurityScannerSettings settings)
protected WebSecurityScannerClient(WebSecurityScannerSettings settings)
Constructs an instance of WebSecurityScannerClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Parameter | |
---|---|
Name | Description |
settings |
WebSecurityScannerSettings |
WebSecurityScannerClient(WebSecurityScannerStub stub)
protected WebSecurityScannerClient(WebSecurityScannerStub stub)
Parameter | |
---|---|
Name | Description |
stub |
WebSecurityScannerStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createScanConfig(CreateScanConfigRequest request)
public final ScanConfig createScanConfig(CreateScanConfigRequest request)
Creates a new ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
CreateScanConfigRequest request =
CreateScanConfigRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setScanConfig(ScanConfig.newBuilder().build())
.build();
ScanConfig response = webSecurityScannerClient.createScanConfig(request);
}
Parameter | |
---|---|
Name | Description |
request |
CreateScanConfigRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ScanConfig |
createScanConfig(ProjectName parent, ScanConfig scanConfig)
public final ScanConfig createScanConfig(ProjectName parent, ScanConfig scanConfig)
Creates a new ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
ScanConfig scanConfig = ScanConfig.newBuilder().build();
ScanConfig response = webSecurityScannerClient.createScanConfig(parent, scanConfig);
}
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. |
scanConfig |
ScanConfig Required. The ScanConfig to be created. |
Returns | |
---|---|
Type | Description |
ScanConfig |
createScanConfig(String parent, ScanConfig scanConfig)
public final ScanConfig createScanConfig(String parent, ScanConfig scanConfig)
Creates a new ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String parent = ProjectName.of("[PROJECT]").toString();
ScanConfig scanConfig = ScanConfig.newBuilder().build();
ScanConfig response = webSecurityScannerClient.createScanConfig(parent, scanConfig);
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. |
scanConfig |
ScanConfig Required. The ScanConfig to be created. |
Returns | |
---|---|
Type | Description |
ScanConfig |
createScanConfigCallable()
public final UnaryCallable<CreateScanConfigRequest,ScanConfig> createScanConfigCallable()
Creates a new ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
CreateScanConfigRequest request =
CreateScanConfigRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setScanConfig(ScanConfig.newBuilder().build())
.build();
ApiFuture<ScanConfig> future =
webSecurityScannerClient.createScanConfigCallable().futureCall(request);
// Do something.
ScanConfig response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateScanConfigRequest,ScanConfig> |
deleteScanConfig(DeleteScanConfigRequest request)
public final void deleteScanConfig(DeleteScanConfigRequest request)
Deletes an existing ScanConfig and its child resources.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
DeleteScanConfigRequest request =
DeleteScanConfigRequest.newBuilder()
.setName(ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString())
.build();
webSecurityScannerClient.deleteScanConfig(request);
}
Parameter | |
---|---|
Name | Description |
request |
DeleteScanConfigRequest The request object containing all of the parameters for the API call. |
deleteScanConfig(ScanConfigName name)
public final void deleteScanConfig(ScanConfigName name)
Deletes an existing ScanConfig and its child resources.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ScanConfigName name = ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]");
webSecurityScannerClient.deleteScanConfig(name);
}
Parameter | |
---|---|
Name | Description |
name |
ScanConfigName Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. |
deleteScanConfig(String name)
public final void deleteScanConfig(String name)
Deletes an existing ScanConfig and its child resources.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String name = ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString();
webSecurityScannerClient.deleteScanConfig(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. |
deleteScanConfigCallable()
public final UnaryCallable<DeleteScanConfigRequest,Empty> deleteScanConfigCallable()
Deletes an existing ScanConfig and its child resources.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
DeleteScanConfigRequest request =
DeleteScanConfigRequest.newBuilder()
.setName(ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString())
.build();
ApiFuture<Empty> future =
webSecurityScannerClient.deleteScanConfigCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteScanConfigRequest,Empty> |
getFinding(FindingName name)
public final Finding getFinding(FindingName name)
Gets a Finding.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
FindingName name = FindingName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]", "[FINDING]");
Finding response = webSecurityScannerClient.getFinding(name);
}
Parameter | |
---|---|
Name | Description |
name |
FindingName Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. |
Returns | |
---|---|
Type | Description |
Finding |
getFinding(GetFindingRequest request)
public final Finding getFinding(GetFindingRequest request)
Gets a Finding.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
GetFindingRequest request =
GetFindingRequest.newBuilder()
.setName(
FindingName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]", "[FINDING]")
.toString())
.build();
Finding response = webSecurityScannerClient.getFinding(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetFindingRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Finding |
getFinding(String name)
public final Finding getFinding(String name)
Gets a Finding.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String name =
FindingName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]", "[FINDING]").toString();
Finding response = webSecurityScannerClient.getFinding(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. |
Returns | |
---|---|
Type | Description |
Finding |
getFindingCallable()
public final UnaryCallable<GetFindingRequest,Finding> getFindingCallable()
Gets a Finding.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
GetFindingRequest request =
GetFindingRequest.newBuilder()
.setName(
FindingName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]", "[FINDING]")
.toString())
.build();
ApiFuture<Finding> future = webSecurityScannerClient.getFindingCallable().futureCall(request);
// Do something.
Finding response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetFindingRequest,Finding> |
getScanConfig(GetScanConfigRequest request)
public final ScanConfig getScanConfig(GetScanConfigRequest request)
Gets a ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
GetScanConfigRequest request =
GetScanConfigRequest.newBuilder()
.setName(ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString())
.build();
ScanConfig response = webSecurityScannerClient.getScanConfig(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetScanConfigRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ScanConfig |
getScanConfig(ScanConfigName name)
public final ScanConfig getScanConfig(ScanConfigName name)
Gets a ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ScanConfigName name = ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]");
ScanConfig response = webSecurityScannerClient.getScanConfig(name);
}
Parameter | |
---|---|
Name | Description |
name |
ScanConfigName Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. |
Returns | |
---|---|
Type | Description |
ScanConfig |
getScanConfig(String name)
public final ScanConfig getScanConfig(String name)
Gets a ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String name = ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString();
ScanConfig response = webSecurityScannerClient.getScanConfig(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. |
Returns | |
---|---|
Type | Description |
ScanConfig |
getScanConfigCallable()
public final UnaryCallable<GetScanConfigRequest,ScanConfig> getScanConfigCallable()
Gets a ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
GetScanConfigRequest request =
GetScanConfigRequest.newBuilder()
.setName(ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString())
.build();
ApiFuture<ScanConfig> future =
webSecurityScannerClient.getScanConfigCallable().futureCall(request);
// Do something.
ScanConfig response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetScanConfigRequest,ScanConfig> |
getScanRun(GetScanRunRequest request)
public final ScanRun getScanRun(GetScanRunRequest request)
Gets a ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
GetScanRunRequest request =
GetScanRunRequest.newBuilder()
.setName(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.build();
ScanRun response = webSecurityScannerClient.getScanRun(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetScanRunRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ScanRun |
getScanRun(ScanRunName name)
public final ScanRun getScanRun(ScanRunName name)
Gets a ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ScanRunName name = ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]");
ScanRun response = webSecurityScannerClient.getScanRun(name);
}
Parameter | |
---|---|
Name | Description |
name |
ScanRunName Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. |
Returns | |
---|---|
Type | Description |
ScanRun |
getScanRun(String name)
public final ScanRun getScanRun(String name)
Gets a ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String name = ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString();
ScanRun response = webSecurityScannerClient.getScanRun(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. |
Returns | |
---|---|
Type | Description |
ScanRun |
getScanRunCallable()
public final UnaryCallable<GetScanRunRequest,ScanRun> getScanRunCallable()
Gets a ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
GetScanRunRequest request =
GetScanRunRequest.newBuilder()
.setName(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.build();
ApiFuture<ScanRun> future = webSecurityScannerClient.getScanRunCallable().futureCall(request);
// Do something.
ScanRun response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetScanRunRequest,ScanRun> |
getSettings()
public final WebSecurityScannerSettings getSettings()
Returns | |
---|---|
Type | Description |
WebSecurityScannerSettings |
getStub()
public WebSecurityScannerStub getStub()
Returns | |
---|---|
Type | Description |
WebSecurityScannerStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listCrawledUrls(ListCrawledUrlsRequest request)
public final WebSecurityScannerClient.ListCrawledUrlsPagedResponse listCrawledUrls(ListCrawledUrlsRequest request)
List CrawledUrls under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListCrawledUrlsRequest request =
ListCrawledUrlsRequest.newBuilder()
.setParent(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
for (CrawledUrl element : webSecurityScannerClient.listCrawledUrls(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListCrawledUrlsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListCrawledUrlsPagedResponse |
listCrawledUrls(ScanRunName parent)
public final WebSecurityScannerClient.ListCrawledUrlsPagedResponse listCrawledUrls(ScanRunName parent)
List CrawledUrls under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ScanRunName parent = ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]");
for (CrawledUrl element : webSecurityScannerClient.listCrawledUrls(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
ScanRunName Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListCrawledUrlsPagedResponse |
listCrawledUrls(String parent)
public final WebSecurityScannerClient.ListCrawledUrlsPagedResponse listCrawledUrls(String parent)
List CrawledUrls under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String parent = ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString();
for (CrawledUrl element : webSecurityScannerClient.listCrawledUrls(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListCrawledUrlsPagedResponse |
listCrawledUrlsCallable()
public final UnaryCallable<ListCrawledUrlsRequest,ListCrawledUrlsResponse> listCrawledUrlsCallable()
List CrawledUrls under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListCrawledUrlsRequest request =
ListCrawledUrlsRequest.newBuilder()
.setParent(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
while (true) {
ListCrawledUrlsResponse response =
webSecurityScannerClient.listCrawledUrlsCallable().call(request);
for (CrawledUrl element : response.getCrawledUrlsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListCrawledUrlsRequest,ListCrawledUrlsResponse> |
listCrawledUrlsPagedCallable()
public final UnaryCallable<ListCrawledUrlsRequest,WebSecurityScannerClient.ListCrawledUrlsPagedResponse> listCrawledUrlsPagedCallable()
List CrawledUrls under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListCrawledUrlsRequest request =
ListCrawledUrlsRequest.newBuilder()
.setParent(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
ApiFuture<CrawledUrl> future =
webSecurityScannerClient.listCrawledUrlsPagedCallable().futureCall(request);
// Do something.
for (CrawledUrl element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListCrawledUrlsRequest,ListCrawledUrlsPagedResponse> |
listFindingTypeStats(ListFindingTypeStatsRequest request)
public final ListFindingTypeStatsResponse listFindingTypeStats(ListFindingTypeStatsRequest request)
List all FindingTypeStats under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListFindingTypeStatsRequest request =
ListFindingTypeStatsRequest.newBuilder()
.setParent(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.build();
ListFindingTypeStatsResponse response =
webSecurityScannerClient.listFindingTypeStats(request);
}
Parameter | |
---|---|
Name | Description |
request |
ListFindingTypeStatsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ListFindingTypeStatsResponse |
listFindingTypeStats(ScanRunName parent)
public final ListFindingTypeStatsResponse listFindingTypeStats(ScanRunName parent)
List all FindingTypeStats under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ScanRunName parent = ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]");
ListFindingTypeStatsResponse response = webSecurityScannerClient.listFindingTypeStats(parent);
}
Parameter | |
---|---|
Name | Description |
parent |
ScanRunName Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. |
Returns | |
---|---|
Type | Description |
ListFindingTypeStatsResponse |
listFindingTypeStats(String parent)
public final ListFindingTypeStatsResponse listFindingTypeStats(String parent)
List all FindingTypeStats under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String parent = ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString();
ListFindingTypeStatsResponse response = webSecurityScannerClient.listFindingTypeStats(parent);
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. |
Returns | |
---|---|
Type | Description |
ListFindingTypeStatsResponse |
listFindingTypeStatsCallable()
public final UnaryCallable<ListFindingTypeStatsRequest,ListFindingTypeStatsResponse> listFindingTypeStatsCallable()
List all FindingTypeStats under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListFindingTypeStatsRequest request =
ListFindingTypeStatsRequest.newBuilder()
.setParent(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.build();
ApiFuture<ListFindingTypeStatsResponse> future =
webSecurityScannerClient.listFindingTypeStatsCallable().futureCall(request);
// Do something.
ListFindingTypeStatsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListFindingTypeStatsRequest,ListFindingTypeStatsResponse> |
listFindings(ListFindingsRequest request)
public final WebSecurityScannerClient.ListFindingsPagedResponse listFindings(ListFindingsRequest request)
List Findings under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListFindingsRequest request =
ListFindingsRequest.newBuilder()
.setParent(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.setFilter("filter-1274492040")
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
for (Finding element : webSecurityScannerClient.listFindings(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListFindingsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListFindingsPagedResponse |
listFindings(ScanRunName parent, String filter)
public final WebSecurityScannerClient.ListFindingsPagedResponse listFindings(ScanRunName parent, String filter)
List Findings under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ScanRunName parent = ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]");
String filter = "filter-1274492040";
for (Finding element : webSecurityScannerClient.listFindings(parent, filter).iterateAll()) {
// doThingsWith(element);
}
}
Parameters | |
---|---|
Name | Description |
parent |
ScanRunName Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. |
filter |
String Required. The filter expression. The expression must be in the format: <field> <operator> <value>. Supported field: 'finding_type'. Supported operator: '='. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListFindingsPagedResponse |
listFindings(String parent, String filter)
public final WebSecurityScannerClient.ListFindingsPagedResponse listFindings(String parent, String filter)
List Findings under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String parent = ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString();
String filter = "filter-1274492040";
for (Finding element : webSecurityScannerClient.listFindings(parent, filter).iterateAll()) {
// doThingsWith(element);
}
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. |
filter |
String Required. The filter expression. The expression must be in the format: <field> <operator> <value>. Supported field: 'finding_type'. Supported operator: '='. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListFindingsPagedResponse |
listFindingsCallable()
public final UnaryCallable<ListFindingsRequest,ListFindingsResponse> listFindingsCallable()
List Findings under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListFindingsRequest request =
ListFindingsRequest.newBuilder()
.setParent(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.setFilter("filter-1274492040")
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
while (true) {
ListFindingsResponse response =
webSecurityScannerClient.listFindingsCallable().call(request);
for (Finding element : response.getFindingsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListFindingsRequest,ListFindingsResponse> |
listFindingsPagedCallable()
public final UnaryCallable<ListFindingsRequest,WebSecurityScannerClient.ListFindingsPagedResponse> listFindingsPagedCallable()
List Findings under a given ScanRun.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListFindingsRequest request =
ListFindingsRequest.newBuilder()
.setParent(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.setFilter("filter-1274492040")
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
ApiFuture<Finding> future =
webSecurityScannerClient.listFindingsPagedCallable().futureCall(request);
// Do something.
for (Finding element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListFindingsRequest,ListFindingsPagedResponse> |
listScanConfigs(ListScanConfigsRequest request)
public final WebSecurityScannerClient.ListScanConfigsPagedResponse listScanConfigs(ListScanConfigsRequest request)
Lists ScanConfigs under a given project.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListScanConfigsRequest request =
ListScanConfigsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
for (ScanConfig element : webSecurityScannerClient.listScanConfigs(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListScanConfigsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListScanConfigsPagedResponse |
listScanConfigs(ProjectName parent)
public final WebSecurityScannerClient.ListScanConfigsPagedResponse listScanConfigs(ProjectName parent)
Lists ScanConfigs under a given project.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
for (ScanConfig element : webSecurityScannerClient.listScanConfigs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
ProjectName Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListScanConfigsPagedResponse |
listScanConfigs(String parent)
public final WebSecurityScannerClient.ListScanConfigsPagedResponse listScanConfigs(String parent)
Lists ScanConfigs under a given project.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String parent = ProjectName.of("[PROJECT]").toString();
for (ScanConfig element : webSecurityScannerClient.listScanConfigs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListScanConfigsPagedResponse |
listScanConfigsCallable()
public final UnaryCallable<ListScanConfigsRequest,ListScanConfigsResponse> listScanConfigsCallable()
Lists ScanConfigs under a given project.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListScanConfigsRequest request =
ListScanConfigsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
while (true) {
ListScanConfigsResponse response =
webSecurityScannerClient.listScanConfigsCallable().call(request);
for (ScanConfig element : response.getScanConfigsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListScanConfigsRequest,ListScanConfigsResponse> |
listScanConfigsPagedCallable()
public final UnaryCallable<ListScanConfigsRequest,WebSecurityScannerClient.ListScanConfigsPagedResponse> listScanConfigsPagedCallable()
Lists ScanConfigs under a given project.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListScanConfigsRequest request =
ListScanConfigsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
ApiFuture<ScanConfig> future =
webSecurityScannerClient.listScanConfigsPagedCallable().futureCall(request);
// Do something.
for (ScanConfig element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListScanConfigsRequest,ListScanConfigsPagedResponse> |
listScanRuns(ListScanRunsRequest request)
public final WebSecurityScannerClient.ListScanRunsPagedResponse listScanRuns(ListScanRunsRequest request)
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListScanRunsRequest request =
ListScanRunsRequest.newBuilder()
.setParent(ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString())
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
for (ScanRun element : webSecurityScannerClient.listScanRuns(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListScanRunsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListScanRunsPagedResponse |
listScanRuns(ScanConfigName parent)
public final WebSecurityScannerClient.ListScanRunsPagedResponse listScanRuns(ScanConfigName parent)
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ScanConfigName parent = ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]");
for (ScanRun element : webSecurityScannerClient.listScanRuns(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
ScanConfigName Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListScanRunsPagedResponse |
listScanRuns(String parent)
public final WebSecurityScannerClient.ListScanRunsPagedResponse listScanRuns(String parent)
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String parent = ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString();
for (ScanRun element : webSecurityScannerClient.listScanRuns(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. |
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient.ListScanRunsPagedResponse |
listScanRunsCallable()
public final UnaryCallable<ListScanRunsRequest,ListScanRunsResponse> listScanRunsCallable()
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListScanRunsRequest request =
ListScanRunsRequest.newBuilder()
.setParent(ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString())
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
while (true) {
ListScanRunsResponse response =
webSecurityScannerClient.listScanRunsCallable().call(request);
for (ScanRun element : response.getScanRunsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListScanRunsRequest,ListScanRunsResponse> |
listScanRunsPagedCallable()
public final UnaryCallable<ListScanRunsRequest,WebSecurityScannerClient.ListScanRunsPagedResponse> listScanRunsPagedCallable()
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ListScanRunsRequest request =
ListScanRunsRequest.newBuilder()
.setParent(ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString())
.setPageToken("pageToken873572522")
.setPageSize(883849137)
.build();
ApiFuture<ScanRun> future =
webSecurityScannerClient.listScanRunsPagedCallable().futureCall(request);
// Do something.
for (ScanRun element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListScanRunsRequest,ListScanRunsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
startScanRun(ScanConfigName name)
public final ScanRun startScanRun(ScanConfigName name)
Start a ScanRun according to the given ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ScanConfigName name = ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]");
ScanRun response = webSecurityScannerClient.startScanRun(name);
}
Parameter | |
---|---|
Name | Description |
name |
ScanConfigName Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. |
Returns | |
---|---|
Type | Description |
ScanRun |
startScanRun(StartScanRunRequest request)
public final ScanRun startScanRun(StartScanRunRequest request)
Start a ScanRun according to the given ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
StartScanRunRequest request =
StartScanRunRequest.newBuilder()
.setName(ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString())
.build();
ScanRun response = webSecurityScannerClient.startScanRun(request);
}
Parameter | |
---|---|
Name | Description |
request |
StartScanRunRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ScanRun |
startScanRun(String name)
public final ScanRun startScanRun(String name)
Start a ScanRun according to the given ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String name = ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString();
ScanRun response = webSecurityScannerClient.startScanRun(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. |
Returns | |
---|---|
Type | Description |
ScanRun |
startScanRunCallable()
public final UnaryCallable<StartScanRunRequest,ScanRun> startScanRunCallable()
Start a ScanRun according to the given ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
StartScanRunRequest request =
StartScanRunRequest.newBuilder()
.setName(ScanConfigName.of("[PROJECT]", "[SCAN_CONFIG]").toString())
.build();
ApiFuture<ScanRun> future =
webSecurityScannerClient.startScanRunCallable().futureCall(request);
// Do something.
ScanRun response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<StartScanRunRequest,ScanRun> |
stopScanRun(ScanRunName name)
public final ScanRun stopScanRun(ScanRunName name)
Stops a ScanRun. The stopped ScanRun is returned.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ScanRunName name = ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]");
ScanRun response = webSecurityScannerClient.stopScanRun(name);
}
Parameter | |
---|---|
Name | Description |
name |
ScanRunName Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. |
Returns | |
---|---|
Type | Description |
ScanRun |
stopScanRun(StopScanRunRequest request)
public final ScanRun stopScanRun(StopScanRunRequest request)
Stops a ScanRun. The stopped ScanRun is returned.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
StopScanRunRequest request =
StopScanRunRequest.newBuilder()
.setName(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.build();
ScanRun response = webSecurityScannerClient.stopScanRun(request);
}
Parameter | |
---|---|
Name | Description |
request |
StopScanRunRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ScanRun |
stopScanRun(String name)
public final ScanRun stopScanRun(String name)
Stops a ScanRun. The stopped ScanRun is returned.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
String name = ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString();
ScanRun response = webSecurityScannerClient.stopScanRun(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. |
Returns | |
---|---|
Type | Description |
ScanRun |
stopScanRunCallable()
public final UnaryCallable<StopScanRunRequest,ScanRun> stopScanRunCallable()
Stops a ScanRun. The stopped ScanRun is returned.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
StopScanRunRequest request =
StopScanRunRequest.newBuilder()
.setName(ScanRunName.of("[PROJECT]", "[SCAN_CONFIG]", "[SCAN_RUN]").toString())
.build();
ApiFuture<ScanRun> future =
webSecurityScannerClient.stopScanRunCallable().futureCall(request);
// Do something.
ScanRun response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<StopScanRunRequest,ScanRun> |
updateScanConfig(ScanConfig scanConfig, FieldMask updateMask)
public final ScanConfig updateScanConfig(ScanConfig scanConfig, FieldMask updateMask)
Updates a ScanConfig. This method support partial update of a ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ScanConfig scanConfig = ScanConfig.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
ScanConfig response = webSecurityScannerClient.updateScanConfig(scanConfig, updateMask);
}
Parameters | |
---|---|
Name | Description |
scanConfig |
ScanConfig Required. The ScanConfig to be updated. The name field must be set to identify the resource to be updated. The values of fields not covered by the mask will be ignored. |
updateMask |
FieldMask Required. The update mask applies to the resource. For the |
Returns | |
---|---|
Type | Description |
ScanConfig |
updateScanConfig(UpdateScanConfigRequest request)
public final ScanConfig updateScanConfig(UpdateScanConfigRequest request)
Updates a ScanConfig. This method support partial update of a ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
UpdateScanConfigRequest request =
UpdateScanConfigRequest.newBuilder()
.setScanConfig(ScanConfig.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ScanConfig response = webSecurityScannerClient.updateScanConfig(request);
}
Parameter | |
---|---|
Name | Description |
request |
UpdateScanConfigRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ScanConfig |
updateScanConfigCallable()
public final UnaryCallable<UpdateScanConfigRequest,ScanConfig> updateScanConfigCallable()
Updates a ScanConfig. This method support partial update of a ScanConfig.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
UpdateScanConfigRequest request =
UpdateScanConfigRequest.newBuilder()
.setScanConfig(ScanConfig.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<ScanConfig> future =
webSecurityScannerClient.updateScanConfigCallable().futureCall(request);
// Do something.
ScanConfig response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateScanConfigRequest,ScanConfig> |