ScanConfigOrBuilder (Google Cloud Web Security Scanner Parent 2.3.0 API)

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

ScanConfig, ScanConfig.Builder
```
public interface ScanConfigOrBuilder
extends MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ScanConfig.Authentication`	`getAuthentication()` The authentication configuration.
`ScanConfig.AuthenticationOrBuilder`	`getAuthenticationOrBuilder()` The authentication configuration.
`String`	`getBlacklistPatterns(int index)` The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
`ByteString`	`getBlacklistPatternsBytes(int index)` The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
`int`	`getBlacklistPatternsCount()` The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
`List<String>`	`getBlacklistPatternsList()` The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
`String`	`getDisplayName()` Required.
`ByteString`	`getDisplayNameBytes()` Required.
`ScanRun`	`getLatestRun()` Latest ScanRun if available.
`ScanRunOrBuilder`	`getLatestRunOrBuilder()` Latest ScanRun if available.
`int`	`getMaxQps()` The maximum QPS during scanning.
`String`	`getName()` The resource name of the ScanConfig.
`ByteString`	`getNameBytes()` The resource name of the ScanConfig.
`ScanConfig.Schedule`	`getSchedule()` The schedule of the ScanConfig.
`ScanConfig.ScheduleOrBuilder`	`getScheduleOrBuilder()` The schedule of the ScanConfig.
`String`	`getStartingUrls(int index)` Required.
`ByteString`	`getStartingUrlsBytes(int index)` Required.
`int`	`getStartingUrlsCount()` Required.
`List<String>`	`getStartingUrlsList()` Required.
`ScanConfig.TargetPlatform`	`getTargetPlatforms(int index)` Set of Cloud Platforms targeted by the scan.
`int`	`getTargetPlatformsCount()` Set of Cloud Platforms targeted by the scan.
`List<ScanConfig.TargetPlatform>`	`getTargetPlatformsList()` Set of Cloud Platforms targeted by the scan.
`int`	`getTargetPlatformsValue(int index)` Set of Cloud Platforms targeted by the scan.
`List<Integer>`	`getTargetPlatformsValueList()` Set of Cloud Platforms targeted by the scan.
`ScanConfig.UserAgent`	`getUserAgent()` The user agent used during scanning.
`int`	`getUserAgentValue()` The user agent used during scanning.
`boolean`	`hasAuthentication()` The authentication configuration.
`boolean`	`hasLatestRun()` Latest ScanRun if available.
`boolean`	`hasSchedule()` The schedule of the ScanConfig.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

- Method Detail
  - getName
```
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:
    
    The name.
  - getNameBytes
```
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:
    
    The bytes for name.
  - getDisplayName
```
String getDisplayName()
```
```
 Required. The user provided display name of the ScanConfig.
 
```
    string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    The displayName.
  - getDisplayNameBytes
```
ByteString getDisplayNameBytes()
```
```
 Required. The user provided display name of the ScanConfig.
 
```
    string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    The bytes for displayName.
  - getMaxQps
```
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:
    
    The maxQps.
  - getStartingUrlsList
```
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:
    
    A list containing the startingUrls.
  - getStartingUrlsCount
```
int getStartingUrlsCount()
```
```
 Required. The starting URLs from which the scanner finds site pages.
 
```
    repeated string starting_urls = 4 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    The count of startingUrls.
  - getStartingUrls
```
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];
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The startingUrls at the given index.
  - getStartingUrlsBytes
```
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];
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the startingUrls at the given index.
  - hasAuthentication
```
boolean hasAuthentication()
```
```
 The authentication configuration. If specified, service will use the
 authentication configuration during scanning.
 
```
    .google.cloud.websecurityscanner.v1alpha.ScanConfig.Authentication authentication = 5;
    Returns:
    
    Whether the authentication field is set.
  - getAuthentication
```
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:
    
    The authentication.
  - getAuthenticationOrBuilder
```
ScanConfig.AuthenticationOrBuilder getAuthenticationOrBuilder()
```
```
 The authentication configuration. If specified, service will use the
 authentication configuration during scanning.
 
