/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/websecurityscanner/v1/scan_run.proto
package com.google.cloud.websecurityscanner.v1;
public interface ScanRunOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.websecurityscanner.v1.ScanRun)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*
* @return The name.
*/
java.lang.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;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. The execution state of the ScanRun.
*
*
* .google.cloud.websecurityscanner.v1.ScanRun.ExecutionState execution_state = 2;
*
* @return The enum numeric value on the wire for executionState.
*/
int getExecutionStateValue();
/**
*
*
*
* Output only. The execution state of the ScanRun.
*
*
* .google.cloud.websecurityscanner.v1.ScanRun.ExecutionState execution_state = 2;
*
* @return The executionState.
*/
com.google.cloud.websecurityscanner.v1.ScanRun.ExecutionState getExecutionState();
/**
*
*
*
* 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;
*
* @return The enum numeric value on the wire for resultState.
*/
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;
*
* @return The resultState.
*/
com.google.cloud.websecurityscanner.v1.ScanRun.ResultState getResultState();
/**
*
*
*
* Output only. The time at which the ScanRun started.
*
*
* .google.protobuf.Timestamp start_time = 4;
*
* @return Whether the startTime field is set.
*/
boolean hasStartTime();
/**
*
*
*
* Output only. The time at which the ScanRun started.
*
*
* .google.protobuf.Timestamp start_time = 4;
*
* @return The startTime.
*/
com.google.protobuf.Timestamp getStartTime();
/**
*
*
*
* Output only. The time at which the ScanRun started.
*
*
* .google.protobuf.Timestamp start_time = 4;
*/
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the endTime field is set.
*/
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;
*
* @return The endTime.
*/
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;
*/
com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder();
/**
*
*
*
* 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;
*
* @return The urlsCrawledCount.
*/
long getUrlsCrawledCount();
/**
*
*
*
* 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;
*
* @return The urlsTestedCount.
*/
long getUrlsTestedCount();
/**
*
*
*
* Output only. Whether the scan run has found any vulnerabilities.
*
*
* bool has_vulnerabilities = 8;
*
* @return The hasVulnerabilities.
*/
boolean getHasVulnerabilities();
/**
*
*
*
* 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;
*
* @return The progressPercent.
*/
int getProgressPercent();
/**
*
*
*
* 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;
*
* @return Whether the errorTrace field is set.
*/
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;
*
* @return The errorTrace.
*/
com.google.cloud.websecurityscanner.v1.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;
*/
com.google.cloud.websecurityscanner.v1.ScanRunErrorTraceOrBuilder getErrorTraceOrBuilder();
/**
*
*
*
* Output only. A list of warnings, if such are encountered during this scan run.
*
*
* repeated .google.cloud.websecurityscanner.v1.ScanRunWarningTrace warning_traces = 11;
*
*/
java.util.List getWarningTracesList();
/**
*
*
*
* Output only. A list of warnings, if such are encountered during this scan run.
*
*
* repeated .google.cloud.websecurityscanner.v1.ScanRunWarningTrace warning_traces = 11;
*
*/
com.google.cloud.websecurityscanner.v1.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;
*
*/
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;
*
*/
java.util.List
getWarningTracesOrBuilderList();
/**
*
*
*
* Output only. A list of warnings, if such are encountered during this scan run.
*
*
* repeated .google.cloud.websecurityscanner.v1.ScanRunWarningTrace warning_traces = 11;
*
*/
com.google.cloud.websecurityscanner.v1.ScanRunWarningTraceOrBuilder getWarningTracesOrBuilder(
int index);
}