Class ScanRun.Builder (2.1.0)

Version 2.1.0

• 2.54.0 (latest)
• 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 ScanRun.Builder extends GeneratedMessageV3.Builder<ScanRun.Builder> implements ScanRunOrBuilder

A ScanRun is a output-only resource representing an actual run of the scan.

Protobuf type google.cloud.websecurityscanner.v1alpha.ScanRun

Inheritance

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

Implements

ScanRunOrBuilder

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)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ScanRun.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ScanRun.Builder

Overrides

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

build()

public ScanRun build()

Returns

Type	Description
ScanRun

buildPartial()

public ScanRun buildPartial()

Returns

Type	Description
ScanRun

clear()

public ScanRun.Builder clear()

Returns

Type	Description
ScanRun.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearEndTime()

public ScanRun.Builder clearEndTime()

The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

.google.protobuf.Timestamp end_time = 5;

Returns

Type	Description
ScanRun.Builder

clearExecutionState()

public ScanRun.Builder clearExecutionState()

The execution state of the ScanRun.

.google.cloud.websecurityscanner.v1alpha.ScanRun.ExecutionState execution_state = 2;

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ScanRun.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ScanRun.Builder

Overrides

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

clearHasVulnerabilities()

public ScanRun.Builder clearHasVulnerabilities()

Whether the scan run has found any vulnerabilities.

bool has_vulnerabilities = 8;

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

clearName()

public ScanRun.Builder clearName()

The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

string name = 1;

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ScanRun.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ScanRun.Builder

Overrides

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

clearProgressPercent()

public ScanRun.Builder clearProgressPercent()

The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

int32 progress_percent = 9;

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

clearResultState()

public ScanRun.Builder clearResultState()

The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

.google.cloud.websecurityscanner.v1alpha.ScanRun.ResultState result_state = 3;

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

clearStartTime()

public ScanRun.Builder clearStartTime()

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Returns

Type	Description
ScanRun.Builder

clearUrlsCrawledCount()

public ScanRun.Builder clearUrlsCrawledCount()

The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.

int64 urls_crawled_count = 6;

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

clearUrlsTestedCount()

public ScanRun.Builder clearUrlsTestedCount()

The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

int64 urls_tested_count = 7;

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

clone()

public ScanRun.Builder clone()

Returns

Type	Description
ScanRun.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ScanRun getDefaultInstanceForType()

Returns

Type	Description
ScanRun

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEndTime()

public Timestamp getEndTime()

The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

.google.protobuf.Timestamp end_time = 5;

Returns

Type	Description
Timestamp	The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

.google.protobuf.Timestamp end_time = 5;

Returns

Type	Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

.google.protobuf.Timestamp end_time = 5;

Returns

Type	Description
TimestampOrBuilder

getExecutionState()

public ScanRun.ExecutionState getExecutionState()

The execution state of the ScanRun.

.google.cloud.websecurityscanner.v1alpha.ScanRun.ExecutionState execution_state = 2;

Returns

Type	Description
ScanRun.ExecutionState	The executionState.

getExecutionStateValue()

public int getExecutionStateValue()

The execution state of the ScanRun.

.google.cloud.websecurityscanner.v1alpha.ScanRun.ExecutionState execution_state = 2;

Returns

Type	Description
int	The enum numeric value on the wire for executionState.

getHasVulnerabilities()

public boolean getHasVulnerabilities()

Whether the scan run has found any vulnerabilities.

bool has_vulnerabilities = 8;

Returns

Type	Description
boolean	The hasVulnerabilities.

getName()

public String getName()

The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getProgressPercent()

public int getProgressPercent()

The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

int32 progress_percent = 9;

Returns

Type	Description
int	The progressPercent.

getResultState()

public ScanRun.ResultState getResultState()

The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

.google.cloud.websecurityscanner.v1alpha.ScanRun.ResultState result_state = 3;

Returns

Type	Description
ScanRun.ResultState	The resultState.

getResultStateValue()

public int getResultStateValue()

The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

.google.cloud.websecurityscanner.v1alpha.ScanRun.ResultState result_state = 3;

Returns

Type	Description
int	The enum numeric value on the wire for resultState.

getStartTime()

public Timestamp getStartTime()

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Returns

Type	Description
Timestamp	The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Returns

Type	Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Returns

Type	Description
TimestampOrBuilder

getUrlsCrawledCount()

public long getUrlsCrawledCount()

The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.

int64 urls_crawled_count = 6;

Returns

Type	Description
long	The urlsCrawledCount.

