Package com.google.cloud.websecurityscanner.v1

Interface ScanRunOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ScanRun, ScanRun.Builder
@Generated public interface ScanRunOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • getExecutionStateValue

      int getExecutionStateValue()
       Output only. The execution state of the ScanRun.
      .google.cloud.websecurityscanner.v1.ScanRun.ExecutionState execution_state = 2;
      Returns:
      The enum numeric value on the wire for executionState.

    • getExecutionState

      ScanRun.ExecutionState getExecutionState()
       Output only. The execution state of the ScanRun.
      .google.cloud.websecurityscanner.v1.ScanRun.ExecutionState execution_state = 2;
      Returns:
      The executionState.

    • getResultStateValue

      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:
      The enum numeric value on the wire for resultState.

    • getResultState

      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;
      Returns:
      The resultState.

    • hasStartTime

      boolean hasStartTime()
       Output only. The time at which the ScanRun started.
      .google.protobuf.Timestamp start_time = 4;
      Returns:
      Whether the startTime field is set.

    • getStartTime

      com.google.protobuf.Timestamp getStartTime()
       Output only. The time at which the ScanRun started.
      .google.protobuf.Timestamp start_time = 4;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Output only. The time at which the ScanRun started.
      .google.protobuf.Timestamp start_time = 4;

    • hasEndTime

      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:
      Whether the endTime field is set.

    • getEndTime

      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;
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      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;

    • getUrlsCrawledCount

      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:
      The urlsCrawledCount.

    • getUrlsTestedCount

      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:
      The urlsTestedCount.

    • getHasVulnerabilities

      boolean getHasVulnerabilities()
       Output only. Whether the scan run has found any vulnerabilities.
      bool has_vulnerabilities = 8;
      Returns:
      The hasVulnerabilities.

    • getProgressPercent

      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:
      The progressPercent.

    • hasErrorTrace

      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:
      Whether the errorTrace field is set.

    • getErrorTrace

      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;
      Returns:
      The errorTrace.

    • getErrorTraceOrBuilder

      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;

    • getWarningTracesList

      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;

    • getWarningTraces

      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

      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;

    • getWarningTracesOrBuilderList

      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;

    • getWarningTracesOrBuilder

      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;