Package com.google.cloud.websecurityscanner.v1beta

Interface ScanConfigOrBuilder

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

    • Method Detail

      • 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 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The user provided display name of the ScanConfig.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        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 [(.google.api.field_behavior) = REQUIRED];
        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 [(.google.api.field_behavior) = REQUIRED];
        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 [(.google.api.field_behavior) = REQUIRED];
        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 [(.google.api.field_behavior) = REQUIRED];
        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.v1beta.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.v1beta.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.v1beta.ScanConfig.Authentication authentication = 5;

      • getUserAgentValue

        int getUserAgentValue()
         The user agent used during scanning.
        .google.cloud.websecurityscanner.v1beta.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.v1beta.ScanConfig.UserAgent user_agent = 6;
        Returns:
        The userAgent.

      • getBlacklistPatternsList

        List<String> getBlacklistPatternsList()
         The blacklist URL patterns as described in
 https://cloud.google.com/security-scanner/docs/excluded-urls
        repeated string blacklist_patterns = 7;
        Returns:
        A list containing the blacklistPatterns.

      • getBlacklistPatternsCount

        int getBlacklistPatternsCount()
         The blacklist URL patterns as described in
 https://cloud.google.com/security-scanner/docs/excluded-urls
        repeated string blacklist_patterns = 7;
        Returns:
        The count of blacklistPatterns.

      • getBlacklistPatterns

        String getBlacklistPatterns​(int index)
         The blacklist URL patterns as described in
 https://cloud.google.com/security-scanner/docs/excluded-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 blacklist URL patterns as described in
 https://cloud.google.com/security-scanner/docs/excluded-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.v1beta.ScanConfig.Schedule schedule = 8;
        Returns:
        Whether the schedule field is set.

      • getSchedule

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

      • getScheduleOrBuilder

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

      • getTargetPlatformsList

        List<ScanConfig.TargetPlatform> getTargetPlatformsList()
         Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
 used as a default.
        repeated .google.cloud.websecurityscanner.v1beta.ScanConfig.TargetPlatform target_platforms = 9;
        Returns:
        A list containing the targetPlatforms.

      • getTargetPlatformsCount

        int getTargetPlatformsCount()
         Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
 used as a default.
        repeated .google.cloud.websecurityscanner.v1beta.ScanConfig.TargetPlatform target_platforms = 9;
        Returns:
        The count of targetPlatforms.

      • getTargetPlatforms

        ScanConfig.TargetPlatform getTargetPlatforms​(int index)
         Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
 used as a default.
        repeated .google.cloud.websecurityscanner.v1beta.ScanConfig.TargetPlatform target_platforms = 9;
        Parameters:
        index - The index of the element to return.
        Returns:
        The targetPlatforms at the given index.

      • getTargetPlatformsValueList

        List<Integer> getTargetPlatformsValueList()
         Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
 used as a default.
        repeated .google.cloud.websecurityscanner.v1beta.ScanConfig.TargetPlatform target_platforms = 9;
        Returns:
        A list containing the enum numeric values on the wire for targetPlatforms.

      • getTargetPlatformsValue

        int getTargetPlatformsValue​(int index)
         Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
 used as a default.
        repeated .google.cloud.websecurityscanner.v1beta.ScanConfig.TargetPlatform target_platforms = 9;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of targetPlatforms at the given index.

      • getExportToSecurityCommandCenterValue

        int getExportToSecurityCommandCenterValue()
         Controls export of scan configurations and results to Cloud Security
 Command Center.
        .google.cloud.websecurityscanner.v1beta.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 Cloud Security
 Command Center.
        .google.cloud.websecurityscanner.v1beta.ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10;
        Returns:
        The exportToSecurityCommandCenter.

      • hasLatestRun

        boolean hasLatestRun()
         Latest ScanRun if available.
        .google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;
        Returns:
        Whether the latestRun field is set.

      • getLatestRun

        ScanRun getLatestRun()
         Latest ScanRun if available.
        .google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;
        Returns:
        The latestRun.

      • getLatestRunOrBuilder

        ScanRunOrBuilder getLatestRunOrBuilder()
         Latest ScanRun if available.
        .google.cloud.websecurityscanner.v1beta.ScanRun latest_run = 11;

      • getRiskLevelValue

        int getRiskLevelValue()
         The risk level selected for the scan
        .google.cloud.websecurityscanner.v1beta.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.v1beta.ScanConfig.RiskLevel risk_level = 12;
        Returns:
        The riskLevel.