getUrlsTestedCount()

public long getUrlsTestedCount()

The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

int64 urls_tested_count = 7;

Returns

Type	Description
long	The urlsTestedCount.

hasEndTime()

public boolean hasEndTime()

The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

.google.protobuf.Timestamp end_time = 5;

Returns

Type	Description
boolean	Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Returns

Type	Description
boolean	Whether the startTime 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()

mergeEndTime(Timestamp value)

public ScanRun.Builder mergeEndTime(Timestamp value)

The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

.google.protobuf.Timestamp end_time = 5;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
ScanRun.Builder

mergeFrom(ScanRun other)

public ScanRun.Builder mergeFrom(ScanRun other)

Parameter

Name	Description
other	ScanRun

Returns

Type	Description
ScanRun.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ScanRun.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ScanRun.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ScanRun.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
ScanRun.Builder

Overrides

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

mergeStartTime(Timestamp value)

public ScanRun.Builder mergeStartTime(Timestamp value)

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
ScanRun.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ScanRun.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ScanRun.Builder

Overrides

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

setEndTime(Timestamp value)

public ScanRun.Builder setEndTime(Timestamp value)

The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

.google.protobuf.Timestamp end_time = 5;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
ScanRun.Builder

setEndTime(Timestamp.Builder builderForValue)

public ScanRun.Builder setEndTime(Timestamp.Builder builderForValue)

The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

.google.protobuf.Timestamp end_time = 5;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
ScanRun.Builder

setExecutionState(ScanRun.ExecutionState value)

public ScanRun.Builder setExecutionState(ScanRun.ExecutionState value)

The execution state of the ScanRun.

.google.cloud.websecurityscanner.v1alpha.ScanRun.ExecutionState execution_state = 2;

Parameter

Name	Description
value	ScanRun.ExecutionState The executionState to set.

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

setExecutionStateValue(int value)

public ScanRun.Builder setExecutionStateValue(int value)

The execution state of the ScanRun.

.google.cloud.websecurityscanner.v1alpha.ScanRun.ExecutionState execution_state = 2;

Parameter

Name	Description
value	int The enum numeric value on the wire for executionState to set.

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ScanRun.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ScanRun.Builder

Overrides

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

setHasVulnerabilities(boolean value)

public ScanRun.Builder setHasVulnerabilities(boolean value)

Whether the scan run has found any vulnerabilities.

bool has_vulnerabilities = 8;

Parameter

Name	Description
value	boolean The hasVulnerabilities to set.

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

setName(String value)

public ScanRun.Builder setName(String value)

The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

string name = 1;

Parameter

Name	Description
value	String The name to set.

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

setNameBytes(ByteString value)

public ScanRun.Builder setNameBytes(ByteString value)

The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

string name = 1;

Parameter

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

setProgressPercent(int value)

public ScanRun.Builder setProgressPercent(int value)

The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

int32 progress_percent = 9;

Parameter

Name	Description
value	int The progressPercent to set.

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ScanRun.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
ScanRun.Builder

Overrides

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

setResultState(ScanRun.ResultState value)

public ScanRun.Builder setResultState(ScanRun.ResultState value)

The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

.google.cloud.websecurityscanner.v1alpha.ScanRun.ResultState result_state = 3;

Parameter

Name	Description
value	ScanRun.ResultState The resultState to set.

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

setResultStateValue(int value)

public ScanRun.Builder setResultStateValue(int value)

The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

.google.cloud.websecurityscanner.v1alpha.ScanRun.ResultState result_state = 3;

Parameter

Name	Description
value	int The enum numeric value on the wire for resultState to set.

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

setStartTime(Timestamp value)

public ScanRun.Builder setStartTime(Timestamp value)

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
ScanRun.Builder

setStartTime(Timestamp.Builder builderForValue)

public ScanRun.Builder setStartTime(Timestamp.Builder builderForValue)

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
ScanRun.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ScanRun.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ScanRun.Builder

Overrides

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

setUrlsCrawledCount(long value)

public ScanRun.Builder setUrlsCrawledCount(long value)

The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.

int64 urls_crawled_count = 6;

Parameter

Name	Description
value	long The urlsCrawledCount to set.

Returns

Type	Description
ScanRun.Builder	This builder for chaining.

setUrlsTestedCount(long value)

public ScanRun.Builder setUrlsTestedCount(long value)

The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

int64 urls_tested_count = 7;

Parameter

Name	Description
value	long The urlsTestedCount to set.

Returns

Type	Description
ScanRun.Builder	This builder for chaining.