Class WebSecurityScannerClient
- java.lang.Object
-
- com.google.cloud.websecurityscanner.v1beta.WebSecurityScannerClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class WebSecurityScannerClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
The surface of this class includes several types of Java methods for each of the API's methods:
- 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.
- 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.
- 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 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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 Description protected
WebSecurityScannerClient(WebSecurityScannerStub stub)
protected
WebSecurityScannerClient(WebSecurityScannerSettings settings)
Constructs an instance of WebSecurityScannerClient, using the given settings.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static WebSecurityScannerClient
create()
Constructs an instance of WebSecurityScannerClient with default settings.static WebSecurityScannerClient
create(WebSecurityScannerStub stub)
Constructs an instance of WebSecurityScannerClient, using the given stub for making calls.static WebSecurityScannerClient
create(WebSecurityScannerSettings settings)
Constructs an instance of WebSecurityScannerClient, using the given settings.ScanConfig
createScanConfig(CreateScanConfigRequest request)
Creates a new ScanConfig.ScanConfig
createScanConfig(ProjectName parent, ScanConfig scanConfig)
Creates a new ScanConfig.ScanConfig
createScanConfig(String parent, ScanConfig scanConfig)
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.void
deleteScanConfig(ScanConfigName name)
Deletes an existing ScanConfig and its child resources.void
deleteScanConfig(String name)
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(FindingName name)
Gets a Finding.Finding
getFinding(GetFindingRequest request)
Gets a Finding.Finding
getFinding(String name)
Gets a Finding.com.google.api.gax.rpc.UnaryCallable<GetFindingRequest,Finding>
getFindingCallable()
Gets a Finding.ScanConfig
getScanConfig(GetScanConfigRequest request)
Gets a ScanConfig.ScanConfig
getScanConfig(ScanConfigName name)
Gets a ScanConfig.ScanConfig
getScanConfig(String name)
Gets a ScanConfig.com.google.api.gax.rpc.UnaryCallable<GetScanConfigRequest,ScanConfig>
getScanConfigCallable()
Gets a ScanConfig.ScanRun
getScanRun(GetScanRunRequest request)
Gets a ScanRun.ScanRun
getScanRun(ScanRunName name)
Gets a ScanRun.ScanRun
getScanRun(String name)
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.WebSecurityScannerClient.ListCrawledUrlsPagedResponse
listCrawledUrls(ScanRunName parent)
List CrawledUrls under a given ScanRun.WebSecurityScannerClient.ListCrawledUrlsPagedResponse
listCrawledUrls(String parent)
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.WebSecurityScannerClient.ListFindingsPagedResponse
listFindings(ScanRunName parent, String filter)
List Findings under a given ScanRun.WebSecurityScannerClient.ListFindingsPagedResponse
listFindings(String parent, String filter)
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.ListFindingTypeStatsResponse
listFindingTypeStats(ScanRunName parent)
List all FindingTypeStats under a given ScanRun.ListFindingTypeStatsResponse
listFindingTypeStats(String parent)
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.WebSecurityScannerClient.ListScanConfigsPagedResponse
listScanConfigs(ProjectName parent)
Lists ScanConfigs under a given project.WebSecurityScannerClient.ListScanConfigsPagedResponse
listScanConfigs(String parent)
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.WebSecurityScannerClient.ListScanRunsPagedResponse
listScanRuns(ScanConfigName parent)
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.WebSecurityScannerClient.ListScanRunsPagedResponse
listScanRuns(String parent)
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(ScanConfigName name)
Start a ScanRun according to the given ScanConfig.ScanRun
startScanRun(StartScanRunRequest request)
Start a ScanRun according to the given ScanConfig.ScanRun
startScanRun(String name)
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(ScanRunName name)
Stops a ScanRun.ScanRun
stopScanRun(StopScanRunRequest request)
Stops a ScanRun.ScanRun
stopScanRun(String name)
Stops a ScanRun.com.google.api.gax.rpc.UnaryCallable<StopScanRunRequest,ScanRun>
stopScanRunCallable()
Stops a ScanRun.ScanConfig
updateScanConfig(ScanConfig scanConfig, com.google.protobuf.FieldMask updateMask)
Updates a ScanConfig.ScanConfig
updateScanConfig(UpdateScanConfigRequest request)
Updates a ScanConfig.com.google.api.gax.rpc.UnaryCallable<UpdateScanConfigRequest,ScanConfig>
updateScanConfigCallable()
Updates a ScanConfig.
-
-
-
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
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
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
public WebSecurityScannerStub getStub()
-
createScanConfig
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:
parent
- Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.scanConfig
- Required. The ScanConfig to be created.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createScanConfig
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:
parent
- Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.scanConfig
- Required. The ScanConfig to be created.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createScanConfig
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); }
- 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:
// 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(); }
-
deleteScanConfig
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); }
- Parameters:
name
- Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteScanConfig
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); }
- Parameters:
name
- Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteScanConfig
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); }
- 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:
// 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(); }
-
getScanConfig
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); }
- Parameters:
name
- Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getScanConfig
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); }
- Parameters:
name
- Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getScanConfig
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); }
- 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:
// 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(); }
-
listScanConfigs
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); } }
- Parameters:
parent
- Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listScanConfigs
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); } }
- Parameters:
parent
- Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listScanConfigs
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); } }
- 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:
// 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); } }
-
listScanConfigsCallable
public final com.google.api.gax.rpc.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; } } }
-
updateScanConfig
public final ScanConfig updateScanConfig(ScanConfig scanConfig, com.google.protobuf.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:
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
- Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateScanConfig
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); }
- 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:
// 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(); }
-
startScanRun
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); }
- Parameters:
name
- Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
startScanRun
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); }
- Parameters:
name
- Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
startScanRun
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); }
- 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:
// 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(); }
-
getScanRun
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); }
- Parameters:
name
- Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getScanRun
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); }
- Parameters:
name
- Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getScanRun
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); }
- 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:
// 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(); }
-
listScanRuns
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); } }
- Parameters:
parent
- Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listScanRuns
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); } }
- Parameters:
parent
- Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listScanRuns
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); } }
- 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:
// 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); } }
-
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:
// 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; } } }
-
stopScanRun
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); }
- Parameters:
name
- Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
stopScanRun
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); }
- Parameters:
name
- Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
stopScanRun
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); }
- 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:
// 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(); }
-
listCrawledUrls
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); } }
- Parameters:
parent
- Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listCrawledUrls
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); } }
- Parameters:
parent
- Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listCrawledUrls
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); } }
- 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:
// 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); } }
-
listCrawledUrlsCallable
public final com.google.api.gax.rpc.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; } } }
-
getFinding
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); }
- Parameters:
name
- Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getFinding
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); }
- Parameters:
name
- Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getFinding
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); }
- 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:
// 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(); }
-
listFindings
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:
parent
- Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.filter
- Required. The filter expression. The expression must be in the format: <field> <operator> <value>. Supported field: 'finding_type'. Supported operator: '='.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listFindings
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:
parent
- Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.filter
- Required. The filter expression. The expression must be in the format: <field> <operator> <value>. Supported field: 'finding_type'. Supported operator: '='.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listFindings
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); } }
- 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:
// 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); } }
-
listFindingsCallable
public final com.google.api.gax.rpc.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; } } }
-
listFindingTypeStats
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); }
- Parameters:
parent
- Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listFindingTypeStats
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); }
- Parameters:
parent
- Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listFindingTypeStats
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); }
- 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:
// 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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-