com.google.cloud.websecurityscanner.v1

Class WebSecurityScannerClient

java.lang.Object

com.google.cloud.websecurityscanner.v1.WebSecurityScannerClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator")
public class WebSecurityScannerClient
extends Object
implements com.google.api.gax.core.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:

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:

 WebSecurityScannerSettings webSecurityScannerSettings =
     WebSecurityScannerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WebSecurityScannerClient webSecurityScannerClient =
     WebSecurityScannerClient.create(webSecurityScannerSettings);
 

To customize the endpoint:

 WebSecurityScannerSettings webSecurityScannerSettings =
     WebSecurityScannerSettings.newBuilder().setEndpoint(myEndpoint).build();
 WebSecurityScannerClient webSecurityScannerClient =
     WebSecurityScannerClient.create(webSecurityScannerSettings);
 

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSecurityScannerClient.ListCrawledUrlsFixedSizeCollection
static class	WebSecurityScannerClient.ListCrawledUrlsPage
static class	WebSecurityScannerClient.ListCrawledUrlsPagedResponse
static class	WebSecurityScannerClient.ListFindingsFixedSizeCollection
static class	WebSecurityScannerClient.ListFindingsPage
static class	WebSecurityScannerClient.ListFindingsPagedResponse
static class	WebSecurityScannerClient.ListScanConfigsFixedSizeCollection
static class	WebSecurityScannerClient.ListScanConfigsPage
static class	WebSecurityScannerClient.ListScanConfigsPagedResponse
static class	WebSecurityScannerClient.ListScanRunsFixedSizeCollection
static class	WebSecurityScannerClient.ListScanRunsPage
static class	WebSecurityScannerClient.ListScanRunsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebSecurityScannerClient(WebSecurityScannerSettings settings) Constructs an instance of WebSecurityScannerClient, using the given settings.
protected	WebSecurityScannerClient(WebSecurityScannerStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static WebSecurityScannerClient	create() Constructs an instance of WebSecurityScannerClient with default settings.
static WebSecurityScannerClient	create(WebSecurityScannerSettings settings) Constructs an instance of WebSecurityScannerClient, using the given settings.
static WebSecurityScannerClient	create(WebSecurityScannerStub stub) Constructs an instance of WebSecurityScannerClient, using the given stub for making calls.
ScanConfig	createScanConfig(CreateScanConfigRequest request) Creates a new ScanConfig.
com.google.api.gax.rpc.UnaryCallable<CreateScanConfigRequest,ScanConfig>	createScanConfigCallable() Creates a new ScanConfig.
void	deleteScanConfig(DeleteScanConfigRequest request) Deletes an existing ScanConfig and its child resources.
com.google.api.gax.rpc.UnaryCallable<DeleteScanConfigRequest,com.google.protobuf.Empty>	deleteScanConfigCallable() Deletes an existing ScanConfig and its child resources.
Finding	getFinding(GetFindingRequest request) Gets a Finding.
com.google.api.gax.rpc.UnaryCallable<GetFindingRequest,Finding>	getFindingCallable() Gets a Finding.
ScanConfig	getScanConfig(GetScanConfigRequest request) Gets a ScanConfig.
com.google.api.gax.rpc.UnaryCallable<GetScanConfigRequest,ScanConfig>	getScanConfigCallable() Gets a ScanConfig.
ScanRun	getScanRun(GetScanRunRequest request) Gets a ScanRun.
com.google.api.gax.rpc.UnaryCallable<GetScanRunRequest,ScanRun>	getScanRunCallable() Gets a ScanRun.
WebSecurityScannerSettings	getSettings()
WebSecurityScannerStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
WebSecurityScannerClient.ListCrawledUrlsPagedResponse	listCrawledUrls(ListCrawledUrlsRequest request) List CrawledUrls under a given ScanRun.
com.google.api.gax.rpc.UnaryCallable<ListCrawledUrlsRequest,ListCrawledUrlsResponse>	listCrawledUrlsCallable() List CrawledUrls under a given ScanRun.
com.google.api.gax.rpc.UnaryCallable<ListCrawledUrlsRequest,WebSecurityScannerClient.ListCrawledUrlsPagedResponse>	listCrawledUrlsPagedCallable() List CrawledUrls under a given ScanRun.
WebSecurityScannerClient.ListFindingsPagedResponse	listFindings(ListFindingsRequest request) List Findings under a given ScanRun.
com.google.api.gax.rpc.UnaryCallable<ListFindingsRequest,ListFindingsResponse>	listFindingsCallable() List Findings under a given ScanRun.
com.google.api.gax.rpc.UnaryCallable<ListFindingsRequest,WebSecurityScannerClient.ListFindingsPagedResponse>	listFindingsPagedCallable() List Findings under a given ScanRun.
ListFindingTypeStatsResponse	listFindingTypeStats(ListFindingTypeStatsRequest request) List all FindingTypeStats under a given ScanRun.
com.google.api.gax.rpc.UnaryCallable<ListFindingTypeStatsRequest,ListFindingTypeStatsResponse>	listFindingTypeStatsCallable() List all FindingTypeStats under a given ScanRun.
WebSecurityScannerClient.ListScanConfigsPagedResponse	listScanConfigs(ListScanConfigsRequest request) Lists ScanConfigs under a given project.
com.google.api.gax.rpc.UnaryCallable<ListScanConfigsRequest,ListScanConfigsResponse>	listScanConfigsCallable() Lists ScanConfigs under a given project.
com.google.api.gax.rpc.UnaryCallable<ListScanConfigsRequest,WebSecurityScannerClient.ListScanConfigsPagedResponse>	listScanConfigsPagedCallable() Lists ScanConfigs under a given project.
WebSecurityScannerClient.ListScanRunsPagedResponse	listScanRuns(ListScanRunsRequest request) Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
com.google.api.gax.rpc.UnaryCallable<ListScanRunsRequest,ListScanRunsResponse>	listScanRunsCallable() Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
com.google.api.gax.rpc.UnaryCallable<ListScanRunsRequest,WebSecurityScannerClient.ListScanRunsPagedResponse>	listScanRunsPagedCallable() Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
void	shutdown()
void	shutdownNow()
ScanRun	startScanRun(StartScanRunRequest request) Start a ScanRun according to the given ScanConfig.
com.google.api.gax.rpc.UnaryCallable<StartScanRunRequest,ScanRun>	startScanRunCallable() Start a ScanRun according to the given ScanConfig.
ScanRun	stopScanRun(StopScanRunRequest request) Stops a ScanRun.
com.google.api.gax.rpc.UnaryCallable<StopScanRunRequest,ScanRun>	stopScanRunCallable() Stops a ScanRun.
ScanConfig	updateScanConfig(UpdateScanConfigRequest request) Updates a ScanConfig.
com.google.api.gax.rpc.UnaryCallable<UpdateScanConfigRequest,ScanConfig>	updateScanConfigCallable() Updates a ScanConfig.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebSecurityScannerClient

protected WebSecurityScannerClient(WebSecurityScannerSettings settings)
                            throws IOException

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.

Throws:

IOException

WebSecurityScannerClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected WebSecurityScannerClient(WebSecurityScannerStub stub)

Method Detail

create

public static final WebSecurityScannerClient create()
                                             throws IOException

Constructs an instance of WebSecurityScannerClient with default settings.

Throws:

IOException

create

public static final WebSecurityScannerClient create(WebSecurityScannerSettings settings)
                                             throws IOException

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.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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).

