Package com.google.cloud.websecurityscanner.v1alpha

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 Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Timestamp
    getEndTime()
    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
    com.google.protobuf.TimestampOrBuilder
    getEndTimeOrBuilder()
    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
    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.
    com.google.protobuf.ByteString
    getNameBytes()
    The resource name of the ScanRun.
    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.
    com.google.protobuf.Timestamp
    getStartTime()
    The time at which the ScanRun started.
    com.google.protobuf.TimestampOrBuilder
    getStartTimeOrBuilder()
    The time at which the ScanRun started.
    long
    getUrlsCrawledCount()
    The number of URLs crawled during this ScanRun.
    long
    getUrlsTestedCount()
    The number of URLs tested during this ScanRun.
    boolean
    hasEndTime()
    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
    boolean
    hasStartTime()
    The time at which the ScanRun started.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getName

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

    • getNameBytes

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

    • getExecutionStateValue

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

    • getExecutionState

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

    • getResultStateValue

      int getResultStateValue()
       The result state of the ScanRun. This field is only available after the
 execution state reaches "FINISHED".
      .google.cloud.websecurityscanner.v1alpha.ScanRun.ResultState result_state = 3;
      Returns:
      The enum numeric value on the wire for resultState.

    • getResultState

      ScanRun.ResultState getResultState()
       The result state of the ScanRun. This field is only available after the
 execution state reaches "FINISHED".
      .google.cloud.websecurityscanner.v1alpha.ScanRun.ResultState result_state = 3;
      Returns:
      The resultState.

    • hasStartTime

      boolean hasStartTime()
       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()
       The time at which the ScanRun started.
      .google.protobuf.Timestamp start_time = 4;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

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

    • hasEndTime

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

    • getEndTime

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

    • getEndTimeOrBuilder

      com.google.protobuf.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;

    • getUrlsCrawledCount

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

    • getUrlsTestedCount

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

    • getHasVulnerabilities

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

    • getProgressPercent

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