Documentation

Google_Service_DLP_Resource_ProjectsLocationsJobTriggers extends Google_Service_Resource
in package

The "jobTriggers" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
activate()  : Google_Service_DLP_GooglePrivacyDlpV2DlpJob
Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur. (jobTriggers.activate)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_DLP_GooglePrivacyDlpV2JobTrigger
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DLP_GoogleProtobufEmpty
Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job- triggers to learn more. (jobTriggers.delete)
get()  : Google_Service_DLP_GooglePrivacyDlpV2JobTrigger
Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job- triggers to learn more. (jobTriggers.get)
hybridInspect()  : Google_Service_DLP_GooglePrivacyDlpV2HybridInspectResponse
Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.
listProjectsLocationsJobTriggers()  : Google_Service_DLP_GooglePrivacyDlpV2ListJobTriggersResponse
Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job- triggers to learn more. (jobTriggers.listProjectsLocationsJobTriggers)
patch()  : Google_Service_DLP_GooglePrivacyDlpV2JobTrigger
Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job- triggers to learn more. (jobTriggers.patch)
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 —

activate()

Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur. (jobTriggers.activate)

public activate(string $name, Google_Service_DLP_GooglePrivacyDlpV2ActivateJobTriggerRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DLP_GooglePrivacyDlpV2DlpJob
Parameters
$name : string

Required. Resource name of the trigger to activate, for example projects/dlp-test-project/jobTriggers/53234423.

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

Optional parameters.

Return values
Google_Service_DLP_GooglePrivacyDlpV2DlpJob —

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 —

create()

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

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

(jobTriggers.create)

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_GooglePrivacyDlpV2CreateJobTriggerRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DLP_GooglePrivacyDlpV2JobTrigger —

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 job trigger. See https://cloud.google.com/dlp/docs/creating-job- triggers to learn more. (jobTriggers.delete)

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

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

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

Optional parameters.

Return values
Google_Service_DLP_GoogleProtobufEmpty —

get()

Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job- triggers to learn more. (jobTriggers.get)

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

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

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

Optional parameters.

Return values
Google_Service_DLP_GooglePrivacyDlpV2JobTrigger —

hybridInspect()

Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

public hybridInspect(string $name, Google_Service_DLP_GooglePrivacyDlpV2HybridInspectJobTriggerRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DLP_GooglePrivacyDlpV2HybridInspectResponse

(jobTriggers.hybridInspect)

Parameters
$name : string

Required. Resource name of the trigger to execute a hybrid inspect on, for example projects/dlp-test- project/jobTriggers/53234423.

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

Optional parameters.

Return values
Google_Service_DLP_GooglePrivacyDlpV2HybridInspectResponse —

listProjectsLocationsJobTriggers()

Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job- triggers to learn more. (jobTriggers.listProjectsLocationsJobTriggers)

public listProjectsLocationsJobTriggers(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DLP_GooglePrivacyDlpV2ListJobTriggersResponse
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

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: - status - HEALTHY|PAUSED|CANCELLED - inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time- RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be=or!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > "2017-12-12T00:00:00+00:00" The length of this field should be no more than 500 characters.

opt_param

string locationId Deprecated. This field has no effect.

opt_param

int pageSize Size of the page, can be limited by a server.

opt_param

string pageToken Page token to continue retrieval. Comes from previous call to ListJobTriggers. order_by field must not change for subsequent calls.

opt_param

string orderBy Comma separated list of triggeredJob 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,update_time, create_time desc Supported fields are: - create_time: corresponds to time the JobTrigger was created.

  • update_time: corresponds to time the JobTrigger was last updated. - last_run_time: corresponds to the last time the JobTrigger ran. - name: corresponds to JobTrigger's name. - display_name: corresponds to JobTrigger's display name. - status: corresponds to JobTrigger's status.
Return values
Google_Service_DLP_GooglePrivacyDlpV2ListJobTriggersResponse —

patch()

Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job- triggers to learn more. (jobTriggers.patch)

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

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

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

Optional parameters.

Return values
Google_Service_DLP_GooglePrivacyDlpV2JobTrigger —

convertToArrayAndStripNulls()

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

Search results