Class WebSecurityScannerClient (2.2.1)

Version 2.2.1

• 2.54.0 (latest)
• 2.53.0
• 2.52.0
• 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

public class WebSecurityScannerClient implements BackgroundResource

Service Description: 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.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   CreateScanConfigRequest request =
       CreateScanConfigRequest.newBuilder()
           .setParent("parent-995424086")
           .setScanConfig(ScanConfig.newBuilder().build())
           .build();
   ScanConfig response = webSecurityScannerClient.createScanConfig(request);
 }
 

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().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 WebSecurityScannerSettings webSecurityScannerSettings =
     WebSecurityScannerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WebSecurityScannerClient webSecurityScannerClient =
     WebSecurityScannerClient.create(webSecurityScannerSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 WebSecurityScannerSettings webSecurityScannerSettings =
     WebSecurityScannerSettings.newBuilder()
         .setTransportChannelProvider(
             WebSecurityScannerSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 WebSecurityScannerClient webSecurityScannerClient =
     WebSecurityScannerClient.create(webSecurityScannerSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > WebSecurityScannerClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   CreateScanConfigRequest request =
       CreateScanConfigRequest.newBuilder()
           .setParent("parent-995424086")
           .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

createScanConfigCallable()

public final UnaryCallable<CreateScanConfigRequest,ScanConfig> createScanConfigCallable()

Creates a new ScanConfig.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   CreateScanConfigRequest request =
       CreateScanConfigRequest.newBuilder()
           .setParent("parent-995424086")
           .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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   DeleteScanConfigRequest request =
       DeleteScanConfigRequest.newBuilder().setName("name3373707").build();
   webSecurityScannerClient.deleteScanConfig(request);
 }
 

Parameter

Name	Description
request	DeleteScanConfigRequest The request object containing all of the parameters for the API call.

deleteScanConfigCallable()

public final UnaryCallable<DeleteScanConfigRequest,Empty> deleteScanConfigCallable()

Deletes an existing ScanConfig and its child resources.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   DeleteScanConfigRequest request =
       DeleteScanConfigRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Empty> future =
       webSecurityScannerClient.deleteScanConfigCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteScanConfigRequest,Empty>

getFinding(GetFindingRequest request)

public final Finding getFinding(GetFindingRequest request)

Gets a Finding.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   GetFindingRequest request = GetFindingRequest.newBuilder().setName("name3373707").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

getFindingCallable()

public final UnaryCallable<GetFindingRequest,Finding> getFindingCallable()

Gets a Finding.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   GetFindingRequest request = GetFindingRequest.newBuilder().setName("name3373707").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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   GetScanConfigRequest request =
       GetScanConfigRequest.newBuilder().setName("name3373707").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

getScanConfigCallable()

public final UnaryCallable<GetScanConfigRequest,ScanConfig> getScanConfigCallable()

Gets a ScanConfig.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   GetScanConfigRequest request =
       GetScanConfigRequest.newBuilder().setName("name3373707").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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   GetScanRunRequest request = GetScanRunRequest.newBuilder().setName("name3373707").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

getScanRunCallable()

public final UnaryCallable<GetScanRunRequest,ScanRun> getScanRunCallable()

Gets a ScanRun.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   GetScanRunRequest request = GetScanRunRequest.newBuilder().setName("name3373707").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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListCrawledUrlsRequest request =
       ListCrawledUrlsRequest.newBuilder()
           .setParent("parent-995424086")
           .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

listCrawledUrlsCallable()

public final UnaryCallable<ListCrawledUrlsRequest,ListCrawledUrlsResponse> listCrawledUrlsCallable()

List CrawledUrls under a given ScanRun.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListCrawledUrlsRequest request =
       ListCrawledUrlsRequest.newBuilder()
           .setParent("parent-995424086")
           .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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListCrawledUrlsRequest request =
       ListCrawledUrlsRequest.newBuilder()
           .setParent("parent-995424086")
           .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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListFindingTypeStatsRequest request =
       ListFindingTypeStatsRequest.newBuilder().setParent("parent-995424086").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

listFindingTypeStatsCallable()

public final UnaryCallable<ListFindingTypeStatsRequest,ListFindingTypeStatsResponse> listFindingTypeStatsCallable()

List all FindingTypeStats under a given ScanRun.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListFindingTypeStatsRequest request =
       ListFindingTypeStatsRequest.newBuilder().setParent("parent-995424086").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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListFindingsRequest request =
       ListFindingsRequest.newBuilder()
           .setParent("parent-995424086")
           .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

listFindingsCallable()

public final UnaryCallable<ListFindingsRequest,ListFindingsResponse> listFindingsCallable()

List Findings under a given ScanRun.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListFindingsRequest request =
       ListFindingsRequest.newBuilder()
           .setParent("parent-995424086")
           .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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListFindingsRequest request =
       ListFindingsRequest.newBuilder()
           .setParent("parent-995424086")
           .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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListScanConfigsRequest request =
       ListScanConfigsRequest.newBuilder()
           .setParent("parent-995424086")
           .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

listScanConfigsCallable()

public final UnaryCallable<ListScanConfigsRequest,ListScanConfigsResponse> listScanConfigsCallable()

Lists ScanConfigs under a given project.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListScanConfigsRequest request =
       ListScanConfigsRequest.newBuilder()
           .setParent("parent-995424086")
           .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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListScanConfigsRequest request =
       ListScanConfigsRequest.newBuilder()
           .setParent("parent-995424086")
           .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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListScanRunsRequest request =
       ListScanRunsRequest.newBuilder()
           .setParent("parent-995424086")
           .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

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListScanRunsRequest request =
       ListScanRunsRequest.newBuilder()
           .setParent("parent-995424086")
           .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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   ListScanRunsRequest request =
       ListScanRunsRequest.newBuilder()
           .setParent("parent-995424086")
           .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(StartScanRunRequest request)

public final ScanRun startScanRun(StartScanRunRequest request)

Start a ScanRun according to the given ScanConfig.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   StartScanRunRequest request = StartScanRunRequest.newBuilder().setName("name3373707").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

startScanRunCallable()

public final UnaryCallable<StartScanRunRequest,ScanRun> startScanRunCallable()

Start a ScanRun according to the given ScanConfig.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   StartScanRunRequest request = StartScanRunRequest.newBuilder().setName("name3373707").build();
   ApiFuture<ScanRun> future =
       webSecurityScannerClient.startScanRunCallable().futureCall(request);
   // Do something.
   ScanRun response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<StartScanRunRequest,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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   StopScanRunRequest request = StopScanRunRequest.newBuilder().setName("name3373707").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

stopScanRunCallable()

public final UnaryCallable<StopScanRunRequest,ScanRun> stopScanRunCallable()

Stops a ScanRun. The stopped ScanRun is returned.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   StopScanRunRequest request = StopScanRunRequest.newBuilder().setName("name3373707").build();
   ApiFuture<ScanRun> future =
       webSecurityScannerClient.stopScanRunCallable().futureCall(request);
   // Do something.
   ScanRun response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<StopScanRunRequest,ScanRun>

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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>