Class ScanConfig.Builder (2.41.0)

public static final class ScanConfig.Builder extends GeneratedMessageV3.Builder<ScanConfig.Builder> implements ScanConfigOrBuilder

A ScanConfig resource contains the configurations to launch a scan.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ScanConfig.Builder

Implements

ScanConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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 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;

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;

Parameter
Name	Description
`values`	`Iterable<String>` The startingUrls to add.

Returns
Type	Description
`ScanConfig.Builder`	This builder for chaining.

addBlacklistPatterns(String value)

public ScanConfig.Builder addBlacklistPatterns(String value)

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;

Parameter
Name	Description
`value`	`String` The blacklistPatterns to add.

Returns
Type	Description
`ScanConfig.Builder`	This builder for chaining.

addBlacklistPatternsBytes(ByteString value)

public ScanConfig.Builder addBlacklistPatternsBytes(ByteString value)

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;

Parameter
Name	Description
`value`	`ByteString` The 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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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;

Parameter
Name	Description
`value`	`String` The 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;

Parameter
Name	Description
`value`	`ByteString` The bytes of the startingUrls 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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAuthentication()

public ScanConfig.Builder clearAuthentication()

The authentication configuration. If specified, service will use the authentication configuration during scanning.

.google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;

Returns
Type	Description
`ScanConfig.Builder`

clearBlacklistPatterns()

public ScanConfig.Builder clearBlacklistPatterns()

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;

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;

Returns
Type	Description
`ScanConfig.Builder`	This builder for chaining.

clearExportToSecurityCommandCenter()

public ScanConfig.Builder clearExportToSecurityCommandCenter()

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
`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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIgnoreHttpStatusErrors()

public ScanConfig.Builder clearIgnoreHttpStatusErrors()

Whether to keep scanning even if most requests return HTTP error codes.

bool ignore_http_status_errors = 15;

Returns
Type	Description
`ScanConfig.Builder`	This builder for chaining.

clearManagedScan()

public ScanConfig.Builder clearManagedScan()

Whether the scan config is managed by Web Security Scanner, output only.

bool managed_scan = 13;

Returns
Type	Description
`ScanConfig.Builder`	This builder for chaining.

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRiskLevel()

public ScanConfig.Builder clearRiskLevel()

The risk level selected for the scan

.google.cloud.websecurityscanner.v1.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.v1.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;

Returns
Type	Description
`ScanConfig.Builder`	This builder for chaining.

clearStaticIpScan()

public ScanConfig.Builder clearStaticIpScan()

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
`ScanConfig.Builder`	This builder for chaining.

clearUserAgent()

public ScanConfig.Builder clearUserAgent()

The user agent used during scanning.

.google.cloud.websecurityscanner.v1.ScanConfig.UserAgent user_agent = 6;

Returns
Type	Description
`ScanConfig.Builder`	This builder for chaining.

clone()

public ScanConfig.Builder clone()

Returns
Type	Description
`ScanConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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;

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.v1.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.v1.ScanConfig.Authentication authentication = 5;

Returns
Type	Description
`ScanConfig.AuthenticationOrBuilder`

getBlacklistPatterns(int index)

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;

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)

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;

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()

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;

Returns
Type	Description
`int`	The count of blacklistPatterns.

getBlacklistPatternsList()

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;

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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;

Returns
Type	Description
`ScanConfig.ExportToSecurityCommandCenter`	The exportToSecurityCommandCenter.

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()

public int getMaxQps()

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.v1.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.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;

Returns
Type	Description
`ScanConfig.Schedule`	The schedule.

getScheduleBuilder()

public ScanConfig.Schedule.Builder getScheduleBuilder()

The schedule of the ScanConfig.

.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;

Returns
Type	Description
`ScanConfig.Schedule.Builder`

getScheduleOrBuilder()

public ScanConfig.ScheduleOrBuilder getScheduleOrBuilder()

The schedule of the ScanConfig.

.google.cloud.websecurityscanner.v1.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;

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;

Returns
Type	Description
`ProtocolStringList`	A list containing the startingUrls.

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;

Returns
Type	Description
`ScanConfig.UserAgent`	The userAgent.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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.v1.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`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ScanConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ScanConfig.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSchedule(ScanConfig.Schedule value)

public ScanConfig.Builder mergeSchedule(ScanConfig.Schedule value)

The schedule of the ScanConfig.

.google.cloud.websecurityscanner.v1.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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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.v1.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.v1.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 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;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The 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;

Parameter
Name	Description
`value`	`String` The 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;

Parameter
Name	Description
`value`	`ByteString` The 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 Security Command Center.

.google.cloud.websecurityscanner.v1.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;

Parameter
Name	Description
`value`	`ScanConfig.ExportToSecurityCommandCenter` The 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 Security Command Center.

.google.cloud.websecurityscanner.v1.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;

Parameter
Name	Description
`value`	`int` The 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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIgnoreHttpStatusErrors(boolean value)

public ScanConfig.Builder setIgnoreHttpStatusErrors(boolean value)

Whether to keep scanning even if most requests return HTTP error codes.

bool ignore_http_status_errors = 15;

Parameter
Name	Description
`value`	`boolean` The ignoreHttpStatusErrors to set.

Returns
Type	Description
`ScanConfig.Builder`	This builder for chaining.

setManagedScan(boolean value)

public ScanConfig.Builder setManagedScan(boolean value)

Whether the scan config is managed by Web Security Scanner, output only.

bool managed_scan = 13;

Parameter
Name	Description
`value`	`boolean` The managedScan to set.

Returns
Type	Description
`ScanConfig.Builder`	This builder for chaining.

setMaxQps(int value)

public ScanConfig.Builder setMaxQps(int value)

int32 max_qps = 3;

Parameter
Name	Description
`value`	`int` The 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`	`String` The 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`	`ByteString` The 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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRiskLevel(ScanConfig.RiskLevel value)

public ScanConfig.Builder setRiskLevel(ScanConfig.RiskLevel value)

The risk level selected for the scan

.google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel risk_level = 12;

Parameter
Name	Description
`value`	`ScanConfig.RiskLevel` The 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.v1.ScanConfig.RiskLevel risk_level = 12;

Parameter
Name	Description
`value`	`int` The 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.v1.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.v1.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;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The startingUrls to set.

Returns
Type	Description
`ScanConfig.Builder`	This builder for chaining.

setStaticIpScan(boolean value)

public ScanConfig.Builder setStaticIpScan(boolean value)

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;

Parameter
Name	Description
`value`	`boolean` The staticIpScan 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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUserAgent(ScanConfig.UserAgent value)

public ScanConfig.Builder setUserAgent(ScanConfig.UserAgent value)

The user agent used during scanning.

.google.cloud.websecurityscanner.v1.ScanConfig.UserAgent user_agent = 6;

Parameter
Name	Description
`value`	`ScanConfig.UserAgent` The 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.v1.ScanConfig.UserAgent user_agent = 6;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for userAgent to set.

Returns
Type	Description
`ScanConfig.Builder`	This builder for chaining.