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
Modifier and Type | Class and Description |
---|---|
static class |
ScanConfig.Authentication
Scan authentication configuration.
|
static interface |
ScanConfig.AuthenticationOrBuilder |
static class |
ScanConfig.Builder
A ScanConfig resource contains the configurations to launch a scan.
|
static class |
ScanConfig.ExportToSecurityCommandCenter
Controls export of scan configurations and results to Security
Command Center.
|
static class |
ScanConfig.RiskLevel
Scan risk levels supported by Web Security Scanner.
|
static class |
ScanConfig.Schedule
Scan schedule configuration.
|
static interface |
ScanConfig.ScheduleOrBuilder |
static class |
ScanConfig.UserAgent
Type of user agents used for scanning.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
AUTHENTICATION_FIELD_NUMBER |
static int |
BLACKLIST_PATTERNS_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
EXPORT_TO_SECURITY_COMMAND_CENTER_FIELD_NUMBER |
static int |
IGNORE_HTTP_STATUS_ERRORS_FIELD_NUMBER |
static int |
MANAGED_SCAN_FIELD_NUMBER |
static int |
MAX_QPS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
RISK_LEVEL_FIELD_NUMBER |
static int |
SCHEDULE_FIELD_NUMBER |
static int |
STARTING_URLS_FIELD_NUMBER |
static int |
STATIC_IP_SCAN_FIELD_NUMBER |
static int |
USER_AGENT_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
ScanConfig.Authentication |
getAuthentication()
The authentication configuration.
|
ScanConfig.AuthenticationOrBuilder |
getAuthenticationOrBuilder()
The authentication configuration.
|
String |
getBlacklistPatterns(int index)
The excluded URL patterns as described in
https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
|
ByteString |
getBlacklistPatternsBytes(int index)
The excluded URL patterns as described in
https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
|
int |
getBlacklistPatternsCount()
The excluded URL patterns as described in
https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
|
ProtocolStringList |
getBlacklistPatternsList()
The excluded URL patterns as described in
https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
|
static ScanConfig |
getDefaultInstance() |
ScanConfig |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
ByteString |
getDisplayNameBytes()
Required.
|
ScanConfig.ExportToSecurityCommandCenter |
getExportToSecurityCommandCenter()
Controls export of scan configurations and results to Security
Command Center.
|
int |
getExportToSecurityCommandCenterValue()
Controls export of scan configurations and results to Security
Command Center.
|
boolean |
getIgnoreHttpStatusErrors()
Whether to keep scanning even if most requests return HTTP error codes.
|
boolean |
getManagedScan()
Whether the scan config is managed by Web Security Scanner, output
only.
|
int |
getMaxQps()
The maximum QPS during scanning.
|
String |
getName()
The resource name of the ScanConfig.
|
ByteString |
getNameBytes()
The resource name of the ScanConfig.
|
Parser<ScanConfig> |
getParserForType() |
ScanConfig.RiskLevel |
getRiskLevel()
The risk level selected for the scan
|
int |
getRiskLevelValue()
The risk level selected for the scan
|
ScanConfig.Schedule |
getSchedule()
The schedule of the ScanConfig.
|
ScanConfig.ScheduleOrBuilder |
getScheduleOrBuilder()
The schedule of the ScanConfig.
|
int |
getSerializedSize() |
String |
getStartingUrls(int index)
Required.
|
ByteString |
getStartingUrlsBytes(int index)
Required.
|
int |
getStartingUrlsCount()
Required.
|
ProtocolStringList |
getStartingUrlsList()
Required.
|
boolean |
getStaticIpScan()
Whether the scan configuration has enabled static IP address scan feature.
|
UnknownFieldSet |
getUnknownFields() |
ScanConfig.UserAgent |
getUserAgent()
The user agent used during scanning.
|
int |
getUserAgentValue()
The user agent used during scanning.
|
boolean |
hasAuthentication()
The authentication configuration.
|
int |
hashCode() |
boolean |
hasSchedule()
The schedule of the ScanConfig.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ScanConfig.Builder |
newBuilder() |
static ScanConfig.Builder |
newBuilder(ScanConfig prototype) |
ScanConfig.Builder |
newBuilderForType() |
protected ScanConfig.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) |
static ScanConfig |
parseDelimitedFrom(InputStream input) |
static ScanConfig |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static ScanConfig |
parseFrom(byte[] data) |
static ScanConfig |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static ScanConfig |
parseFrom(ByteBuffer data) |
static ScanConfig |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static ScanConfig |
parseFrom(ByteString data) |
static ScanConfig |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static ScanConfig |
parseFrom(CodedInputStream input) |
static ScanConfig |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static ScanConfig |
parseFrom(InputStream input) |
static ScanConfig |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<ScanConfig> |
parser() |
ScanConfig.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int MAX_QPS_FIELD_NUMBER
public static final int STARTING_URLS_FIELD_NUMBER
public static final int AUTHENTICATION_FIELD_NUMBER
public static final int USER_AGENT_FIELD_NUMBER
public static final int BLACKLIST_PATTERNS_FIELD_NUMBER
public static final int SCHEDULE_FIELD_NUMBER
public static final int EXPORT_TO_SECURITY_COMMAND_CENTER_FIELD_NUMBER
public static final int RISK_LEVEL_FIELD_NUMBER
public static final int MANAGED_SCAN_FIELD_NUMBER
public static final int STATIC_IP_SCAN_FIELD_NUMBER
public static final int IGNORE_HTTP_STATUS_ERRORS_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public 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;
getName
in interface ScanConfigOrBuilder
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;
getNameBytes
in interface ScanConfigOrBuilder
public String getDisplayName()
Required. The user provided display name of the ScanConfig.
string display_name = 2;
getDisplayName
in interface ScanConfigOrBuilder
public ByteString getDisplayNameBytes()
Required. The user provided display name of the ScanConfig.
string display_name = 2;
getDisplayNameBytes
in interface ScanConfigOrBuilder
public 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;
getMaxQps
in interface ScanConfigOrBuilder
public ProtocolStringList getStartingUrlsList()
Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4;
getStartingUrlsList
in interface ScanConfigOrBuilder
public int getStartingUrlsCount()
Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4;
getStartingUrlsCount
in interface ScanConfigOrBuilder
public String getStartingUrls(int index)
Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4;
getStartingUrls
in interface ScanConfigOrBuilder
index
- The index of the element to return.public ByteString getStartingUrlsBytes(int index)
Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4;
getStartingUrlsBytes
in interface ScanConfigOrBuilder
index
- The index of the value to return.public boolean hasAuthentication()
The authentication configuration. If specified, service will use the authentication configuration during scanning.
.google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;
hasAuthentication
in interface ScanConfigOrBuilder
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;
getAuthentication
in interface ScanConfigOrBuilder
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;
getAuthenticationOrBuilder
in interface ScanConfigOrBuilder
public int getUserAgentValue()
The user agent used during scanning.
.google.cloud.websecurityscanner.v1.ScanConfig.UserAgent user_agent = 6;
getUserAgentValue
in interface ScanConfigOrBuilder
public ScanConfig.UserAgent getUserAgent()
The user agent used during scanning.
.google.cloud.websecurityscanner.v1.ScanConfig.UserAgent user_agent = 6;
getUserAgent
in interface ScanConfigOrBuilder
public ProtocolStringList getBlacklistPatternsList()
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
repeated string blacklist_patterns = 7;
getBlacklistPatternsList
in interface ScanConfigOrBuilder
public int getBlacklistPatternsCount()
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
repeated string blacklist_patterns = 7;
getBlacklistPatternsCount
in interface ScanConfigOrBuilder
public String getBlacklistPatterns(int index)
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
repeated string blacklist_patterns = 7;
getBlacklistPatterns
in interface ScanConfigOrBuilder
index
- The index of the element to return.public ByteString getBlacklistPatternsBytes(int index)
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
repeated string blacklist_patterns = 7;
getBlacklistPatternsBytes
in interface ScanConfigOrBuilder
index
- The index of the value to return.public boolean hasSchedule()
The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;
hasSchedule
in interface ScanConfigOrBuilder
public ScanConfig.Schedule getSchedule()
The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;
getSchedule
in interface ScanConfigOrBuilder
public ScanConfig.ScheduleOrBuilder getScheduleOrBuilder()
The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;
getScheduleOrBuilder
in interface ScanConfigOrBuilder
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;
getExportToSecurityCommandCenterValue
in interface ScanConfigOrBuilder
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;
getExportToSecurityCommandCenter
in interface ScanConfigOrBuilder
public int getRiskLevelValue()
The risk level selected for the scan
.google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel risk_level = 12;
getRiskLevelValue
in interface ScanConfigOrBuilder
public ScanConfig.RiskLevel getRiskLevel()
The risk level selected for the scan
.google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel risk_level = 12;
getRiskLevel
in interface ScanConfigOrBuilder
public boolean getManagedScan()
Whether the scan config is managed by Web Security Scanner, output only.
bool managed_scan = 13;
getManagedScan
in interface ScanConfigOrBuilder
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;
getStaticIpScan
in interface ScanConfigOrBuilder
public boolean getIgnoreHttpStatusErrors()
Whether to keep scanning even if most requests return HTTP error codes.
bool ignore_http_status_errors = 15;
getIgnoreHttpStatusErrors
in interface ScanConfigOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static ScanConfig parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ScanConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ScanConfig parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ScanConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ScanConfig parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ScanConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ScanConfig parseFrom(InputStream input) throws IOException
IOException
public static ScanConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ScanConfig parseDelimitedFrom(InputStream input) throws IOException
IOException
public static ScanConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ScanConfig parseFrom(CodedInputStream input) throws IOException
IOException
public static ScanConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public ScanConfig.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static ScanConfig.Builder newBuilder()
public static ScanConfig.Builder newBuilder(ScanConfig prototype)
public ScanConfig.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected ScanConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static ScanConfig getDefaultInstance()
public static Parser<ScanConfig> parser()
public Parser<ScanConfig> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public ScanConfig getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.