/*
 * 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_config.proto

package com.google.cloud.websecurityscanner.v1;

public interface ScanConfigOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.websecurityscanner.v1.ScanConfig)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * The resource name of the ScanConfig. The name follows the format of
   * 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
   * generated by the system.
   * </pre>
   *
   * <code>string name = 1;</code>
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   * <pre>
   * The resource name of the ScanConfig. The name follows the format of
   * 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
   * generated by the system.
   * </pre>
   *
   * <code>string name = 1;</code>
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   * <pre>
   * Required. The user provided display name of the ScanConfig.
   * </pre>
   *
   * <code>string display_name = 2;</code>
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   * <pre>
   * Required. The user provided display name of the ScanConfig.
   * </pre>
   *
   * <code>string display_name = 2;</code>
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   * <pre>
   * The maximum QPS during scanning. A valid value ranges from 5 to 20
   * inclusively. If the field is unspecified or its value is set 0, server will
   * default to 15. Other values outside of [5, 20] range will be rejected with
   * INVALID_ARGUMENT error.
   * </pre>
   *
   * <code>int32 max_qps = 3;</code>
   *
   * @return The maxQps.
   */
  int getMaxQps();

  /**
   *
   *
   * <pre>
   * Required. The starting URLs from which the scanner finds site pages.
   * </pre>
   *
   * <code>repeated string starting_urls = 4;</code>
   *
   * @return A list containing the startingUrls.
   */
  java.util.List<java.lang.String> getStartingUrlsList();
  /**
   *
   *
   * <pre>
   * Required. The starting URLs from which the scanner finds site pages.
   * </pre>
   *
   * <code>repeated string starting_urls = 4;</code>
   *
   * @return The count of startingUrls.
   */
  int getStartingUrlsCount();
  /**
   *
   *
   * <pre>
   * Required. The starting URLs from which the scanner finds site pages.
   * </pre>
   *
   * <code>repeated string starting_urls = 4;</code>
   *
   * @param index The index of the element to return.
   * @return The startingUrls at the given index.
   */
  java.lang.String getStartingUrls(int index);
  /**
   *
   *
   * <pre>
   * Required. The starting URLs from which the scanner finds site pages.
   * </pre>
   *
   * <code>repeated string starting_urls = 4;</code>
   *
   * @param index The index of the value to return.
   * @return The bytes of the startingUrls at the given index.
   */
  com.google.protobuf.ByteString getStartingUrlsBytes(int index);

  /**
   *
   *
   * <pre>
   * The authentication configuration. If specified, service will use the
   * authentication configuration during scanning.
   * </pre>
   *
   * <code>.google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;</code>
   *
   * @return Whether the authentication field is set.
   */
  boolean hasAuthentication();
  /**
   *
   *
   * <pre>
   * The authentication configuration. If specified, service will use the
   * authentication configuration during scanning.
   * </pre>
   *
   * <code>.google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;</code>
   *
   * @return The authentication.
   */
  com.google.cloud.websecurityscanner.v1.ScanConfig.Authentication getAuthentication();
  /**
   *
   *
   * <pre>
   * The authentication configuration. If specified, service will use the
   * authentication configuration during scanning.
   * </pre>
   *
   * <code>.google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;</code>
   */
  com.google.cloud.websecurityscanner.v1.ScanConfig.AuthenticationOrBuilder
      getAuthenticationOrBuilder();

  /**
   *
   *
   * <pre>
   * The user agent used during scanning.
   * </pre>
   *
   * <code>.google.cloud.websecurityscanner.v1.ScanConfig.UserAgent user_agent = 6;</code>
   *
   * @return The enum numeric value on the wire for userAgent.
   */
  int getUserAgentValue();
  /**
   *
   *
   * <pre>
   * The user agent used during scanning.
   * </pre>
   *
   * <code>.google.cloud.websecurityscanner.v1.ScanConfig.UserAgent user_agent = 6;</code>
   *
   * @return The userAgent.
   */
  com.google.cloud.websecurityscanner.v1.ScanConfig.UserAgent getUserAgent();

  /**
   *
   *
   * <pre>
   * The excluded URL patterns as described in
   * https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
   * </pre>
   *
   * <code>repeated string blacklist_patterns = 7;</code>
   *
   * @return A list containing the blacklistPatterns.
   */
  java.util.List<java.lang.String> getBlacklistPatternsList();
  /**
   *
   *
   * <pre>
   * The excluded URL patterns as described in
   * https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
   * </pre>
   *
   * <code>repeated string blacklist_patterns = 7;</code>
   *
   * @return The count of blacklistPatterns.
   */
  int getBlacklistPatternsCount();
  /**
   *
   *
   * <pre>
   * The excluded URL patterns as described in
   * https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
   * </pre>
   *
   * <code>repeated string blacklist_patterns = 7;</code>
   *
   * @param index The index of the element to return.
   * @return The blacklistPatterns at the given index.
   */
  java.lang.String getBlacklistPatterns(int index);
  /**
   *
   *
   * <pre>
   * The excluded URL patterns as described in
   * https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
   * </pre>
   *
   * <code>repeated string blacklist_patterns = 7;</code>
   *
   * @param index The index of the value to return.
   * @return The bytes of the blacklistPatterns at the given index.
   */
  com.google.protobuf.ByteString getBlacklistPatternsBytes(int index);

  /**
   *
   *
   * <pre>
   * The schedule of the ScanConfig.
   * </pre>
   *
   * <code>.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;</code>
   *
   * @return Whether the schedule field is set.
   */
  boolean hasSchedule();
  /**
   *
   *
   * <pre>
   * The schedule of the ScanConfig.
   * </pre>
   *
   * <code>.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;</code>
   *
   * @return The schedule.
   */
  com.google.cloud.websecurityscanner.v1.ScanConfig.Schedule getSchedule();
  /**
   *
   *
   * <pre>
   * The schedule of the ScanConfig.
   * </pre>
   *
   * <code>.google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;</code>
   */
  com.google.cloud.websecurityscanner.v1.ScanConfig.ScheduleOrBuilder getScheduleOrBuilder();

  /**
   *
   *
   * <pre>
   * Controls export of scan configurations and results to Security
   * Command Center.
   * </pre>
   *
   * <code>
   * .google.cloud.websecurityscanner.v1.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;
   * </code>
   *
   * @return The enum numeric value on the wire for exportToSecurityCommandCenter.
   */
  int getExportToSecurityCommandCenterValue();
  /**
   *
   *
   * <pre>
   * Controls export of scan configurations and results to Security
   * Command Center.
   * </pre>
   *
   * <code>
   * .google.cloud.websecurityscanner.v1.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;
   * </code>
   *
   * @return The exportToSecurityCommandCenter.
   */
  com.google.cloud.websecurityscanner.v1.ScanConfig.ExportToSecurityCommandCenter
      getExportToSecurityCommandCenter();

  /**
   *
   *
   * <pre>
   * The risk level selected for the scan
   * </pre>
   *
   * <code>.google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel risk_level = 12;</code>
   *
   * @return The enum numeric value on the wire for riskLevel.
   */
  int getRiskLevelValue();
  /**
   *
   *
   * <pre>
   * The risk level selected for the scan
   * </pre>
   *
   * <code>.google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel risk_level = 12;</code>
   *
   * @return The riskLevel.
   */
  com.google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel getRiskLevel();

  /**
   *
   *
   * <pre>
   * Whether the scan config is managed by Web Security Scanner, output
   * only.
   * </pre>
   *
   * <code>bool managed_scan = 13;</code>
   *
   * @return The managedScan.
   */
  boolean getManagedScan();

  /**
   *
   *
   * <pre>
   * Whether the scan configuration has enabled static IP address scan feature.
   * If enabled, the scanner will access applications from static IP addresses.
   * </pre>
   *
   * <code>bool static_ip_scan = 14;</code>
   *
   * @return The staticIpScan.
   */
  boolean getStaticIpScan();

  /**
   *
   *
   * <pre>
   * Whether to keep scanning even if most requests return HTTP error codes.
   * </pre>
   *
   * <code>bool ignore_http_status_errors = 15;</code>
   *
   * @return The ignoreHttpStatusErrors.
   */
  boolean getIgnoreHttpStatusErrors();
}