- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.4
- 2.1.1
- 2.0.15
public static final class ScanConfig.Builder extends GeneratedMessageV3.Builder<ScanConfig.Builder> implements ScanConfigOrBuilderA ScanConfig resource contains the configurations to launch a scan.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ScanConfig.BuilderImplements
ScanConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllBlacklistPatterns(Iterable<String> values)
public ScanConfig.Builder addAllBlacklistPatterns(Iterable<String> values)The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
repeated string blacklist_patterns = 7;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The blacklistPatterns to add. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
addAllStartingUrls(Iterable<String> values)
public ScanConfig.Builder addAllStartingUrls(Iterable<String> values)Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The startingUrls to add. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
addAllTargetPlatforms(Iterable<? extends ScanConfig.TargetPlatform> values)
public ScanConfig.Builder addAllTargetPlatforms(Iterable<? extends ScanConfig.TargetPlatform> values)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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.websecurityscanner.v1beta.ScanConfig.TargetPlatform>The targetPlatforms to add. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
addAllTargetPlatformsValue(Iterable<Integer> values)
public ScanConfig.Builder addAllTargetPlatformsValue(Iterable<Integer> values)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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<Integer>The enum numeric values on the wire for targetPlatforms to add. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
addBlacklistPatterns(String value)
public ScanConfig.Builder addBlacklistPatterns(String value)The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
repeated string blacklist_patterns = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe blacklistPatterns to add. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
addBlacklistPatternsBytes(ByteString value)
public ScanConfig.Builder addBlacklistPatternsBytes(ByteString value)The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
repeated string blacklist_patterns = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the blacklistPatterns to add. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ScanConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
addStartingUrls(String value)
public ScanConfig.Builder addStartingUrls(String value)Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe startingUrls to add. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
addStartingUrlsBytes(ByteString value)
public ScanConfig.Builder addStartingUrlsBytes(ByteString value)Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the startingUrls to add. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
addTargetPlatforms(ScanConfig.TargetPlatform value)
public ScanConfig.Builder addTargetPlatforms(ScanConfig.TargetPlatform value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ScanConfig.TargetPlatformThe targetPlatforms to add. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
addTargetPlatformsValue(int value)
public ScanConfig.Builder addTargetPlatformsValue(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for targetPlatforms to add. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
build()
public ScanConfig build()| Returns | |
|---|---|
| Type | Description |
ScanConfig |
|
buildPartial()
public ScanConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
ScanConfig |
|
clear()
public ScanConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
clearAuthentication()
public ScanConfig.Builder clearAuthentication()The authentication configuration. If specified, service will use the authentication configuration during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication authentication = 5;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
clearBlacklistPatterns()
public ScanConfig.Builder clearBlacklistPatterns()The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
repeated string blacklist_patterns = 7;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
clearDisplayName()
public ScanConfig.Builder clearDisplayName()Required. The user provided display name of the ScanConfig.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
clearExportToSecurityCommandCenter()
public ScanConfig.Builder clearExportToSecurityCommandCenter()Controls export of scan configurations and results to Cloud Security Command Center.
.google.cloud.websecurityscanner.v1beta.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ScanConfig.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
clearLatestRun()
public ScanConfig.Builder clearLatestRun()Latest ScanRun if available.
.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
clearMaxQps()
public ScanConfig.Builder clearMaxQps()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 |
ScanConfig.Builder |
This builder for chaining. |
clearName()
public ScanConfig.Builder clearName()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 |
ScanConfig.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ScanConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
clearRiskLevel()
public ScanConfig.Builder clearRiskLevel()The risk level selected for the scan
.google.cloud.websecurityscanner.v1beta.ScanConfig.RiskLevel risk_level = 12;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
clearSchedule()
public ScanConfig.Builder clearSchedule()The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule schedule = 8;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
clearStartingUrls()
public ScanConfig.Builder clearStartingUrls()Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
clearTargetPlatforms()
public ScanConfig.Builder clearTargetPlatforms()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;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
clearUserAgent()
public ScanConfig.Builder clearUserAgent()The user agent used during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.UserAgent user_agent = 6;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
clone()
public ScanConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
getAuthentication()
public ScanConfig.Authentication getAuthentication()The authentication configuration. If specified, service will use the authentication configuration during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication authentication = 5;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Authentication |
The authentication. |
getAuthenticationBuilder()
public ScanConfig.Authentication.Builder getAuthenticationBuilder()The authentication configuration. If specified, service will use the authentication configuration during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication authentication = 5;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Authentication.Builder |
|
getAuthenticationOrBuilder()
public ScanConfig.AuthenticationOrBuilder getAuthenticationOrBuilder()The authentication configuration. If specified, service will use the authentication configuration during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication authentication = 5;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.AuthenticationOrBuilder |
|
getBlacklistPatterns(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The blacklistPatterns at the given index. |
getBlacklistPatternsBytes(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the blacklistPatterns at the given index. |
getBlacklistPatternsCount()
public int getBlacklistPatternsCount()The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
repeated string blacklist_patterns = 7;
| Returns | |
|---|---|
| Type | Description |
int |
The count of blacklistPatterns. |
getBlacklistPatternsList()
public ProtocolStringList getBlacklistPatternsList()The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
repeated string blacklist_patterns = 7;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the blacklistPatterns. |
getDefaultInstanceForType()
public ScanConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ScanConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public String getDisplayName()Required. The user provided display name of the ScanConfig.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Required. The user provided display name of the ScanConfig.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getExportToSecurityCommandCenter()
public 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;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.ExportToSecurityCommandCenter |
The exportToSecurityCommandCenter. |
getExportToSecurityCommandCenterValue()
public 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;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for exportToSecurityCommandCenter. |
getLatestRun()
public ScanRun getLatestRun()Latest ScanRun if available.
.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;
| Returns | |
|---|---|
| Type | Description |
ScanRun |
The latestRun. |
getLatestRunBuilder()
public ScanRun.Builder getLatestRunBuilder()Latest ScanRun if available.
.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;
| Returns | |
|---|---|
| Type | Description |
ScanRun.Builder |
|
getLatestRunOrBuilder()
public ScanRunOrBuilder getLatestRunOrBuilder()Latest ScanRun if available.
.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;
| Returns | |
|---|---|
| Type | Description |
ScanRunOrBuilder |
|
getMaxQps()
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;
| Returns | |
|---|---|
| Type | Description |
int |
The maxQps. |
getName()
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;
| 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. |
getRiskLevel()
public ScanConfig.RiskLevel getRiskLevel()The risk level selected for the scan
.google.cloud.websecurityscanner.v1beta.ScanConfig.RiskLevel risk_level = 12;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.RiskLevel |
The riskLevel. |
getRiskLevelValue()
public int getRiskLevelValue()The risk level selected for the scan
.google.cloud.websecurityscanner.v1beta.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.v1beta.ScanConfig.Schedule schedule = 8;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Schedule |
The schedule. |
getScheduleBuilder()
public ScanConfig.Schedule.Builder getScheduleBuilder()The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule schedule = 8;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Schedule.Builder |
|
getScheduleOrBuilder()
public ScanConfig.ScheduleOrBuilder getScheduleOrBuilder()The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule schedule = 8;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.ScheduleOrBuilder |
|
getStartingUrls(int index)
public 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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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 [(.google.api.field_behavior) = REQUIRED];
| 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 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the startingUrls. |
getTargetPlatforms(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.TargetPlatform |
The targetPlatforms at the given index. |
getTargetPlatformsCount()
public 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;
| Returns | |
|---|---|
| Type | Description |
int |
The count of targetPlatforms. |
getTargetPlatformsList()
public 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;
| Returns | |
|---|---|
| Type | Description |
List<TargetPlatform> |
A list containing the targetPlatforms. |
getTargetPlatformsValue(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of targetPlatforms at the given index. |
getTargetPlatformsValueList()
public 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;
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for targetPlatforms. |
getUserAgent()
public ScanConfig.UserAgent getUserAgent()The user agent used during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.UserAgent user_agent = 6;
| Returns | |
|---|---|
| Type | Description |
ScanConfig.UserAgent |
The userAgent. |
getUserAgentValue()
public int getUserAgentValue()The user agent used during scanning.
.google.cloud.websecurityscanner.v1beta.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.v1beta.ScanConfig.Authentication authentication = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the authentication field is set. |
hasLatestRun()
public boolean hasLatestRun()Latest ScanRun if available.
.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the latestRun field is set. |
hasSchedule()
public boolean hasSchedule()The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule schedule = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the schedule field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAuthentication(ScanConfig.Authentication value)
public ScanConfig.Builder mergeAuthentication(ScanConfig.Authentication value)The authentication configuration. If specified, service will use the authentication configuration during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication authentication = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ScanConfig.Authentication |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
mergeFrom(ScanConfig other)
public ScanConfig.Builder mergeFrom(ScanConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
ScanConfig |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ScanConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ScanConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
mergeLatestRun(ScanRun value)
public ScanConfig.Builder mergeLatestRun(ScanRun value)Latest ScanRun if available.
.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
ScanRun |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
mergeSchedule(ScanConfig.Schedule value)
public ScanConfig.Builder mergeSchedule(ScanConfig.Schedule value)The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule schedule = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
ScanConfig.Schedule |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ScanConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
setAuthentication(ScanConfig.Authentication value)
public ScanConfig.Builder setAuthentication(ScanConfig.Authentication value)The authentication configuration. If specified, service will use the authentication configuration during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication authentication = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ScanConfig.Authentication |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
setAuthentication(ScanConfig.Authentication.Builder builderForValue)
public ScanConfig.Builder setAuthentication(ScanConfig.Authentication.Builder builderForValue)The authentication configuration. If specified, service will use the authentication configuration during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication authentication = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ScanConfig.Authentication.Builder |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
setBlacklistPatterns(int index, String value)
public ScanConfig.Builder setBlacklistPatterns(int index, String value)The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
repeated string blacklist_patterns = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe blacklistPatterns to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setDisplayName(String value)
public ScanConfig.Builder setDisplayName(String value)Required. The user provided display name of the ScanConfig.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public ScanConfig.Builder setDisplayNameBytes(ByteString value)Required. The user provided display name of the ScanConfig.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setExportToSecurityCommandCenter(ScanConfig.ExportToSecurityCommandCenter value)
public ScanConfig.Builder setExportToSecurityCommandCenter(ScanConfig.ExportToSecurityCommandCenter value)Controls export of scan configurations and results to Cloud Security Command Center.
.google.cloud.websecurityscanner.v1beta.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
ScanConfig.ExportToSecurityCommandCenterThe exportToSecurityCommandCenter to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setExportToSecurityCommandCenterValue(int value)
public ScanConfig.Builder setExportToSecurityCommandCenterValue(int value)Controls export of scan configurations and results to Cloud Security Command Center.
.google.cloud.websecurityscanner.v1beta.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for exportToSecurityCommandCenter to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ScanConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
setLatestRun(ScanRun value)
public ScanConfig.Builder setLatestRun(ScanRun value)Latest ScanRun if available.
.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
ScanRun |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
setLatestRun(ScanRun.Builder builderForValue)
public ScanConfig.Builder setLatestRun(ScanRun.Builder builderForValue)Latest ScanRun if available.
.google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ScanRun.Builder |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
setMaxQps(int value)
public ScanConfig.Builder setMaxQps(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe maxQps to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setName(String value)
public ScanConfig.Builder setName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public ScanConfig.Builder setNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ScanConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
setRiskLevel(ScanConfig.RiskLevel value)
public ScanConfig.Builder setRiskLevel(ScanConfig.RiskLevel value)The risk level selected for the scan
.google.cloud.websecurityscanner.v1beta.ScanConfig.RiskLevel risk_level = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
ScanConfig.RiskLevelThe riskLevel to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setRiskLevelValue(int value)
public ScanConfig.Builder setRiskLevelValue(int value)The risk level selected for the scan
.google.cloud.websecurityscanner.v1beta.ScanConfig.RiskLevel risk_level = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for riskLevel to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setSchedule(ScanConfig.Schedule value)
public ScanConfig.Builder setSchedule(ScanConfig.Schedule value)The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule schedule = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
ScanConfig.Schedule |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
setSchedule(ScanConfig.Schedule.Builder builderForValue)
public ScanConfig.Builder setSchedule(ScanConfig.Schedule.Builder builderForValue)The schedule of the ScanConfig.
.google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule schedule = 8;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ScanConfig.Schedule.Builder |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
setStartingUrls(int index, String value)
public ScanConfig.Builder setStartingUrls(int index, String value)Required. The starting URLs from which the scanner finds site pages.
repeated string starting_urls = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe startingUrls to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setTargetPlatforms(int index, ScanConfig.TargetPlatform value)
public ScanConfig.Builder setTargetPlatforms(int index, ScanConfig.TargetPlatform value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
ScanConfig.TargetPlatformThe targetPlatforms to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setTargetPlatformsValue(int index, int value)
public ScanConfig.Builder setTargetPlatformsValue(int index, int value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for targetPlatforms to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ScanConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
|
setUserAgent(ScanConfig.UserAgent value)
public ScanConfig.Builder setUserAgent(ScanConfig.UserAgent value)The user agent used during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.UserAgent user_agent = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
ScanConfig.UserAgentThe userAgent to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |
setUserAgentValue(int value)
public ScanConfig.Builder setUserAgentValue(int value)The user agent used during scanning.
.google.cloud.websecurityscanner.v1beta.ScanConfig.UserAgent user_agent = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for userAgent to set. |
| Returns | |
|---|---|
| Type | Description |
ScanConfig.Builder |
This builder for chaining. |