getSettings

public final WebSecurityScannerSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public WebSecurityScannerStub getStub()

createScanConfig

public final ScanConfig createScanConfig(CreateScanConfigRequest request)

Creates a new ScanConfig.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createScanConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateScanConfigRequest,ScanConfig> createScanConfigCallable()

Creates a new ScanConfig.

Sample code:

deleteScanConfig

public final void deleteScanConfig(DeleteScanConfigRequest request)

Deletes an existing ScanConfig and its child resources.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteScanConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteScanConfigRequest,com.google.protobuf.Empty> deleteScanConfigCallable()

Deletes an existing ScanConfig and its child resources.

Sample code:

getScanConfig

public final ScanConfig getScanConfig(GetScanConfigRequest request)

Gets a ScanConfig.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getScanConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<GetScanConfigRequest,ScanConfig> getScanConfigCallable()

Gets a ScanConfig.

Sample code:

listScanConfigs

public final WebSecurityScannerClient.ListScanConfigsPagedResponse listScanConfigs(ListScanConfigsRequest request)

Lists ScanConfigs under a given project.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listScanConfigsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListScanConfigsRequest,WebSecurityScannerClient.ListScanConfigsPagedResponse> listScanConfigsPagedCallable()

Lists ScanConfigs under a given project.

