com.google.cloud.websecurityscanner.v1beta

Class ScanRun

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.websecurityscanner.v1beta.ScanRun

All Implemented Interfaces:

ScanRunOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

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.v1beta.ScanRun

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScanRun.Builder A ScanRun is a output-only resource representing an actual run of the scan.
static class	ScanRun.ExecutionState Types of ScanRun execution state.
static class	ScanRun.ResultState Types of ScanRun result state.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	END_TIME_FIELD_NUMBER
static int	ERROR_TRACE_FIELD_NUMBER
static int	EXECUTION_STATE_FIELD_NUMBER
static int	HAS_VULNERABILITIES_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PROGRESS_PERCENT_FIELD_NUMBER
static int	RESULT_STATE_FIELD_NUMBER
static int	START_TIME_FIELD_NUMBER
static int	URLS_CRAWLED_COUNT_FIELD_NUMBER
static int	URLS_TESTED_COUNT_FIELD_NUMBER
static int	WARNING_TRACES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ScanRun	getDefaultInstance()
ScanRun	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
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.
Parser<ScanRun>	getParserForType()
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.
int	getSerializedSize()
Timestamp	getStartTime() The time at which the ScanRun started.
TimestampOrBuilder	getStartTimeOrBuilder() The time at which the ScanRun started.
UnknownFieldSet	getUnknownFields()
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.
int	hashCode()
boolean	hasStartTime() The time at which the ScanRun started.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ScanRun.Builder	newBuilder()
static ScanRun.Builder	newBuilder(ScanRun prototype)
ScanRun.Builder	newBuilderForType()
protected ScanRun.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static ScanRun	parseDelimitedFrom(InputStream input)
static ScanRun	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ScanRun	parseFrom(byte[] data)
static ScanRun	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ScanRun	parseFrom(ByteBuffer data)
static ScanRun	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static ScanRun	parseFrom(ByteString data)
static ScanRun	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ScanRun	parseFrom(CodedInputStream input)
static ScanRun	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ScanRun	parseFrom(InputStream input)
static ScanRun	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<ScanRun>	parser()
ScanRun.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

EXECUTION_STATE_FIELD_NUMBER

public static final int EXECUTION_STATE_FIELD_NUMBER

See Also:

Constant Field Values

RESULT_STATE_FIELD_NUMBER

public static final int RESULT_STATE_FIELD_NUMBER

See Also:

Constant Field Values

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

See Also:

Constant Field Values

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

See Also:

Constant Field Values

URLS_CRAWLED_COUNT_FIELD_NUMBER

public static final int URLS_CRAWLED_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

URLS_TESTED_COUNT_FIELD_NUMBER

public static final int URLS_TESTED_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

HAS_VULNERABILITIES_FIELD_NUMBER

public static final int HAS_VULNERABILITIES_FIELD_NUMBER

See Also:

Constant Field Values

PROGRESS_PERCENT_FIELD_NUMBER

public static final int PROGRESS_PERCENT_FIELD_NUMBER

See Also:

Constant Field Values

ERROR_TRACE_FIELD_NUMBER

public static final int ERROR_TRACE_FIELD_NUMBER

See Also:

Constant Field Values

WARNING_TRACES_FIELD_NUMBER

public static final int WARNING_TRACES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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;

Specified by:

getName in interface ScanRunOrBuilder

Returns:

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;

Specified by:

getNameBytes in interface ScanRunOrBuilder

Returns:

The bytes for name.

getExecutionStateValue

public int getExecutionStateValue()

 The execution state of the ScanRun.
 

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

Specified by:

getExecutionStateValue in interface ScanRunOrBuilder

Returns:

The enum numeric value on the wire for executionState.

getExecutionState

public ScanRun.ExecutionState getExecutionState()

 The execution state of the ScanRun.
 

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

Specified by:

getExecutionState in interface ScanRunOrBuilder

Returns:

The executionState.

getResultStateValue

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

Specified by:

getResultStateValue in interface ScanRunOrBuilder

Returns:

The enum numeric value on the wire for resultState.

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.v1beta.ScanRun.ResultState result_state = 3;

Specified by:

getResultState in interface ScanRunOrBuilder

Returns:

