Interface ScanConfigOrBuilder (2.6.0)

Version 2.6.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.4
• 2.1.1
• 2.0.15

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.v1alpha.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.v1alpha.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.

getLatestRun()

public abstract ScanRun getLatestRun()

Latest ScanRun if available.

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

Returns

Type	Description
ScanRun	The latestRun.

getLatestRunOrBuilder()

public abstract ScanRunOrBuilder getLatestRunOrBuilder()

Latest ScanRun if available.

.google.cloud.websecurityscanner.v1alpha.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.

getSchedule()

public abstract ScanConfig.Schedule getSchedule()

The schedule of the ScanConfig.

.google.cloud.websecurityscanner.v1alpha.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.v1alpha.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.

getTargetPlatforms(int index)

public abstract ScanConfig.TargetPlatform getTargetPlatforms(int index)

Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

repeated .google.cloud.websecurityscanner.v1alpha.ScanConfig.TargetPlatform target_platforms = 9;

Parameter

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

Returns

Type	Description
ScanConfig.TargetPlatform	The targetPlatforms at the given index.

getTargetPlatformsCount()

public abstract int getTargetPlatformsCount()

Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

repeated .google.cloud.websecurityscanner.v1alpha.ScanConfig.TargetPlatform target_platforms = 9;

Returns

Type	Description
int	The count of targetPlatforms.

getTargetPlatformsList()

public abstract List<ScanConfig.TargetPlatform> getTargetPlatformsList()

Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

repeated .google.cloud.websecurityscanner.v1alpha.ScanConfig.TargetPlatform target_platforms = 9;

Returns

Type	Description
List<TargetPlatform>	A list containing the targetPlatforms.

getTargetPlatformsValue(int index)

public abstract int getTargetPlatformsValue(int index)

Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

repeated .google.cloud.websecurityscanner.v1alpha.ScanConfig.TargetPlatform target_platforms = 9;

Parameter

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

Returns

Type	Description
int	The enum numeric value on the wire of targetPlatforms at the given index.

getTargetPlatformsValueList()

public abstract List<Integer> getTargetPlatformsValueList()

Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

repeated .google.cloud.websecurityscanner.v1alpha.ScanConfig.TargetPlatform target_platforms = 9;

Returns

Type	Description
List<Integer>	A list containing the enum numeric values on the wire for targetPlatforms.

getUserAgent()

public abstract ScanConfig.UserAgent getUserAgent()

The user agent used during scanning.

.google.cloud.websecurityscanner.v1alpha.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.v1alpha.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.v1alpha.ScanConfig.Authentication authentication = 5;

Returns

Type	Description
boolean	Whether the authentication field is set.

hasLatestRun()

public abstract boolean hasLatestRun()

Latest ScanRun if available.

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

Returns

Type	Description
boolean	Whether the latestRun field is set.

hasSchedule()

public abstract boolean hasSchedule()

The schedule of the ScanConfig.

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

Returns

Type	Description
boolean	Whether the schedule field is set.