Sample code:

listScanConfigsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListScanConfigsRequest,ListScanConfigsResponse> listScanConfigsCallable()

Lists ScanConfigs under a given project.

Sample code:

updateScanConfig

public final ScanConfig updateScanConfig(UpdateScanConfigRequest request)

Updates a ScanConfig. This method support partial update of a ScanConfig.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateScanConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateScanConfigRequest,ScanConfig> updateScanConfigCallable()

Updates a ScanConfig. This method support partial update of a ScanConfig.

Sample code:

startScanRun

public final ScanRun startScanRun(StartScanRunRequest request)

Start a ScanRun according to the given ScanConfig.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

startScanRunCallable

public final com.google.api.gax.rpc.UnaryCallable<StartScanRunRequest,ScanRun> startScanRunCallable()

Start a ScanRun according to the given ScanConfig.

Sample code:

getScanRun

public final ScanRun getScanRun(GetScanRunRequest request)

Gets a ScanRun.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getScanRunCallable

public final com.google.api.gax.rpc.UnaryCallable<GetScanRunRequest,ScanRun> getScanRunCallable()

Gets a ScanRun.

Sample code:

listScanRuns

public final WebSecurityScannerClient.ListScanRunsPagedResponse listScanRuns(ListScanRunsRequest request)

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

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listScanRunsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListScanRunsRequest,WebSecurityScannerClient.ListScanRunsPagedResponse> listScanRunsPagedCallable()

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

Sample code:

listScanRunsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListScanRunsRequest,ListScanRunsResponse> listScanRunsCallable()

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

Sample code:

stopScanRun

public final ScanRun stopScanRun(StopScanRunRequest request)

Stops a ScanRun. The stopped ScanRun is returned.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

stopScanRunCallable

public final com.google.api.gax.rpc.UnaryCallable<StopScanRunRequest,ScanRun> stopScanRunCallable()

Stops a ScanRun. The stopped ScanRun is returned.

Sample code:

listCrawledUrls

public final WebSecurityScannerClient.ListCrawledUrlsPagedResponse listCrawledUrls(ListCrawledUrlsRequest request)

List CrawledUrls under a given ScanRun.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listCrawledUrlsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListCrawledUrlsRequest,WebSecurityScannerClient.ListCrawledUrlsPagedResponse> listCrawledUrlsPagedCallable()

List CrawledUrls under a given ScanRun.

Sample code:

listCrawledUrlsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListCrawledUrlsRequest,ListCrawledUrlsResponse> listCrawledUrlsCallable()

List CrawledUrls under a given ScanRun.

Sample code:

getFinding

public final Finding getFinding(GetFindingRequest request)

Gets a Finding.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getFindingCallable

public final com.google.api.gax.rpc.UnaryCallable<GetFindingRequest,Finding> getFindingCallable()

Gets a Finding.

Sample code:

listFindings

public final WebSecurityScannerClient.ListFindingsPagedResponse listFindings(ListFindingsRequest request)

List Findings under a given ScanRun.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listFindingsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListFindingsRequest,WebSecurityScannerClient.ListFindingsPagedResponse> listFindingsPagedCallable()

List Findings under a given ScanRun.

Sample code:

listFindingsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListFindingsRequest,ListFindingsResponse> listFindingsCallable()

List Findings under a given ScanRun.

Sample code:

listFindingTypeStats

public final ListFindingTypeStatsResponse listFindingTypeStats(ListFindingTypeStatsRequest request)

List all FindingTypeStats under a given ScanRun.

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listFindingTypeStatsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListFindingTypeStatsRequest,ListFindingTypeStatsResponse> listFindingTypeStatsCallable()

List all FindingTypeStats under a given ScanRun.

Sample code:

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException