Documentation

Google_Service_WebSecurityScanner_Resource_ProjectsScanConfigs extends Google_Service_Resource
in package

Application

The "scanConfigs" collection of methods.

Typical usage is: $websecurityscannerService = new Google_Service_WebSecurityScanner(...); $scanConfigs = $websecurityscannerService->scanConfigs;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_WebSecurityScanner_ScanConfig: Creates a new ScanConfig. (scanConfigs.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_WebSecurityScanner_WebsecurityscannerEmpty: Deletes an existing ScanConfig and its child resources. (scanConfigs.delete)
get() : Google_Service_WebSecurityScanner_ScanConfig: Gets a ScanConfig. (scanConfigs.get)
listProjectsScanConfigs() : Google_Service_WebSecurityScanner_ListScanConfigsResponse: Lists ScanConfigs under a given project.
patch() : Google_Service_WebSecurityScanner_ScanConfig: Updates a ScanConfig. This method support partial update of a ScanConfig.
start() : Google_Service_WebSecurityScanner_ScanRun: Start a ScanRun according to the given ScanConfig. (scanConfigs.start)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a new ScanConfig. (scanConfigs.create)


    public
                create(string $parent, Google_Service_WebSecurityScanner_ScanConfig $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_WebSecurityScanner_ScanConfig

Parameters

$parent : string: Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.
$postBody : Google_Service_WebSecurityScanner_ScanConfig
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_WebSecurityScanner_ScanConfig —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes an existing ScanConfig and its child resources. (scanConfigs.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_WebSecurityScanner_WebsecurityscannerEmpty

Parameters

$name : string: Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_WebSecurityScanner_WebsecurityscannerEmpty —

get()

Gets a ScanConfig. (scanConfigs.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_WebSecurityScanner_ScanConfig

Parameters

$name : string: Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_WebSecurityScanner_ScanConfig —

listProjectsScanConfigs()

Lists ScanConfigs under a given project.


    public
                listProjectsScanConfigs(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_WebSecurityScanner_ListScanConfigsResponse

(scanConfigs.listProjectsScanConfigs)

Parameters

$parent : string: Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_WebSecurityScanner_ListScanConfigsResponse —

patch()

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


    public
                patch(string $name, Google_Service_WebSecurityScanner_ScanConfig $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_WebSecurityScanner_ScanConfig

(scanConfigs.patch)

Parameters

$name : string: The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
$postBody : Google_Service_WebSecurityScanner_ScanConfig
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_WebSecurityScanner_ScanConfig —

start()

Start a ScanRun according to the given ScanConfig. (scanConfigs.start)


    public
                start(string $name, Google_Service_WebSecurityScanner_StartScanRunRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_WebSecurityScanner_ScanRun

Parameters

$name : string: Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
$postBody : Google_Service_WebSecurityScanner_StartScanRunRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_WebSecurityScanner_ScanRun —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —