GoogleApi.WebSecurityScanner.V1alpha.Api.Projects (google_api_web_security_scanner v0.19.0)

@spec websecurityscanner_projects_scan_configs_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.ScanConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new ScanConfig.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.WebSecurityScanner.V1alpha.Model.ScanConfig.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.ScanConfig{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_delete(connection, name, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an existing ScanConfig and its child resources.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
name (type: String.t) - Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.Empty{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_get(connection, name, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.ScanConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a ScanConfig.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
name (type: String.t) - Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.ScanConfig{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_list(connection, parent, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.ListScanConfigsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists ScanConfigs under a given project.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (type: integer()) - The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
- :pageToken (type: String.t) - A token identifying a page of results to be returned. This should be a next_page_token value returned from a previous List request. If unspecified, the first page of results is returned.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.ListScanConfigsResponse{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_patch(connection, name, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.ScanConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a ScanConfig. This method support partial update of a ScanConfig.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
name (type: String.t) - The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :updateMask (type: String.t) - Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
- :body (type: GoogleApi.WebSecurityScanner.V1alpha.Model.ScanConfig.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.ScanConfig{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_scan_runs_crawled_urls_list(connection, parent, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_scan_runs_crawled_urls_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.ListCrawledUrlsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List CrawledUrls under a given ScanRun.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (type: integer()) - The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
- :pageToken (type: String.t) - A token identifying a page of results to be returned. This should be a next_page_token value returned from a previous List request. If unspecified, the first page of results is returned.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.ListCrawledUrlsResponse{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_scan_runs_finding_type_stats_list(connection, parent, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_scan_runs_finding_type_stats_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.WebSecurityScanner.V1alpha.Model.ListFindingTypeStatsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all FindingTypeStats under a given ScanRun.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.ListFindingTypeStatsResponse{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_scan_runs_findings_get(connection, name, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_scan_runs_findings_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.Finding.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a Finding.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
name (type: String.t) - Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.Finding{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_scan_runs_findings_list(connection, parent, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_scan_runs_findings_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.ListFindingsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List Findings under a given ScanRun.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :filter (type: String.t) - Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.
- :pageSize (type: integer()) - The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
- :pageToken (type: String.t) - A token identifying a page of results to be returned. This should be a next_page_token value returned from a previous List request. If unspecified, the first page of results is returned.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.ListFindingsResponse{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_scan_runs_get(connection, name, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_scan_runs_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.ScanRun.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a ScanRun.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
name (type: String.t) - Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.ScanRun{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_scan_runs_list(connection, parent, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_scan_runs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.ListScanRunsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (type: integer()) - The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
- :pageToken (type: String.t) - A token identifying a page of results to be returned. This should be a next_page_token value returned from a previous List request. If unspecified, the first page of results is returned.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.ListScanRunsResponse{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_scan_runs_stop(connection, name, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_scan_runs_stop(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.ScanRun.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Stops a ScanRun. The stopped ScanRun is returned.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
name (type: String.t) - Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.WebSecurityScanner.V1alpha.Model.StopScanRunRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.ScanRun{}} on success
{:error, info} on failure

websecurityscanner_projects_scan_configs_start(connection, name, optional_params \\ [], opts \\ [])

@spec websecurityscanner_projects_scan_configs_start(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WebSecurityScanner.V1alpha.Model.ScanRun.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Start a ScanRun according to the given ScanConfig.

Parameters

connection (type: GoogleApi.WebSecurityScanner.V1alpha.Connection.t) - Connection to server
name (type: String.t) - Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.WebSecurityScanner.V1alpha.Model.StartScanRunRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WebSecurityScanner.V1alpha.Model.ScanRun{}} on success
{:error, info} on failure