type: com.google.api.codegen.ConfigProto config_schema_version: 1.0.0 # The settings of generated code in a specific language. language_settings: java: package_name: com.google.cloud.websecurityscanner.v1alpha python: package_name: google.cloud.websecurityscanner_v1alpha.gapic go: package_name: cloud.google.com/go/cloud/websecurityscanner/apiv1alpha csharp: package_name: Google.Cloud.Websecurityscanner.V1Alpha ruby: package_name: Google::Cloud::Websecurityscanner::V1alpha php: package_name: Google\Cloud\Websecurityscanner\V1alpha nodejs: package_name: websecurityscanner.v1alpha # A list of API interface configurations. interfaces: # The fully qualified name of the API interface. - name: google.cloud.websecurityscanner.v1alpha.WebSecurityScanner # A list of resource collection configurations. # Consists of a name_pattern and an entity_name. # The name_pattern is a pattern to describe the names of the resources of this # collection, using the platform's conventions for URI patterns. A generator # may use this to generate methods to compose and decompose such names. The # pattern should use named placeholders as in `shelves/{shelf}/books/{book}`; # those will be taken as hints for the parameter names of the generated # methods. If empty, no name methods are generated. # The entity_name is the name to be used as a basis for generated methods and # classes. collections: - name_pattern: projects/{project} entity_name: project language_overrides: - language: csharp common_resource_name: Google.Api.Gax.ResourceNames.ProjectName - name_pattern: projects/{project}/scanConfigs/{scan_config} entity_name: scan_config - name_pattern: projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run} entity_name: scan_run - name_pattern: projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/findings/{finding} entity_name: finding # Definition for retryable codes. retry_codes_def: - name: idempotent retry_codes: - UNAVAILABLE - DEADLINE_EXCEEDED - name: non_idempotent retry_codes: [] # Definition for retry/backoff parameters. retry_params_def: - name: default initial_retry_delay_millis: 100 retry_delay_multiplier: 1.3 max_retry_delay_millis: 60000 initial_rpc_timeout_millis: 20000 rpc_timeout_multiplier: 1 max_rpc_timeout_millis: 20000 total_timeout_millis: 600000 # A list of method configurations. # Common properties: # # name - The simple name of the method. # # flattening - Specifies the configuration for parameter flattening. # Describes the parameter groups for which a generator should produce method # overloads which allow a client to directly pass request message fields as # method parameters. This information may or may not be used, depending on # the target language. # Consists of groups, which each represent a list of parameters to be # flattened. Each parameter listed must be a field of the request message. # # required_fields - Fields that are always required for a request to be # valid. # # resource_name_treatment - An enum that specifies how to treat the resource # name formats defined in the field_name_patterns and # response_field_name_patterns fields. # UNSET: default value # NONE: the collection configs will not be used by the generated code. # VALIDATE: string fields will be validated by the client against the # specified resource name formats. # STATIC_TYPES: the client will use generated types for resource names. # # page_streaming - Specifies the configuration for paging. # Describes information for generating a method which transforms a paging # list RPC into a stream of resources. # Consists of a request and a response. # The request specifies request information of the list method. It defines # which fields match the paging pattern in the request. The request consists # of a page_size_field and a token_field. The page_size_field is the name of # the optional field specifying the maximum number of elements to be # returned in the response. The token_field is the name of the field in the # request containing the page token. # The response specifies response information of the list method. It defines # which fields match the paging pattern in the response. The response # consists of a token_field and a resources_field. The token_field is the # name of the field in the response containing the next page token. The # resources_field is the name of the field in the response containing the # list of resources belonging to the page. # # retry_codes_name - Specifies the configuration for retryable codes. The # name must be defined in interfaces.retry_codes_def. # # retry_params_name - Specifies the configuration for retry/backoff # parameters. The name must be defined in interfaces.retry_params_def. # # field_name_patterns - Maps the field name of the request type to # entity_name of interfaces.collections. # Specifies the string pattern that the field must follow. # # timeout_millis - Specifies the default timeout for a non-retrying call. If # the call is retrying, refer to retry_params_name instead. methods: - name: CreateScanConfig flattening: groups: - parameters: - parent - scan_config required_fields: - parent - scan_config retry_codes_name: non_idempotent retry_params_name: default field_name_patterns: parent: project timeout_millis: 60000 resource_name_treatment: STATIC_TYPES - name: DeleteScanConfig flattening: groups: - parameters: - name required_fields: - name retry_codes_name: idempotent retry_params_name: default field_name_patterns: name: scan_config timeout_millis: 60000 resource_name_treatment: STATIC_TYPES - name: GetScanConfig flattening: groups: - parameters: - name required_fields: - name retry_codes_name: idempotent retry_params_name: default field_name_patterns: name: scan_config timeout_millis: 60000 resource_name_treatment: STATIC_TYPES - name: ListScanConfigs flattening: groups: - parameters: - parent required_fields: - parent page_streaming: request: page_size_field: page_size token_field: page_token response: token_field: next_page_token resources_field: scan_configs retry_codes_name: idempotent retry_params_name: default field_name_patterns: parent: project timeout_millis: 60000 resource_name_treatment: STATIC_TYPES - name: UpdateScanConfig flattening: groups: - parameters: - scan_config - update_mask required_fields: - scan_config - update_mask retry_codes_name: non_idempotent retry_params_name: default field_name_patterns: scan_config.name: scan_config timeout_millis: 60000 - name: StartScanRun flattening: groups: - parameters: - name required_fields: - name retry_codes_name: non_idempotent retry_params_name: default field_name_patterns: name: scan_config timeout_millis: 60000 resource_name_treatment: STATIC_TYPES - name: GetScanRun flattening: groups: - parameters: - name required_fields: - name retry_codes_name: idempotent retry_params_name: default field_name_patterns: name: scan_run timeout_millis: 60000 resource_name_treatment: STATIC_TYPES - name: ListScanRuns flattening: groups: - parameters: - parent required_fields: - parent page_streaming: request: page_size_field: page_size token_field: page_token response: token_field: next_page_token resources_field: scan_runs retry_codes_name: idempotent retry_params_name: default field_name_patterns: parent: scan_config timeout_millis: 60000 resource_name_treatment: STATIC_TYPES - name: StopScanRun flattening: groups: - parameters: - name required_fields: - name retry_codes_name: non_idempotent retry_params_name: default field_name_patterns: name: scan_run timeout_millis: 60000 resource_name_treatment: STATIC_TYPES - name: ListCrawledUrls flattening: groups: - parameters: - parent required_fields: - parent page_streaming: request: page_size_field: page_size token_field: page_token response: token_field: next_page_token resources_field: crawled_urls retry_codes_name: idempotent retry_params_name: default field_name_patterns: parent: scan_run timeout_millis: 60000 resource_name_treatment: STATIC_TYPES - name: GetFinding flattening: groups: - parameters: - name required_fields: - name retry_codes_name: idempotent retry_params_name: default field_name_patterns: name: finding timeout_millis: 60000 resource_name_treatment: STATIC_TYPES - name: ListFindings flattening: groups: - parameters: - parent - filter required_fields: - parent - filter page_streaming: request: page_size_field: page_size token_field: page_token response: token_field: next_page_token resources_field: findings retry_codes_name: idempotent retry_params_name: default field_name_patterns: parent: scan_run timeout_millis: 60000 resource_name_treatment: STATIC_TYPES - name: ListFindingTypeStats flattening: groups: - parameters: - parent required_fields: - parent retry_codes_name: idempotent retry_params_name: default field_name_patterns: parent: scan_run timeout_millis: 60000 resource_name_treatment: STATIC_TYPES resource_name_generation: - message_name: CreateScanConfigRequest field_entity_map: parent: project - message_name: DeleteScanConfigRequest field_entity_map: name: scan_config - message_name: GetScanConfigRequest field_entity_map: name: scan_config - message_name: ListScanConfigsRequest field_entity_map: parent: project - message_name: StartScanRunRequest field_entity_map: name: scan_config - message_name: GetScanRunRequest field_entity_map: name: scan_run - message_name: ListScanRunsRequest field_entity_map: parent: scan_config - message_name: StopScanRunRequest field_entity_map: name: scan_run - message_name: ListCrawledUrlsRequest field_entity_map: parent: scan_run - message_name: GetFindingRequest field_entity_map: name: finding - message_name: ListFindingsRequest field_entity_map: parent: scan_run - message_name: ListFindingTypeStatsRequest field_entity_map: parent: scan_run