Interface ScanConfigOrBuilder (2.54.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.v1beta.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.v1beta.ScanConfig.Authentication authentication = 5;

Returns
Type	Description
`ScanConfig.AuthenticationOrBuilder`

getBlacklistPatterns(int index)

public abstract String getBlacklistPatterns(int index)

The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-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 blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-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 blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls

repeated string blacklist_patterns = 7;

Returns
Type	Description
`int`	The count of blacklistPatterns.

getBlacklistPatternsList()

public abstract List<String> getBlacklistPatternsList()

The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-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 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The user provided display name of the ScanConfig.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for displayName.

getExportToSecurityCommandCenter()

public abstract ScanConfig.ExportToSecurityCommandCenter getExportToSecurityCommandCenter()

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

.google.cloud.websecurityscanner.v1beta.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 Cloud Security Command Center.

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

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

getLatestRun()

public abstract ScanRun getLatestRun()

Latest ScanRun if available.

.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;

Returns
Type	Description
`ScanRun`	The latestRun.

getLatestRunOrBuilder()

public abstract ScanRunOrBuilder getLatestRunOrBuilder()

Latest ScanRun if available.

.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;

Returns
Type	Description
`ScanRunOrBuilder`

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.v1beta.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.v1beta.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.v1beta.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.v1beta.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 [(.google.api.field_behavior) = REQUIRED];

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 [(.google.api.field_behavior) = REQUIRED];

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 [(.google.api.field_behavior) = REQUIRED];

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 [(.google.api.field_behavior) = REQUIRED];

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