Interface ScanConfigOrBuilder (2.46.0)

public interface ScanConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAuthentication()

public abstract ScanConfig.Authentication getAuthentication()

The authentication configuration. If specified, service will use the authentication configuration during scanning.

.google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;

Returns
Type	Description
`ScanConfig.Authentication`	The authentication.

getAuthenticationOrBuilder()

public abstract ScanConfig.AuthenticationOrBuilder getAuthenticationOrBuilder()

The authentication configuration. If specified, service will use the authentication configuration during scanning.

.google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;

Returns
Type	Description
`ScanConfig.AuthenticationOrBuilder`

getBlacklistPatterns(int index)

public abstract String getBlacklistPatterns(int index)

The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

repeated string blacklist_patterns = 7;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The blacklistPatterns at the given index.

getBlacklistPatternsBytes(int index)

public abstract ByteString getBlacklistPatternsBytes(int index)

The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

repeated string blacklist_patterns = 7;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the blacklistPatterns at the given index.

getBlacklistPatternsCount()

public abstract int getBlacklistPatternsCount()

The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

repeated string blacklist_patterns = 7;

Returns
Type	Description
`int`	The count of blacklistPatterns.

getBlacklistPatternsList()

public abstract List<String> getBlacklistPatternsList()

The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

repeated string blacklist_patterns = 7;

Returns
Type	Description
`List<String>`	A list containing the blacklistPatterns.

getDisplayName()

public abstract String getDisplayName()

Required. The user provided display name of the ScanConfig.

string display_name = 2;

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The user provided display name of the ScanConfig.

string display_name = 2;

Returns
Type	Description
`ByteString`	The bytes for displayName.

getExportToSecurityCommandCenter()

public abstract ScanConfig.ExportToSecurityCommandCenter getExportToSecurityCommandCenter()

Controls export of scan configurations and results to Security Command Center.

.google.cloud.websecurityscanner.v1.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;

Returns
Type	Description
`ScanConfig.ExportToSecurityCommandCenter`	The exportToSecurityCommandCenter.

getExportToSecurityCommandCenterValue()

public abstract int getExportToSecurityCommandCenterValue()

Controls export of scan configurations and results to Security Command Center.

.google.cloud.websecurityscanner.v1.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;

Returns
Type	Description
`int`	The enum numeric value on the wire for exportToSecurityCommandCenter.

getIgnoreHttpStatusErrors()

public abstract boolean getIgnoreHttpStatusErrors()

Whether to keep scanning even if most requests return HTTP error codes.

bool ignore_http_status_errors = 15;

Returns
Type	Description
`boolean`	The ignoreHttpStatusErrors.

getManagedScan()

public abstract boolean getManagedScan()

Whether the scan config is managed by Web Security Scanner, output only.

bool managed_scan = 13;

Returns
Type	Description
`boolean`	The managedScan.

getMaxQps()

public abstract int getMaxQps()

The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

int32 max_qps = 3;

Returns
Type	Description
`int`	The maxQps.

getName()

public abstract String getName()

The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

string name = 1;

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

string name = 1;

Returns
Type	Description
`ByteString`	The bytes for name.

getRiskLevel()

public abstract ScanConfig.RiskLevel getRiskLevel()

The risk level selected for the scan

.google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel risk_level = 12;

Returns
Type	Description
`ScanConfig.RiskLevel`	The riskLevel.

getRiskLevelValue()

public abstract int getRiskLevelValue()

The risk level selected for the scan

.google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel risk_level = 12;

Returns
Type	Description
`int`	The enum numeric value on the wire for riskLevel.

getSchedule()

public abstract ScanConfig.Schedule getSchedule()

The schedule of the ScanConfig.

.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;

Returns
Type	Description
`ScanConfig.Schedule`	The schedule.

getScheduleOrBuilder()

public abstract ScanConfig.ScheduleOrBuilder getScheduleOrBuilder()

The schedule of the ScanConfig.

.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;

Returns
Type	Description
`ScanConfig.ScheduleOrBuilder`

getStartingUrls(int index)

public abstract String getStartingUrls(int index)

Required. The starting URLs from which the scanner finds site pages.

repeated string starting_urls = 4;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The startingUrls at the given index.

getStartingUrlsBytes(int index)

public abstract ByteString getStartingUrlsBytes(int index)

Required. The starting URLs from which the scanner finds site pages.

repeated string starting_urls = 4;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the startingUrls at the given index.

getStartingUrlsCount()

public abstract int getStartingUrlsCount()

Required. The starting URLs from which the scanner finds site pages.

repeated string starting_urls = 4;

Returns
Type	Description
`int`	The count of startingUrls.

getStartingUrlsList()

public abstract List<String> getStartingUrlsList()

Required. The starting URLs from which the scanner finds site pages.

repeated string starting_urls = 4;

Returns
Type	Description
`List<String>`	A list containing the startingUrls.

getStaticIpScan()

public abstract boolean getStaticIpScan()

Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

bool static_ip_scan = 14;

Returns
Type	Description
`boolean`	The staticIpScan.

getUserAgent()

public abstract ScanConfig.UserAgent getUserAgent()

The user agent used during scanning.

.google.cloud.websecurityscanner.v1.ScanConfig.UserAgent user_agent = 6;

Returns
Type	Description
`ScanConfig.UserAgent`	The userAgent.

getUserAgentValue()

public abstract int getUserAgentValue()

The user agent used during scanning.

.google.cloud.websecurityscanner.v1.ScanConfig.UserAgent user_agent = 6;

Returns
Type	Description
`int`	The enum numeric value on the wire for userAgent.

hasAuthentication()

public abstract boolean hasAuthentication()

The authentication configuration. If specified, service will use the authentication configuration during scanning.

.google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;

Returns
Type	Description
`boolean`	Whether the authentication field is set.

hasSchedule()

public abstract boolean hasSchedule()

The schedule of the ScanConfig.

.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;

Returns
Type	Description
`boolean`	Whether the schedule field is set.