com.google.cloud.websecurityscanner.v1

Class WebSecurityScannerSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<WebSecurityScannerSettings>

com.google.cloud.websecurityscanner.v1.WebSecurityScannerSettings

@Generated(value="by gapic-generator-java")
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:

 // 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.Builder webSecurityScannerSettingsBuilder =
     WebSecurityScannerSettings.newBuilder();
 webSecurityScannerSettingsBuilder
     .createScanConfigSettings()
     .setRetrySettings(
         webSecurityScannerSettingsBuilder
             .createScanConfigSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 WebSecurityScannerSettings webSecurityScannerSettings =
     webSecurityScannerSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSecurityScannerSettings.Builder Builder for WebSecurityScannerSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebSecurityScannerSettings(WebSecurityScannerSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static WebSecurityScannerSettings	create(WebSecurityScannerStubSettings stub)
UnaryCallSettings<CreateScanConfigRequest,ScanConfig>	createScanConfigSettings() Returns the object with the settings used for calls to createScanConfig.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteScanConfigRequest,Empty>	deleteScanConfigSettings() Returns the object with the settings used for calls to deleteScanConfig.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<GetFindingRequest,Finding>	getFindingSettings() Returns the object with the settings used for calls to getFinding.
UnaryCallSettings<GetScanConfigRequest,ScanConfig>	getScanConfigSettings() Returns the object with the settings used for calls to getScanConfig.
UnaryCallSettings<GetScanRunRequest,ScanRun>	getScanRunSettings() Returns the object with the settings used for calls to getScanRun.
PagedCallSettings<ListCrawledUrlsRequest,ListCrawledUrlsResponse,WebSecurityScannerClient.ListCrawledUrlsPagedResponse>	listCrawledUrlsSettings() Returns the object with the settings used for calls to listCrawledUrls.
PagedCallSettings<ListFindingsRequest,ListFindingsResponse,WebSecurityScannerClient.ListFindingsPagedResponse>	listFindingsSettings() Returns the object with the settings used for calls to listFindings.
UnaryCallSettings<ListFindingTypeStatsRequest,ListFindingTypeStatsResponse>	listFindingTypeStatsSettings() Returns the object with the settings used for calls to listFindingTypeStats.
PagedCallSettings<ListScanConfigsRequest,ListScanConfigsResponse,WebSecurityScannerClient.ListScanConfigsPagedResponse>	listScanConfigsSettings() Returns the object with the settings used for calls to listScanConfigs.
PagedCallSettings<ListScanRunsRequest,ListScanRunsResponse,WebSecurityScannerClient.ListScanRunsPagedResponse>	listScanRunsSettings() Returns the object with the settings used for calls to listScanRuns.
static WebSecurityScannerSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static WebSecurityScannerSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
static WebSecurityScannerSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
UnaryCallSettings<StartScanRunRequest,ScanRun>	startScanRunSettings() Returns the object with the settings used for calls to startScanRun.
UnaryCallSettings<StopScanRunRequest,ScanRun>	stopScanRunSettings() Returns the object with the settings used for calls to stopScanRun.
WebSecurityScannerSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<UpdateScanConfigRequest,ScanConfig>	updateScanConfigSettings() Returns the object with the settings used for calls to updateScanConfig.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSecurityScannerSettings

protected WebSecurityScannerSettings(WebSecurityScannerSettings.Builder settingsBuilder)
                              throws IOException

Throws:

IOException

Method Detail

createScanConfigSettings

public UnaryCallSettings<CreateScanConfigRequest,ScanConfig> createScanConfigSettings()

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

deleteScanConfigSettings

public UnaryCallSettings<DeleteScanConfigRequest,Empty> deleteScanConfigSettings()

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

getScanConfigSettings

public UnaryCallSettings<GetScanConfigRequest,ScanConfig> getScanConfigSettings()

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

listScanConfigsSettings

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

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

updateScanConfigSettings

public UnaryCallSettings<UpdateScanConfigRequest,ScanConfig> updateScanConfigSettings()

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

startScanRunSettings

public UnaryCallSettings<StartScanRunRequest,ScanRun> startScanRunSettings()

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

getScanRunSettings

public UnaryCallSettings<GetScanRunRequest,ScanRun> getScanRunSettings()

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

listScanRunsSettings

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

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

stopScanRunSettings

public UnaryCallSettings<StopScanRunRequest,ScanRun> stopScanRunSettings()

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

listCrawledUrlsSettings

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

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

getFindingSettings

public UnaryCallSettings<GetFindingRequest,Finding> getFindingSettings()

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

listFindingsSettings

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

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

listFindingTypeStatsSettings

public UnaryCallSettings<ListFindingTypeStatsRequest,ListFindingTypeStatsResponse> listFindingTypeStatsSettings()

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

create

public static final WebSecurityScannerSettings create(WebSecurityScannerStubSettings stub)
                                               throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static WebSecurityScannerSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static WebSecurityScannerSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static WebSecurityScannerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public WebSecurityScannerSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<WebSecurityScannerSettings>