Package com.google.cloud.websecurityscanner.v1

Interface ScanConfigOrBuilder

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

  • Method Details

    • getName

      String getName()
       The resource name of the ScanConfig. The name follows the format of
 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
 generated by the system.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The resource name of the ScanConfig. The name follows the format of
 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
 generated by the system.
      string name = 1;
      Returns:
      The bytes for name.

    • getDisplayName

      String getDisplayName()
       Required. The user provided display name of the ScanConfig.
      string display_name = 2;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The user provided display name of the ScanConfig.
      string display_name = 2;
      Returns:
      The bytes for displayName.

    • getMaxQps

      int getMaxQps()
       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.
      int32 max_qps = 3;
      Returns:
      The maxQps.

    • getStartingUrlsList

      List<String> getStartingUrlsList()
       Required. The starting URLs from which the scanner finds site pages.
      repeated string starting_urls = 4;
      Returns:
      A list containing the startingUrls.

    • getStartingUrlsCount

      int getStartingUrlsCount()
       Required. The starting URLs from which the scanner finds site pages.
      repeated string starting_urls = 4;
      Returns:
      The count of startingUrls.

    • getStartingUrls

      String getStartingUrls(int index)
       Required. The starting URLs from which the scanner finds site pages.
      repeated string starting_urls = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The startingUrls at the given index.

    • getStartingUrlsBytes

      com.google.protobuf.ByteString getStartingUrlsBytes(int index)
       Required. The starting URLs from which the scanner finds site pages.
      repeated string starting_urls = 4;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the startingUrls at the given index.

    • hasAuthentication

      boolean hasAuthentication()
       The authentication configuration. If specified, service will use the
 authentication configuration during scanning.
      .google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;
      Returns:
      Whether the authentication field is set.

    • getAuthentication

      ScanConfig.Authentication getAuthentication()
       The authentication configuration. If specified, service will use the
 authentication configuration during scanning.
      .google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;
      Returns:
      The authentication.

    • getAuthenticationOrBuilder

      ScanConfig.AuthenticationOrBuilder getAuthenticationOrBuilder()
       The authentication configuration. If specified, service will use the
 authentication configuration during scanning.
      .google.cloud.websecurityscanner.v1.ScanConfig.Authentication authentication = 5;

    • getUserAgentValue

      int getUserAgentValue()
       The user agent used during scanning.
      .google.cloud.websecurityscanner.v1.ScanConfig.UserAgent user_agent = 6;
      Returns:
      The enum numeric value on the wire for userAgent.

    • getUserAgent

      ScanConfig.UserAgent getUserAgent()
       The user agent used during scanning.
      .google.cloud.websecurityscanner.v1.ScanConfig.UserAgent user_agent = 6;
      Returns:
      The userAgent.

    • getBlacklistPatternsList

      List<String> getBlacklistPatternsList()
       The excluded URL patterns as described in
 https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
      repeated string blacklist_patterns = 7;
      Returns:
      A list containing the blacklistPatterns.

    • getBlacklistPatternsCount

      int getBlacklistPatternsCount()
       The excluded URL patterns as described in
 https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
      repeated string blacklist_patterns = 7;
      Returns:
      The count of blacklistPatterns.

    • getBlacklistPatterns

      String getBlacklistPatterns(int index)
       The excluded URL patterns as described in
 https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
      repeated string blacklist_patterns = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The blacklistPatterns at the given index.

    • getBlacklistPatternsBytes

      com.google.protobuf.ByteString getBlacklistPatternsBytes(int index)
       The excluded URL patterns as described in
 https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
      repeated string blacklist_patterns = 7;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the blacklistPatterns at the given index.

    • hasSchedule

      boolean hasSchedule()
       The schedule of the ScanConfig.
      .google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;
      Returns:
      Whether the schedule field is set.

    • getSchedule

      ScanConfig.Schedule getSchedule()
       The schedule of the ScanConfig.
      .google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;
      Returns:
      The schedule.

    • getScheduleOrBuilder

      ScanConfig.ScheduleOrBuilder getScheduleOrBuilder()
       The schedule of the ScanConfig.
      .google.cloud.websecurityscanner.v1.ScanConfig.Schedule schedule = 8;

    • getExportToSecurityCommandCenterValue

      int getExportToSecurityCommandCenterValue()
       Controls export of scan configurations and results to Security
 Command Center.
      .google.cloud.websecurityscanner.v1.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;
      Returns:
      The enum numeric value on the wire for exportToSecurityCommandCenter.

    • getExportToSecurityCommandCenter

      ScanConfig.ExportToSecurityCommandCenter getExportToSecurityCommandCenter()
       Controls export of scan configurations and results to Security
 Command Center.
      .google.cloud.websecurityscanner.v1.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;
      Returns:
      The exportToSecurityCommandCenter.

    • getRiskLevelValue

      int getRiskLevelValue()
       The risk level selected for the scan
      .google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel risk_level = 12;
      Returns:
      The enum numeric value on the wire for riskLevel.

    • getRiskLevel

      ScanConfig.RiskLevel getRiskLevel()
       The risk level selected for the scan
      .google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel risk_level = 12;
      Returns:
      The riskLevel.

    • getManagedScan

      boolean getManagedScan()
       Whether the scan config is managed by Web Security Scanner, output
 only.
      bool managed_scan = 13;
      Returns:
      The managedScan.

    • getStaticIpScan

      boolean getStaticIpScan()
       Whether the scan configuration has enabled static IP address scan feature.
 If enabled, the scanner will access applications from static IP addresses.
      bool static_ip_scan = 14;
      Returns:
      The staticIpScan.

    • getIgnoreHttpStatusErrors

      boolean getIgnoreHttpStatusErrors()
       Whether to keep scanning even if most requests return HTTP error codes.
      bool ignore_http_status_errors = 15;
      Returns:
      The ignoreHttpStatusErrors.