com.google.cloud.websecurityscanner.v1beta

Interface ScanRunOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

ScanRun, ScanRun.Builder

public interface ScanRunOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Timestamp	getEndTime() The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
TimestampOrBuilder	getEndTimeOrBuilder() The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
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.
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.
ScanRun.ExecutionState	getExecutionState() The execution state of the ScanRun.
int	getExecutionStateValue() The execution state of the ScanRun.
boolean	getHasVulnerabilities() Whether the scan run has found any vulnerabilities.
String	getName() The resource name of the ScanRun.
ByteString	getNameBytes() The resource name of the ScanRun.
int	getProgressPercent() The percentage of total completion ranging from 0 to 100.
ScanRun.ResultState	getResultState() The result state of the ScanRun.
int	getResultStateValue() The result state of the ScanRun.
Timestamp	getStartTime() The time at which the ScanRun started.
TimestampOrBuilder	getStartTimeOrBuilder() The time at which the ScanRun started.
long	getUrlsCrawledCount() The number of URLs crawled during this ScanRun.
long	getUrlsTestedCount() The number of URLs tested during this ScanRun.
ScanRunWarningTrace	getWarningTraces(int index) A list of warnings, if such are encountered during this scan run.
int	getWarningTracesCount() A list of warnings, if such are encountered during this scan run.
List<ScanRunWarningTrace>	getWarningTracesList() A list of warnings, if such are encountered during this scan run.
ScanRunWarningTraceOrBuilder	getWarningTracesOrBuilder(int index) A list of warnings, if such are encountered during this scan run.
List<? extends ScanRunWarningTraceOrBuilder>	getWarningTracesOrBuilderList() A list of warnings, if such are encountered during this scan run.
boolean	hasEndTime() The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
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.
boolean	hasStartTime() The time at which the ScanRun started.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

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:

The bytes for name.

getExecutionStateValue

int getExecutionStateValue()

 The execution state of the ScanRun.
 

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

Returns:

The enum numeric value on the wire for executionState.

getExecutionState

ScanRun.ExecutionState getExecutionState()

 The execution state of the ScanRun.
 

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

Returns:

The executionState.

getResultStateValue

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:

The enum numeric value on the wire for resultState.

getResultState

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:

The resultState.

hasStartTime

boolean hasStartTime()

 The time at which the ScanRun started.
 

.google.protobuf.Timestamp start_time = 4;

Returns:

Whether the startTime field is set.

getStartTime

Timestamp getStartTime()

 The time at which the ScanRun started.
 

.google.protobuf.Timestamp start_time = 4;

Returns:

The startTime.

getStartTimeOrBuilder

TimestampOrBuilder getStartTimeOrBuilder()

 The time at which the ScanRun started.
 

.google.protobuf.Timestamp start_time = 4;

hasEndTime

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:

Whether the endTime field is set.

getEndTime

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:

The endTime.

getEndTimeOrBuilder

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;

getUrlsCrawledCount

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:

The urlsCrawledCount.

getUrlsTestedCount

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:

The urlsTestedCount.

getHasVulnerabilities

boolean getHasVulnerabilities()

 Whether the scan run has found any vulnerabilities.
 

bool has_vulnerabilities = 8;

Returns:

The hasVulnerabilities.

getProgressPercent

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:

The progressPercent.

hasErrorTrace

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:

Whether the errorTrace field is set.

getErrorTrace

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:

The errorTrace.

getErrorTraceOrBuilder

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;

getWarningTracesList

List<ScanRunWarningTrace> getWarningTracesList()

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

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

getWarningTraces

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;

getWarningTracesCount

int getWarningTracesCount()

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

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

getWarningTracesOrBuilderList

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;

getWarningTracesOrBuilder

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;