The resultState.

hasStartTime

public boolean hasStartTime()

 The time at which the ScanRun started.
 

.google.protobuf.Timestamp start_time = 4;

Specified by:

hasStartTime in interface ScanRunOrBuilder

Returns:

Whether the startTime field is set.

getStartTime

public Timestamp getStartTime()

 The time at which the ScanRun started.
 

.google.protobuf.Timestamp start_time = 4;

Specified by:

getStartTime in interface ScanRunOrBuilder

Returns:

The startTime.

getStartTimeOrBuilder

public TimestampOrBuilder getStartTimeOrBuilder()

 The time at which the ScanRun started.
 

.google.protobuf.Timestamp start_time = 4;

Specified by:

getStartTimeOrBuilder in interface ScanRunOrBuilder

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;

Specified by:

hasEndTime in interface ScanRunOrBuilder

Returns:

Whether the endTime field is set.

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;

Specified by:

getEndTime in interface ScanRunOrBuilder

Returns:

The endTime.

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;

Specified by:

getEndTimeOrBuilder in interface ScanRunOrBuilder

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;

Specified by:

getUrlsCrawledCount in interface ScanRunOrBuilder

Returns:

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;

Specified by:

getUrlsTestedCount in interface ScanRunOrBuilder

Returns:

The urlsTestedCount.

getHasVulnerabilities

public boolean getHasVulnerabilities()

 Whether the scan run has found any vulnerabilities.
 

bool has_vulnerabilities = 8;

Specified by:

getHasVulnerabilities in interface ScanRunOrBuilder

Returns:

The hasVulnerabilities.

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;

Specified by:

getProgressPercent in interface ScanRunOrBuilder

Returns:

The progressPercent.

hasErrorTrace

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

Specified by:

hasErrorTrace in interface ScanRunOrBuilder

Returns:

Whether the errorTrace field is set.

getErrorTrace

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

Specified by:

getErrorTrace in interface ScanRunOrBuilder

Returns:

The errorTrace.

getErrorTraceOrBuilder

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

Specified by:

getErrorTraceOrBuilder in interface ScanRunOrBuilder

getWarningTracesList

public List<ScanRunWarningTrace> getWarningTracesList()

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

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

Specified by:

getWarningTracesList in interface ScanRunOrBuilder

getWarningTracesOrBuilderList

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

Specified by:

getWarningTracesOrBuilderList in interface ScanRunOrBuilder

getWarningTracesCount

public int getWarningTracesCount()

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

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

Specified by:

getWarningTracesCount in interface ScanRunOrBuilder

getWarningTraces

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

Specified by:

getWarningTraces in interface ScanRunOrBuilder

getWarningTracesOrBuilder

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

Specified by:

getWarningTracesOrBuilder in interface ScanRunOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ScanRun parseFrom(ByteBuffer data)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ScanRun parseFrom(ByteBuffer data,
                                ExtensionRegistryLite extensionRegistry)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ScanRun parseFrom(ByteString data)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ScanRun parseFrom(ByteString data,
                                ExtensionRegistryLite extensionRegistry)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ScanRun parseFrom(byte[] data)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ScanRun parseFrom(byte[] data,
                                ExtensionRegistryLite extensionRegistry)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ScanRun parseFrom(InputStream input)
                         throws IOException

Throws:

IOException

parseFrom

public static ScanRun parseFrom(InputStream input,
                                ExtensionRegistryLite extensionRegistry)
                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static ScanRun parseDelimitedFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static ScanRun parseDelimitedFrom(InputStream input,
                                         ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseFrom

public static ScanRun parseFrom(CodedInputStream input)
                         throws IOException

Throws:

IOException

parseFrom

public static ScanRun parseFrom(CodedInputStream input,
                                ExtensionRegistryLite extensionRegistry)
                         throws IOException

Throws:

IOException

newBuilderForType

public ScanRun.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ScanRun.Builder newBuilder()

newBuilder

public static ScanRun.Builder newBuilder(ScanRun prototype)

toBuilder

public ScanRun.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ScanRun.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ScanRun getDefaultInstance()

parser

public static Parser<ScanRun> parser()

getParserForType

public Parser<ScanRun> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ScanRun getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder