ScanConfig (Web Security Scanner API v1alpha (Rev. 202) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.websecurityscanner.v1alpha.model.ScanConfig

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class ScanConfig
extends com.google.api.client.json.GenericJson
```
A ScanConfig resource contains the configurations to launch a scan. next id: 12
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Web Security Scanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

ScanConfig()

Constructors
Constructor and Description
`ScanConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScanConfig`	`clone()`
`Authentication`	`getAuthentication()` The authentication configuration.
`java.util.List<java.lang.String>`	`getBlacklistPatterns()` The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs /excluded-urls
`java.lang.String`	`getDisplayName()` Required.
`ScanRun`	`getLatestRun()` Latest ScanRun if available.
`java.lang.Integer`	`getMaxQps()` The maximum QPS during scanning.
`java.lang.String`	`getName()` The resource name of the ScanConfig.
`Schedule`	`getSchedule()` The schedule of the ScanConfig.
`java.util.List<java.lang.String>`	`getStartingUrls()` Required.
`java.util.List<java.lang.String>`	`getTargetPlatforms()` Set of Cloud Platforms targeted by the scan.
`java.lang.String`	`getUserAgent()` The user agent used during scanning.
`ScanConfig`	`set(java.lang.String fieldName, java.lang.Object value)`
`ScanConfig`	`setAuthentication(Authentication authentication)` The authentication configuration.
`ScanConfig`	`setBlacklistPatterns(java.util.List<java.lang.String> blacklistPatterns)` The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs /excluded-urls
`ScanConfig`	`setDisplayName(java.lang.String displayName)` Required.
`ScanConfig`	`setLatestRun(ScanRun latestRun)` Latest ScanRun if available.
`ScanConfig`	`setMaxQps(java.lang.Integer maxQps)` The maximum QPS during scanning.
`ScanConfig`	`setName(java.lang.String name)` The resource name of the ScanConfig.
`ScanConfig`	`setSchedule(Schedule schedule)` The schedule of the ScanConfig.
`ScanConfig`	`setStartingUrls(java.util.List<java.lang.String> startingUrls)` Required.
`ScanConfig`	`setTargetPlatforms(java.util.List<java.lang.String> targetPlatforms)` Set of Cloud Platforms targeted by the scan.
`ScanConfig`	`setUserAgent(java.lang.String userAgent)` The user agent used during scanning.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - ScanConfig
```
public ScanConfig()
```
- Method Detail
  - getAuthentication
```
public Authentication getAuthentication()
```
    The authentication configuration. If specified, service will use the authentication configuration during scanning.
    
    Returns:
    
    value or null for none
  - setAuthentication
```
public ScanConfig setAuthentication(Authentication authentication)
```
    The authentication configuration. If specified, service will use the authentication configuration during scanning.
    
    Parameters:
    
    authentication - authentication or null for none
  - getBlacklistPatterns
```
public java.util.List<java.lang.String> getBlacklistPatterns()
```
    The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs /excluded-urls
    
    Returns:
    
    value or null for none
  - setBlacklistPatterns
```
public ScanConfig setBlacklistPatterns(java.util.List<java.lang.String> blacklistPatterns)
```
    The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs /excluded-urls
    
    Parameters:
    
    blacklistPatterns - blacklistPatterns or null for none
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Required. The user provided display name of the ScanConfig.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public ScanConfig setDisplayName(java.lang.String displayName)
```
    Required. The user provided display name of the ScanConfig.
    
    Parameters:
    
    displayName - displayName or null for none
  - getLatestRun
```
public ScanRun getLatestRun()
```
    Latest ScanRun if available.
    
    Returns:
    
    value or null for none
  - setLatestRun
```
public ScanConfig setLatestRun(ScanRun latestRun)
```
    Latest ScanRun if available.
    
    Parameters:
    
    latestRun - latestRun or null for none
  - getMaxQps
```
public java.lang.Integer 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.
    
    Returns:
    
    value or null for none
  - setMaxQps
```
public ScanConfig setMaxQps(java.lang.Integer maxQps)
```
    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.
    
    Parameters:
    
    maxQps - maxQps or null for none
  - getName
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setName
```
public ScanConfig setName(java.lang.String name)
```
    The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
    
    Parameters:
    
    name - name or null for none
  - getSchedule
```
public Schedule getSchedule()
```
    The schedule of the ScanConfig.
    
    Returns:
    
    value or null for none
  - setSchedule
```
public ScanConfig setSchedule(Schedule schedule)
```
    The schedule of the ScanConfig.
    
    Parameters:
    
    schedule - schedule or null for none
  - getStartingUrls
```
public java.util.List<java.lang.String> getStartingUrls()
```
    Required. The starting URLs from which the scanner finds site pages.
    
    Returns:
    
    value or null for none
  - setStartingUrls
```
public ScanConfig setStartingUrls(java.util.List<java.lang.String> startingUrls)
```
    Required. The starting URLs from which the scanner finds site pages.
    
    Parameters:
    
    startingUrls - startingUrls or null for none
  - getTargetPlatforms
```
public java.util.List<java.lang.String> getTargetPlatforms()
```
    Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
    
    Returns:
    
    value or null for none
  - setTargetPlatforms
```
public ScanConfig setTargetPlatforms(java.util.List<java.lang.String> targetPlatforms)
```
    Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
    
    Parameters:
    
    targetPlatforms - targetPlatforms or null for none
  - getUserAgent
```
public java.lang.String getUserAgent()
```
    The user agent used during scanning.
    
    Returns:
    
    value or null for none
  - setUserAgent
```
public ScanConfig setUserAgent(java.lang.String userAgent)
```
    The user agent used during scanning.
    
    Parameters:
    
    userAgent - userAgent or null for none
  - set
```
public ScanConfig set(java.lang.String fieldName,
                      java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public ScanConfig clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Web Security Scanner API v1alpha (revision 202)

Class ScanConfig

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ScanConfig

Method Detail

getAuthentication

setAuthentication

getBlacklistPatterns

setBlacklistPatterns

getDisplayName

setDisplayName

getLatestRun

setLatestRun

getMaxQps

setMaxQps

getName

setName

getSchedule

setSchedule

getStartingUrls

setStartingUrls

getTargetPlatforms

setTargetPlatforms

getUserAgent

setUserAgent

set

clone