Class ScanRun.Builder (2.11.0)

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

Implements

ScanRunOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ScanRun.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ScanRun.Builder
Overrides

build()

public ScanRun build()
Returns
TypeDescription
ScanRun

buildPartial()

public ScanRun buildPartial()
Returns
TypeDescription
ScanRun

clear()

public ScanRun.Builder clear()
Returns
TypeDescription
ScanRun.Builder
Overrides

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
TypeDescription
ScanRun.Builder

clearExecutionState()

public ScanRun.Builder clearExecutionState()

The execution state of the ScanRun.

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

Returns
TypeDescription
ScanRun.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ScanRun.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ScanRun.Builder
Overrides

clearHasVulnerabilities()

public ScanRun.Builder clearHasVulnerabilities()

Whether the scan run has found any vulnerabilities.

bool has_vulnerabilities = 8;

Returns
TypeDescription
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
TypeDescription
ScanRun.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ScanRun.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ScanRun.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ScanRun.Builder

This builder for chaining.

clone()

public ScanRun.Builder clone()
Returns
TypeDescription
ScanRun.Builder
Overrides

getDefaultInstanceForType()

public ScanRun getDefaultInstanceForType()
Returns
TypeDescription
ScanRun

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getExecutionState()

public ScanRun.ExecutionState getExecutionState()

The execution state of the ScanRun.

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

Returns
TypeDescription
ScanRun.ExecutionState

The executionState.

getExecutionStateValue()

public int getExecutionStateValue()

The execution state of the ScanRun.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the startTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueTimestamp
Returns
TypeDescription
ScanRun.Builder

mergeFrom(ScanRun other)

public ScanRun.Builder mergeFrom(ScanRun other)
Parameter
NameDescription
otherScanRun
Returns
TypeDescription
ScanRun.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ScanRun.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ScanRun.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ScanRun.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ScanRun.Builder
Overrides

mergeStartTime(Timestamp value)

public ScanRun.Builder mergeStartTime(Timestamp value)

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ScanRun.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ScanRun.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ScanRun.Builder
Overrides

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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueScanRun.ExecutionState

The executionState to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
ScanRun.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ScanRun.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ScanRun.Builder
Overrides

setHasVulnerabilities(boolean value)

public ScanRun.Builder setHasVulnerabilities(boolean value)

Whether the scan run has found any vulnerabilities.

bool has_vulnerabilities = 8;

Parameter
NameDescription
valueboolean

The hasVulnerabilities to set.

Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
valueint

The progressPercent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ScanRun.Builder
Overrides

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
NameDescription
valueScanRun.ResultState

The resultState to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
ScanRun.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ScanRun.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ScanRun.Builder
Overrides

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
NameDescription
valuelong

The urlsCrawledCount to set.

Returns
TypeDescription
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
NameDescription
valuelong

The urlsTestedCount to set.

Returns
TypeDescription
ScanRun.Builder

This builder for chaining.