```
    .google.cloud.websecurityscanner.v1alpha.ScanConfig.Authentication authentication = 5;
  - getUserAgentValue
```
int getUserAgentValue()
```
```
 The user agent used during scanning.
 
```
    .google.cloud.websecurityscanner.v1alpha.ScanConfig.UserAgent user_agent = 6;
    Returns:
    
    The enum numeric value on the wire for userAgent.
  - getUserAgent
```
ScanConfig.UserAgent getUserAgent()
```
```
 The user agent used during scanning.
 
```
    .google.cloud.websecurityscanner.v1alpha.ScanConfig.UserAgent user_agent = 6;
    Returns:
    
    The userAgent.
  - getBlacklistPatternsList
```
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:
    
    A list containing the blacklistPatterns.
  - getBlacklistPatternsCount
```
int getBlacklistPatternsCount()
```
```
 The blacklist URL patterns as described in
 https://cloud.google.com/security-scanner/docs/excluded-urls
 
```
    repeated string blacklist_patterns = 7;
    Returns:
    
    The count of blacklistPatterns.
  - getBlacklistPatterns
```
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;
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The blacklistPatterns at the given index.
  - getBlacklistPatternsBytes
```
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;
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the blacklistPatterns at the given index.
  - hasSchedule
```
boolean hasSchedule()
```
```
 The schedule of the ScanConfig.
 
```
    .google.cloud.websecurityscanner.v1alpha.ScanConfig.Schedule schedule = 8;
    Returns:
    
    Whether the schedule field is set.
  - getSchedule
```
ScanConfig.Schedule getSchedule()
```
```
 The schedule of the ScanConfig.
 
```
    .google.cloud.websecurityscanner.v1alpha.ScanConfig.Schedule schedule = 8;
    Returns:
    
    The schedule.
  - getScheduleOrBuilder
```
ScanConfig.ScheduleOrBuilder getScheduleOrBuilder()
```
```
 The schedule of the ScanConfig.
 
```
    .google.cloud.websecurityscanner.v1alpha.ScanConfig.Schedule schedule = 8;
  - getTargetPlatformsList
```
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:
    
    A list containing the targetPlatforms.
  - getTargetPlatformsCount
```
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:
    
    The count of targetPlatforms.
  - getTargetPlatforms
```
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;
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The targetPlatforms at the given index.
  - getTargetPlatformsValueList
```
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:
    
    A list containing the enum numeric values on the wire for targetPlatforms.
  - getTargetPlatformsValue
```
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;
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The enum numeric value on the wire of targetPlatforms at the given index.
  - hasLatestRun
```
boolean hasLatestRun()
```
```
 Latest ScanRun if available.
 
```
    .google.cloud.websecurityscanner.v1alpha.ScanRun latest_run = 11;
    Returns:
    
    Whether the latestRun field is set.
  - getLatestRun
```
ScanRun getLatestRun()
```
```
 Latest ScanRun if available.
 
```
    .google.cloud.websecurityscanner.v1alpha.ScanRun latest_run = 11;
    Returns:
    
    The latestRun.
  - getLatestRunOrBuilder
```
ScanRunOrBuilder getLatestRunOrBuilder()
```
```
 Latest ScanRun if available.
 
```
    .google.cloud.websecurityscanner.v1alpha.ScanRun latest_run = 11;

Interface ScanConfigOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Method Detail

getName

getNameBytes

getDisplayName

getDisplayNameBytes

getMaxQps

getStartingUrlsList

getStartingUrlsCount

getStartingUrls

getStartingUrlsBytes

hasAuthentication

getAuthentication

getAuthenticationOrBuilder

getUserAgentValue

getUserAgent

getBlacklistPatternsList

getBlacklistPatternsCount

getBlacklistPatterns

getBlacklistPatternsBytes

hasSchedule

getSchedule

getScheduleOrBuilder

getTargetPlatformsList

getTargetPlatformsCount

getTargetPlatforms

getTargetPlatformsValueList

getTargetPlatformsValue

hasLatestRun

getLatestRun

getLatestRunOrBuilder