Interface ScanRunOrBuilder (2.2.3)

Version 2.2.3

• 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 interface ScanRunOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEndTime()

public abstract 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.

getEndTimeOrBuilder()

public abstract 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

getErrorTrace()

public abstract ScanRunErrorTrace getErrorTrace()

If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.

.google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace error_trace = 10;

Returns

Type	Description
ScanRunErrorTrace	The errorTrace.

getErrorTraceOrBuilder()

public abstract ScanRunErrorTraceOrBuilder getErrorTraceOrBuilder()

If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.

.google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace error_trace = 10;

Returns

Type	Description
ScanRunErrorTraceOrBuilder

getExecutionState()

public abstract ScanRun.ExecutionState getExecutionState()

The execution state of the ScanRun.

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

Returns

Type	Description
ScanRun.ExecutionState	The executionState.

getExecutionStateValue()

public abstract int getExecutionStateValue()

The execution state of the ScanRun.

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

Returns

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

getHasVulnerabilities()

public abstract boolean getHasVulnerabilities()

Whether the scan run has found any vulnerabilities.

bool has_vulnerabilities = 8;

Returns

Type	Description
boolean	The hasVulnerabilities.

getName()

public abstract 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 abstract 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 abstract 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 abstract ScanRun.ResultState getResultState()

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

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

Returns

Type	Description
ScanRun.ResultState	The resultState.

getResultStateValue()

public abstract int getResultStateValue()

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

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

Returns

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

getStartTime()

public abstract Timestamp getStartTime()

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Returns

Type	Description
Timestamp	The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

The time at which the ScanRun started.

.google.protobuf.Timestamp start_time = 4;

Returns

Type	Description
TimestampOrBuilder

getUrlsCrawledCount()

public abstract 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 abstract 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.

getWarningTraces(int index)

public abstract ScanRunWarningTrace getWarningTraces(int index)

A list of warnings, if such are encountered during this scan run.

repeated .google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace warning_traces = 11;

Parameter

Name	Description
index	int

Returns

Type	Description
ScanRunWarningTrace

getWarningTracesCount()

public abstract int getWarningTracesCount()

A list of warnings, if such are encountered during this scan run.

repeated .google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace warning_traces = 11;

Returns

Type	Description
int

getWarningTracesList()

public abstract List<ScanRunWarningTrace> getWarningTracesList()

A list of warnings, if such are encountered during this scan run.

repeated .google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace warning_traces = 11;

Returns

Type	Description
List<ScanRunWarningTrace>

getWarningTracesOrBuilder(int index)

public abstract ScanRunWarningTraceOrBuilder getWarningTracesOrBuilder(int index)

A list of warnings, if such are encountered during this scan run.

repeated .google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace warning_traces = 11;

Parameter

Name	Description
index	int

Returns

Type	Description
ScanRunWarningTraceOrBuilder

getWarningTracesOrBuilderList()

public abstract List<? extends ScanRunWarningTraceOrBuilder> getWarningTracesOrBuilderList()

A list of warnings, if such are encountered during this scan run.

repeated .google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace warning_traces = 11;

Returns

Type	Description
List<? extends com.google.cloud.websecurityscanner.v1beta.ScanRunWarningTraceOrBuilder>

hasEndTime()

public abstract 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.

hasErrorTrace()

public abstract boolean hasErrorTrace()

If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.

.google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace error_trace = 10;

Returns

Type	Description
boolean	Whether the errorTrace field is set.

hasStartTime()

public abstract 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.