Class WebSecurityScannerSettings (2.0.15)

public class WebSecurityScannerSettings extends ClientSettings<WebSecurityScannerSettings>

Settings class to configure an instance of WebSecurityScannerClient.

The default instance has everything set to sensible defaults:

  • The default service address (websecurityscanner.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createScanConfig to 30 seconds:


 WebSecurityScannerSettings.Builder webSecurityScannerSettingsBuilder =
     WebSecurityScannerSettings.newBuilder();
 webSecurityScannerSettingsBuilder
     .createScanConfigSettings()
     .setRetrySettings(
         webSecurityScannerSettingsBuilder
             .createScanConfigSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 WebSecurityScannerSettings webSecurityScannerSettings =
     webSecurityScannerSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > WebSecurityScannerSettings

Static Methods

create(WebSecurityScannerStubSettings stub)

public static final WebSecurityScannerSettings create(WebSecurityScannerStubSettings stub)
Parameter
NameDescription
stubWebSecurityScannerStubSettings
Returns
TypeDescription
WebSecurityScannerSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static WebSecurityScannerSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
WebSecurityScannerSettings.Builder

newBuilder(ClientContext clientContext)

public static WebSecurityScannerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
WebSecurityScannerSettings.Builder

Constructors

WebSecurityScannerSettings(WebSecurityScannerSettings.Builder settingsBuilder)

protected WebSecurityScannerSettings(WebSecurityScannerSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderWebSecurityScannerSettings.Builder

Methods

createScanConfigSettings()

public UnaryCallSettings<CreateScanConfigRequest,ScanConfig> createScanConfigSettings()

Returns the object with the settings used for calls to createScanConfig.

Returns
TypeDescription
UnaryCallSettings<CreateScanConfigRequest,ScanConfig>

deleteScanConfigSettings()

public UnaryCallSettings<DeleteScanConfigRequest,Empty> deleteScanConfigSettings()

Returns the object with the settings used for calls to deleteScanConfig.

Returns
TypeDescription
UnaryCallSettings<DeleteScanConfigRequest,Empty>

getFindingSettings()

public UnaryCallSettings<GetFindingRequest,Finding> getFindingSettings()

Returns the object with the settings used for calls to getFinding.

Returns
TypeDescription
UnaryCallSettings<GetFindingRequest,Finding>

getScanConfigSettings()

public UnaryCallSettings<GetScanConfigRequest,ScanConfig> getScanConfigSettings()

Returns the object with the settings used for calls to getScanConfig.

Returns
TypeDescription
UnaryCallSettings<GetScanConfigRequest,ScanConfig>

getScanRunSettings()

public UnaryCallSettings<GetScanRunRequest,ScanRun> getScanRunSettings()

Returns the object with the settings used for calls to getScanRun.

Returns
TypeDescription
UnaryCallSettings<GetScanRunRequest,ScanRun>

listCrawledUrlsSettings()

public PagedCallSettings<ListCrawledUrlsRequest,ListCrawledUrlsResponse,WebSecurityScannerClient.ListCrawledUrlsPagedResponse> listCrawledUrlsSettings()

Returns the object with the settings used for calls to listCrawledUrls.

Returns
TypeDescription
PagedCallSettings<ListCrawledUrlsRequest,ListCrawledUrlsResponse,ListCrawledUrlsPagedResponse>

listFindingTypeStatsSettings()

public UnaryCallSettings<ListFindingTypeStatsRequest,ListFindingTypeStatsResponse> listFindingTypeStatsSettings()

Returns the object with the settings used for calls to listFindingTypeStats.

Returns
TypeDescription
UnaryCallSettings<ListFindingTypeStatsRequest,ListFindingTypeStatsResponse>

listFindingsSettings()

public PagedCallSettings<ListFindingsRequest,ListFindingsResponse,WebSecurityScannerClient.ListFindingsPagedResponse> listFindingsSettings()

Returns the object with the settings used for calls to listFindings.

Returns
TypeDescription
PagedCallSettings<ListFindingsRequest,ListFindingsResponse,ListFindingsPagedResponse>

listScanConfigsSettings()

public PagedCallSettings<ListScanConfigsRequest,ListScanConfigsResponse,WebSecurityScannerClient.ListScanConfigsPagedResponse> listScanConfigsSettings()

Returns the object with the settings used for calls to listScanConfigs.

Returns
TypeDescription
PagedCallSettings<ListScanConfigsRequest,ListScanConfigsResponse,ListScanConfigsPagedResponse>

listScanRunsSettings()

public PagedCallSettings<ListScanRunsRequest,ListScanRunsResponse,WebSecurityScannerClient.ListScanRunsPagedResponse> listScanRunsSettings()

Returns the object with the settings used for calls to listScanRuns.

Returns
TypeDescription
PagedCallSettings<ListScanRunsRequest,ListScanRunsResponse,ListScanRunsPagedResponse>

startScanRunSettings()

public UnaryCallSettings<StartScanRunRequest,ScanRun> startScanRunSettings()

Returns the object with the settings used for calls to startScanRun.

Returns
TypeDescription
UnaryCallSettings<StartScanRunRequest,ScanRun>

stopScanRunSettings()

public UnaryCallSettings<StopScanRunRequest,ScanRun> stopScanRunSettings()

Returns the object with the settings used for calls to stopScanRun.

Returns
TypeDescription
UnaryCallSettings<StopScanRunRequest,ScanRun>

toBuilder()

public WebSecurityScannerSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
TypeDescription
WebSecurityScannerSettings.Builder
Overrides

updateScanConfigSettings()

public UnaryCallSettings<UpdateScanConfigRequest,ScanConfig> updateScanConfigSettings()

Returns the object with the settings used for calls to updateScanConfig.

Returns
TypeDescription
UnaryCallSettings<UpdateScanConfigRequest,ScanConfig>