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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ERROR_TRACE_FIELD_NUMBER
public static final int ERROR_TRACE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXECUTION_STATE_FIELD_NUMBER
public static final int EXECUTION_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HAS_VULNERABILITIES_FIELD_NUMBER
public static final int HAS_VULNERABILITIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROGRESS_PERCENT_FIELD_NUMBER
public static final int PROGRESS_PERCENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESULT_STATE_FIELD_NUMBER
public static final int RESULT_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
URLS_CRAWLED_COUNT_FIELD_NUMBER
public static final int URLS_CRAWLED_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
URLS_TESTED_COUNT_FIELD_NUMBER
public static final int URLS_TESTED_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
WARNING_TRACES_FIELD_NUMBER
public static final int WARNING_TRACES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ScanRun getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ScanRun.Builder newBuilder()
newBuilder(ScanRun prototype)
public static ScanRun.Builder newBuilder(ScanRun prototype)
| Parameter |
| Name |
Description |
prototype |
ScanRun
|
public static ScanRun parseDelimitedFrom(InputStream input)
public static ScanRun parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ScanRun parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ScanRun parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ScanRun parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ScanRun parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ScanRun parseFrom(CodedInputStream input)
public static ScanRun parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ScanRun parseFrom(InputStream input)
public static ScanRun parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ScanRun parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ScanRun parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ScanRun> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ScanRun getDefaultInstanceForType()
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;
| Returns |
| Type |
Description |
Timestamp |
The endTime.
|
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;
| Returns |
| 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;
| Returns |
| 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;
| Returns |
| 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<ScanRun> getParserForType()
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;
| Returns |
| 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;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for resultState.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStartTime()
public Timestamp getStartTime()
Output only. The time at which the ScanRun started.
.google.protobuf.Timestamp start_time = 4;
| Returns |
| Type |
Description |
Timestamp |
The startTime.
|
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder()
Output only. The time at which the ScanRun started.
.google.protobuf.Timestamp start_time = 4;
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;
| Returns |
| 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;
| Returns |
| 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;
| Parameter |
| Name |
Description |
index |
int
|
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;
| Returns |
| Type |
Description |
int |
|
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;
| Parameter |
| Name |
Description |
index |
int
|
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;
| Returns |
| 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;
| Returns |
| 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;
| Returns |
| 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;
| Returns |
| Type |
Description |
boolean |
Whether the startTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ScanRun.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ScanRun.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ScanRun.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
