Documentation

Google_Service_DLP_Resource_ProjectsDlpJobs extends Google_Service_Resource
in package

The "dlpJobs" collection of methods.

Typical usage is: $dlpService = new Google_Service_DLP(...); $dlpJobs = $dlpService->dlpJobs;

Table of Contents

$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.
cancel()  : Google_Service_DLP_GoogleProtobufEmpty
Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
create()  : Google_Service_DLP_GooglePrivacyDlpV2DlpJob
Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. (dlpJobs.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DLP_GoogleProtobufEmpty
Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be cancelled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
get()  : Google_Service_DLP_GooglePrivacyDlpV2DlpJob
Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
listProjectsDlpJobs()  : Google_Service_DLP_GooglePrivacyDlpV2ListDlpJobsResponse
Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

cancel()

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

public cancel(string $name, Google_Service_DLP_GooglePrivacyDlpV2CancelDlpJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DLP_GoogleProtobufEmpty

(dlpJobs.cancel)

Parameters
$name : string

Required. The name of the DlpJob resource to be cancelled.

$postBody : Google_Service_DLP_GooglePrivacyDlpV2CancelDlpJobRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DLP_GoogleProtobufEmpty —

create()

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. (dlpJobs.create)

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

Required. Parent resource name. The format of this value varies depending on whether you have specified a processing location: + Projects scope, location specified: projects/PROJECT_ID/locations/LOCATION_ID + Projects scope, no location specified (defaults to global): projects/PROJECT_ID The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data: parent=projects/example- project/locations/europe-west3

$postBody : Google_Service_DLP_GooglePrivacyDlpV2CreateDlpJobRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DLP_GooglePrivacyDlpV2DlpJob —

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>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be cancelled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

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

(dlpJobs.delete)

Parameters
$name : string

Required. The name of the DlpJob resource to be deleted.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DLP_GoogleProtobufEmpty —

get()

Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

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

(dlpJobs.get)

Parameters
$name : string

Required. The name of the DlpJob resource.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DLP_GooglePrivacyDlpV2DlpJob —

listProjectsDlpJobs()

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

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

(dlpJobs.listProjectsDlpJobs)

Parameters
$parent : string

Required. Parent resource name. The format of this value varies depending on whether you have specified a processing location: + Projects scope, location specified: projects/PROJECT_ID/locations/LOCATION_ID + Projects scope, no location specified (defaults to global): projects/PROJECT_ID The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data: parent=projects/example- project/locations/europe-west3

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize The standard list page size.

opt_param

string pageToken The standard list page token.

opt_param

string locationId Deprecated. This field has no effect.

opt_param

string orderBy Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: name asc, end_time asc, create_time desc Supported fields are: - create_time: corresponds to time the job was created. - end_time: corresponds to time the job ended. - name: corresponds to job's name. - state: corresponds to state

opt_param

string filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of {field} {operator} {value}. * Supported fields/values for inspect jobs: - state - PENDING|RUNNING|CANCELED|FINISHED|FAILED - inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY - trigger_name - The resource name of the trigger that created job. - 'end_time - Corresponds to time the job finished. - 'start_time - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - state - RUNNING|CANCELED|FINISHED|FAILED - 'end_time - Corresponds to time the job finished. - 'start_time - Corresponds to time the job finished. * The operator must be = or !=. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > "2017-12-12T00:00:00+00:00" The length of this field should be no more than 500 characters.

opt_param

string type The type of job. Defaults to DlpJobType.INSPECT

Return values
Google_Service_DLP_GooglePrivacyDlpV2ListDlpJobsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results