public final class ScanConfig extends GeneratedMessageV3 implements ScanConfigOrBuilder
A ScanConfig resource contains the configurations to launch a scan.
Protobuf type google.cloud.websecurityscanner.v1.ScanConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
AUTHENTICATION_FIELD_NUMBER
public static final int AUTHENTICATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
BLACKLIST_PATTERNS_FIELD_NUMBER
public static final int BLACKLIST_PATTERNS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXPORT_TO_SECURITY_COMMAND_CENTER_FIELD_NUMBER
public static final int EXPORT_TO_SECURITY_COMMAND_CENTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IGNORE_HTTP_STATUS_ERRORS_FIELD_NUMBER
public static final int IGNORE_HTTP_STATUS_ERRORS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MANAGED_SCAN_FIELD_NUMBER
public static final int MANAGED_SCAN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MAX_QPS_FIELD_NUMBER
public static final int MAX_QPS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RISK_LEVEL_FIELD_NUMBER
public static final int RISK_LEVEL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SCHEDULE_FIELD_NUMBER
public static final int SCHEDULE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STARTING_URLS_FIELD_NUMBER
public static final int STARTING_URLS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATIC_IP_SCAN_FIELD_NUMBER
public static final int STATIC_IP_SCAN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_AGENT_FIELD_NUMBER
public static final int USER_AGENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ScanConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ScanConfig.Builder newBuilder()
newBuilder(ScanConfig prototype)
public static ScanConfig.Builder newBuilder(ScanConfig prototype)
public static ScanConfig parseDelimitedFrom(InputStream input)
public static ScanConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ScanConfig parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ScanConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ScanConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ScanConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ScanConfig parseFrom(CodedInputStream input)
public static ScanConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ScanConfig parseFrom(InputStream input)
public static ScanConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ScanConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ScanConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ScanConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAuthentication()
public ScanConfig.Authentication getAuthentication()
The authentication configuration. If specified, service will use the
authentication configuration during scanning.
.google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;
getAuthenticationOrBuilder()
public ScanConfig.AuthenticationOrBuilder getAuthenticationOrBuilder()
The authentication configuration. If specified, service will use the
authentication configuration during scanning.
.google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;
getBlacklistPatterns(int index)
public String getBlacklistPatterns(int index)
| 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 ByteString getBlacklistPatternsBytes(int index)
| 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 int getBlacklistPatternsCount()
| Returns |
|---|
| Type | Description |
int | The count of blacklistPatterns.
|
getBlacklistPatternsList()
public ProtocolStringList getBlacklistPatternsList()
getDefaultInstanceForType()
public ScanConfig getDefaultInstanceForType()
getDisplayName()
public String getDisplayName()
Required. The user provided display name of the ScanConfig.
string display_name = 2;
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public 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 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;
getExportToSecurityCommandCenterValue()
public 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 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 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()
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()
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 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.
|
getParserForType()
public Parser<ScanConfig> getParserForType()
Overrides
getRiskLevel()
public ScanConfig.RiskLevel getRiskLevel()
The risk level selected for the scan
.google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel risk_level = 12;
getRiskLevelValue()
public 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 ScanConfig.Schedule getSchedule()
The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;
getScheduleOrBuilder()
public ScanConfig.ScheduleOrBuilder getScheduleOrBuilder()
The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getStartingUrls(int index)
public 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 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 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 ProtocolStringList getStartingUrlsList()
Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4;
getStaticIpScan()
public 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 ScanConfig.UserAgent getUserAgent()
The user agent used during scanning.
.google.cloud.websecurityscanner.v1.ScanConfig.UserAgent user_agent = 6;
getUserAgentValue()
public 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 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 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ScanConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ScanConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ScanConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
