public final class ScanRun extends GeneratedMessageV3 implements ScanRunOrBuilder
A ScanRun is a output-only resource representing an actual run of the scan.
Next id: 12
Protobuf type google.cloud.websecurityscanner.v1.ScanRun
Static Fields
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
Field Value
ERROR_TRACE_FIELD_NUMBER
public static final int ERROR_TRACE_FIELD_NUMBER
Field Value
EXECUTION_STATE_FIELD_NUMBER
public static final int EXECUTION_STATE_FIELD_NUMBER
Field Value
HAS_VULNERABILITIES_FIELD_NUMBER
public static final int HAS_VULNERABILITIES_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PROGRESS_PERCENT_FIELD_NUMBER
public static final int PROGRESS_PERCENT_FIELD_NUMBER
Field Value
RESULT_STATE_FIELD_NUMBER
public static final int RESULT_STATE_FIELD_NUMBER
Field Value
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
Field Value
URLS_CRAWLED_COUNT_FIELD_NUMBER
public static final int URLS_CRAWLED_COUNT_FIELD_NUMBER
Field Value
URLS_TESTED_COUNT_FIELD_NUMBER
public static final int URLS_TESTED_COUNT_FIELD_NUMBER
Field Value
WARNING_TRACES_FIELD_NUMBER
public static final int WARNING_TRACES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ScanRun getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ScanRun.Builder newBuilder()
Returns
newBuilder(ScanRun prototype)
public static ScanRun.Builder newBuilder(ScanRun prototype)
Parameter
Returns
public static ScanRun parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ScanRun parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ScanRun parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ScanRun parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ScanRun parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ScanRun parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ScanRun parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ScanRun parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ScanRun parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ScanRun parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ScanRun parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ScanRun parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ScanRun> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ScanRun getDefaultInstanceForType()
Returns
getEndTime()
public Timestamp getEndTime()
Output only. 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;
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder()
Output only. 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;
getErrorTrace()
public ScanRunErrorTrace getErrorTrace()
Output only. 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.v1.ScanRunErrorTrace error_trace = 10;
getErrorTraceOrBuilder()
public ScanRunErrorTraceOrBuilder getErrorTraceOrBuilder()
Output only. 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.v1.ScanRunErrorTrace error_trace = 10;
getExecutionState()
public ScanRun.ExecutionState getExecutionState()
Output only. The execution state of the ScanRun.
.google.cloud.websecurityscanner.v1.ScanRun.ExecutionState execution_state = 2;
getExecutionStateValue()
public int getExecutionStateValue()
Output only. The execution state of the ScanRun.
.google.cloud.websecurityscanner.v1.ScanRun.ExecutionState execution_state = 2;
| Type | Description |
| int | The enum numeric value on the wire for executionState.
|
getHasVulnerabilities()
public boolean getHasVulnerabilities()
Output only. Whether the scan run has found any vulnerabilities.
bool has_vulnerabilities = 8;
| Type | Description |
| boolean | The hasVulnerabilities.
|
getName()
Output only. 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;
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. 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;
getParserForType()
public Parser<ScanRun> getParserForType()
Returns
Overrides
getProgressPercent()
public int getProgressPercent()
Output only. 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;
| Type | Description |
| int | The progressPercent.
|
getResultState()
public ScanRun.ResultState getResultState()
Output only. The result state of the ScanRun. This field is only available after the
execution state reaches "FINISHED".
.google.cloud.websecurityscanner.v1.ScanRun.ResultState result_state = 3;
getResultStateValue()
public int getResultStateValue()
Output only. The result state of the ScanRun. This field is only available after the
execution state reaches "FINISHED".
.google.cloud.websecurityscanner.v1.ScanRun.ResultState result_state = 3;
| Type | Description |
| int | The enum numeric value on the wire for resultState.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStartTime()
public Timestamp getStartTime()
Output only. The time at which the ScanRun started.
.google.protobuf.Timestamp start_time = 4;
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder()
Output only. The time at which the ScanRun started.
.google.protobuf.Timestamp start_time = 4;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUrlsCrawledCount()
public long getUrlsCrawledCount()
Output only. 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;
| Type | Description |
| long | The urlsCrawledCount.
|
getUrlsTestedCount()
public long getUrlsTestedCount()
Output only. 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;
| Type | Description |
| long | The urlsTestedCount.
|
getWarningTraces(int index)
public ScanRunWarningTrace getWarningTraces(int index)
Output only. A list of warnings, if such are encountered during this scan run.
repeated .google.cloud.websecurityscanner.v1.ScanRunWarningTrace warning_traces = 11;
getWarningTracesCount()
public int getWarningTracesCount()
Output only. A list of warnings, if such are encountered during this scan run.
repeated .google.cloud.websecurityscanner.v1.ScanRunWarningTrace warning_traces = 11;
getWarningTracesList()
public List<ScanRunWarningTrace> getWarningTracesList()
Output only. A list of warnings, if such are encountered during this scan run.
repeated .google.cloud.websecurityscanner.v1.ScanRunWarningTrace warning_traces = 11;
getWarningTracesOrBuilder(int index)
public ScanRunWarningTraceOrBuilder getWarningTracesOrBuilder(int index)
Output only. A list of warnings, if such are encountered during this scan run.
repeated .google.cloud.websecurityscanner.v1.ScanRunWarningTrace warning_traces = 11;
getWarningTracesOrBuilderList()
public List<? extends ScanRunWarningTraceOrBuilder> getWarningTracesOrBuilderList()
Output only. A list of warnings, if such are encountered during this scan run.
repeated .google.cloud.websecurityscanner.v1.ScanRunWarningTrace warning_traces = 11;
| Type | Description |
| List<? extends com.google.cloud.websecurityscanner.v1.ScanRunWarningTraceOrBuilder> | |
hasEndTime()
public boolean hasEndTime()
Output only. 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;
| Type | Description |
| boolean | Whether the endTime field is set.
|
hasErrorTrace()
public boolean hasErrorTrace()
Output only. 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.v1.ScanRunErrorTrace error_trace = 10;
| Type | Description |
| boolean | Whether the errorTrace field is set.
|
hasStartTime()
public boolean hasStartTime()
Output only. The time at which the ScanRun started.
.google.protobuf.Timestamp start_time = 4;
| Type | Description |
| boolean | Whether the startTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ScanRun.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ScanRun.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ScanRun.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
