public final class ScanConfig extends com.google.protobuf.GeneratedMessageV3 implements ScanConfigOrBuilder
A ScanConfig resource contains the configurations to launch a scan.Protobuf type
google.cloud.websecurityscanner.v1beta.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 Cloud Security
Command Center.
|
static class |
ScanConfig.RiskLevel
Scan risk levels supported by Cloud Web Security Scanner.
|
static class |
ScanConfig.Schedule
Scan schedule configuration.
|
static interface |
ScanConfig.ScheduleOrBuilder |
static class |
ScanConfig.TargetPlatform
Cloud platforms supported by Cloud Web Security Scanner.
|
static class |
ScanConfig.UserAgent
Type of user agents used for scanning.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable| 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 |
LATEST_RUN_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 |
TARGET_PLATFORMS_FIELD_NUMBER |
static int |
USER_AGENT_FIELD_NUMBER |
| 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 blacklist URL patterns as described in
https://cloud.google.com/security-scanner/docs/excluded-urls
|
com.google.protobuf.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
|
com.google.protobuf.ProtocolStringList |
getBlacklistPatternsList()
The blacklist URL patterns as described in
https://cloud.google.com/security-scanner/docs/excluded-urls
|
static ScanConfig |
getDefaultInstance() |
ScanConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
ScanConfig.ExportToSecurityCommandCenter |
getExportToSecurityCommandCenter()
Controls export of scan configurations and results to Cloud Security
Command Center.
|
int |
getExportToSecurityCommandCenterValue()
Controls export of scan configurations and results to Cloud Security
Command Center.
|
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.
|
com.google.protobuf.ByteString |
getNameBytes()
The resource name of the ScanConfig.
|
com.google.protobuf.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.
|
com.google.protobuf.ByteString |
getStartingUrlsBytes(int index)
Required.
|
int |
getStartingUrlsCount()
Required.
|
com.google.protobuf.ProtocolStringList |
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.
|
com.google.protobuf.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 |
hasLatestRun()
Latest ScanRun if available.
|
boolean |
hasSchedule()
The schedule of the ScanConfig.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ScanConfig.Builder |
newBuilder() |
static ScanConfig.Builder |
newBuilder(ScanConfig prototype) |
ScanConfig.Builder |
newBuilderForType() |
protected ScanConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static ScanConfig |
parseDelimitedFrom(InputStream input) |
static ScanConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ScanConfig |
parseFrom(byte[] data) |
static ScanConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ScanConfig |
parseFrom(ByteBuffer data) |
static ScanConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ScanConfig |
parseFrom(com.google.protobuf.ByteString data) |
static ScanConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ScanConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ScanConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ScanConfig |
parseFrom(InputStream input) |
static ScanConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ScanConfig> |
parser() |
ScanConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic 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 TARGET_PLATFORMS_FIELD_NUMBER
public static final int EXPORT_TO_SECURITY_COMMAND_CENTER_FIELD_NUMBER
public static final int LATEST_RUN_FIELD_NUMBER
public static final int RISK_LEVEL_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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 ScanConfigOrBuilderpublic com.google.protobuf.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 ScanConfigOrBuilderpublic String getDisplayName()
Required. The user provided display name of the ScanConfig.
string display_name = 2;getDisplayName in interface ScanConfigOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Required. The user provided display name of the ScanConfig.
string display_name = 2;getDisplayNameBytes in interface ScanConfigOrBuilderpublic 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 ScanConfigOrBuilderpublic com.google.protobuf.ProtocolStringList getStartingUrlsList()
Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4;getStartingUrlsList in interface ScanConfigOrBuilderpublic int getStartingUrlsCount()
Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4;getStartingUrlsCount in interface ScanConfigOrBuilderpublic String getStartingUrls(int index)
Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4;getStartingUrls in interface ScanConfigOrBuilderpublic com.google.protobuf.ByteString getStartingUrlsBytes(int index)
Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4;getStartingUrlsBytes in interface ScanConfigOrBuilderpublic boolean hasAuthentication()
The authentication configuration. If specified, service will use the authentication configuration during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication authentication = 5;
hasAuthentication in interface ScanConfigOrBuilderpublic ScanConfig.Authentication getAuthentication()
The authentication configuration. If specified, service will use the authentication configuration during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication authentication = 5;
getAuthentication in interface ScanConfigOrBuilderpublic ScanConfig.AuthenticationOrBuilder getAuthenticationOrBuilder()
The authentication configuration. If specified, service will use the authentication configuration during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication authentication = 5;
getAuthenticationOrBuilder in interface ScanConfigOrBuilderpublic int getUserAgentValue()
The user agent used during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.UserAgent user_agent = 6;getUserAgentValue in interface ScanConfigOrBuilderpublic ScanConfig.UserAgent getUserAgent()
The user agent used during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.UserAgent user_agent = 6;getUserAgent in interface ScanConfigOrBuilderpublic com.google.protobuf.ProtocolStringList getBlacklistPatternsList()
The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
repeated string blacklist_patterns = 7;getBlacklistPatternsList in interface ScanConfigOrBuilderpublic int getBlacklistPatternsCount()
The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
repeated string blacklist_patterns = 7;getBlacklistPatternsCount in interface ScanConfigOrBuilderpublic 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;getBlacklistPatterns in interface ScanConfigOrBuilderpublic com.google.protobuf.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;getBlacklistPatternsBytes in interface ScanConfigOrBuilderpublic boolean hasSchedule()
The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule schedule = 8;hasSchedule in interface ScanConfigOrBuilderpublic ScanConfig.Schedule getSchedule()
The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule schedule = 8;getSchedule in interface ScanConfigOrBuilderpublic ScanConfig.ScheduleOrBuilder getScheduleOrBuilder()
The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule schedule = 8;getScheduleOrBuilder in interface ScanConfigOrBuilderpublic 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.v1beta.ScanConfig.TargetPlatform target_platforms = 9;
getTargetPlatformsList in interface ScanConfigOrBuilderpublic int getTargetPlatformsCount()
Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
repeated .google.cloud.websecurityscanner.v1beta.ScanConfig.TargetPlatform target_platforms = 9;
getTargetPlatformsCount in interface ScanConfigOrBuilderpublic 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.v1beta.ScanConfig.TargetPlatform target_platforms = 9;
getTargetPlatforms in interface ScanConfigOrBuilderpublic 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.v1beta.ScanConfig.TargetPlatform target_platforms = 9;
getTargetPlatformsValueList in interface ScanConfigOrBuilderpublic 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.v1beta.ScanConfig.TargetPlatform target_platforms = 9;
getTargetPlatformsValue in interface ScanConfigOrBuilderpublic int getExportToSecurityCommandCenterValue()
Controls export of scan configurations and results to Cloud Security Command Center.
.google.cloud.websecurityscanner.v1beta.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;
getExportToSecurityCommandCenterValue in interface ScanConfigOrBuilderpublic ScanConfig.ExportToSecurityCommandCenter getExportToSecurityCommandCenter()
Controls export of scan configurations and results to Cloud Security Command Center.
.google.cloud.websecurityscanner.v1beta.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;
getExportToSecurityCommandCenter in interface ScanConfigOrBuilderpublic boolean hasLatestRun()
Latest ScanRun if available.
.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;hasLatestRun in interface ScanConfigOrBuilderpublic ScanRun getLatestRun()
Latest ScanRun if available.
.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;getLatestRun in interface ScanConfigOrBuilderpublic ScanRunOrBuilder getLatestRunOrBuilder()
Latest ScanRun if available.
.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;getLatestRunOrBuilder in interface ScanConfigOrBuilderpublic int getRiskLevelValue()
The risk level selected for the scan
.google.cloud.websecurityscanner.v1beta.ScanConfig.RiskLevel risk_level = 12;getRiskLevelValue in interface ScanConfigOrBuilderpublic ScanConfig.RiskLevel getRiskLevel()
The risk level selected for the scan
.google.cloud.websecurityscanner.v1beta.ScanConfig.RiskLevel risk_level = 12;getRiskLevel in interface ScanConfigOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ScanConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScanConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScanConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScanConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScanConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScanConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScanConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static ScanConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ScanConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ScanConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ScanConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ScanConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ScanConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ScanConfig.Builder newBuilder()
public static ScanConfig.Builder newBuilder(ScanConfig prototype)
public ScanConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ScanConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ScanConfig getDefaultInstance()
public static com.google.protobuf.Parser<ScanConfig> parser()
public com.google.protobuf.Parser<ScanConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ScanConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2019 Google LLC. All rights reserved.