Package com.google.cloud.websecurityscanner.v1

Class ScanRun

  • All Implemented Interfaces:
    ScanRunOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ScanRun
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Field Detail

      • 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

      • 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​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String 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;
        Specified by:
        getName in interface ScanRunOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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;
        Specified by:
        getNameBytes in interface ScanRunOrBuilder
        Returns:
        The bytes for name.

      • getExecutionStateValue

        public int getExecutionStateValue()
         Output only. The execution state of the ScanRun.
        .google.cloud.websecurityscanner.v1.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()
         Output only. The execution state of the ScanRun.
        .google.cloud.websecurityscanner.v1.ScanRun.ExecutionState execution_state = 2;
        Specified by:
        getExecutionState in interface ScanRunOrBuilder
        Returns:
        The executionState.

      • 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;
        Specified by:
        getResultStateValue in interface ScanRunOrBuilder
        Returns:
        The enum numeric value on the wire for resultState.

      • 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;
        Specified by:
        getResultState in interface ScanRunOrBuilder
        Returns:
        The resultState.

      • hasStartTime

        public boolean hasStartTime()
         Output only. 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 com.google.protobuf.Timestamp getStartTime()
         Output only. The time at which the ScanRun started.
        .google.protobuf.Timestamp start_time = 4;
        Specified by:
        getStartTime in interface ScanRunOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. The time at which the ScanRun started.
        .google.protobuf.Timestamp start_time = 4;
        Specified by:
        getStartTimeOrBuilder in interface ScanRunOrBuilder

      • 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;
        Specified by:
        hasEndTime in interface ScanRunOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public com.google.protobuf.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;
        Specified by:
        getEndTime in interface ScanRunOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getEndTimeOrBuilder in interface ScanRunOrBuilder

      • 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;
        Specified by:
        getUrlsCrawledCount in interface ScanRunOrBuilder
        Returns:
        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;
        Specified by:
        getUrlsTestedCount in interface ScanRunOrBuilder
        Returns:
        The urlsTestedCount.

      • getHasVulnerabilities

        public boolean getHasVulnerabilities()
         Output only. 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()
         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;
        Specified by:
        getProgressPercent in interface ScanRunOrBuilder
        Returns:
        The progressPercent.

      • 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;
        Specified by:
        hasErrorTrace in interface ScanRunOrBuilder
        Returns:
        Whether the errorTrace field is set.

      • 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;
        Specified by:
        getErrorTrace in interface ScanRunOrBuilder
        Returns:
        The errorTrace.

      • 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;
        Specified by:
        getErrorTraceOrBuilder in interface ScanRunOrBuilder

      • 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;
        Specified by:
        getWarningTracesList in interface ScanRunOrBuilder

      • 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;
        Specified by:
        getWarningTracesCount in interface ScanRunOrBuilder

      • getWarningTraces

        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;
        Specified by:
        getWarningTraces in interface ScanRunOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ScanRun parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScanRun parseFrom​(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScanRun parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScanRun parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScanRun parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScanRun parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScanRun parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ScanRun.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ScanRun.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ScanRun.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static ScanRun getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<ScanRun> parser()

      • getParserForType

        public com.google.protobuf.Parser<ScanRun> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ScanRun getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder