Console
    Contact Us Start free

    REST Resource: projects.jobTriggers

    Resource: JobTrigger

    Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "triggers" 
 : 
 [ 
 { 
 object (  Trigger 
 
) 
 } 
 ] 
 , 
 "errors" 
 : 
 [ 
 { 
 object (  Error 
 
) 
 } 
 ] 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "lastRunTime" 
 : 
 string 
 , 
 "status" 
 : 
 enum (  Status 
 
) 
 , 
 // Union field job 
can be only one of the following: 
 "inspectJob" 
 : 
 { 
 object (  InspectJobConfig 
 
) 
 } 
 // End of list of possible types for union field job 
. 
 }
    Fields
    name

    string

    Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/jobTriggers/53234423 .

    displayName

    string

    Display name (max 100 chars)

    description

    string

    User provided description (max 256 chars)

    triggers[]

    object ( Trigger )

    A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

    errors[]

    object ( Error )

    Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.

    createTime

    string ( Timestamp format)

    Output only. The creation timestamp of a triggeredJob.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    updateTime

    string ( Timestamp format)

    Output only. The last update timestamp of a triggeredJob.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    lastRunTime

    string ( Timestamp format)

    Output only. The timestamp of the last time this trigger executed.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    status

    enum ( Status )

    Required. A status for this trigger.

    Union field job . The configuration details for the specific type of job to run. job can be only one of the following:
    inspectJob

    object ( InspectJobConfig )

    For inspect jobs, a snapshot of the configuration.

    Trigger

    What event needs to occur for a new job to be started.

    JSON representation 
     { 
 // Union field trigger 
can be only one of the following: 
 "schedule" 
 : 
 { 
 object (  Schedule 
 
) 
 } 
 , 
 "manual" 
 : 
 { 
 object (  Manual 
 
) 
 } 
 // End of list of possible types for union field trigger 
. 
 }
    Fields
    Union field trigger . What event needs to occur for a new job to be started. trigger can be only one of the following:
    schedule

    object ( Schedule )

    Create a job on a repeating basis based on the elapse of time.

    manual

    object ( Manual )

    For use with hybrid jobs. Jobs must be manually created and finished.

    Schedule

    Schedule for inspect job triggers.

    JSON representation 
     { 
 // Union field option 
can be only one of the following: 
 "recurrencePeriodDuration" 
 : 
 string 
 // End of list of possible types for union field option 
. 
 }
    Fields
    Union field option . Type of schedule. option can be only one of the following:
    recurrencePeriodDuration

    string ( Duration format)

    With this option a job is started on a regular periodic basis. For example: every day (86400 seconds).

    A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs.

    This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days.

    A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

    Manual

    This type has no fields.

    Job trigger option for hybrid jobs. Jobs must be manually created and finished.

    Status

    Whether the trigger is currently active. If PAUSED or CANCELLED, no jobs will be created with this configuration. The service may automatically pause triggers experiencing frequent errors. To restart a job, set the status to HEALTHY after correcting user errors.

    Enums
    STATUS_UNSPECIFIED Unused.
    HEALTHY Trigger is healthy.
    PAUSED Trigger is temporarily paused.
    CANCELLED Trigger is cancelled and can not be resumed.

    Methods

    activate

    		Activate a job trigger.

    create

    		Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule.

    delete

    		Deletes a job trigger.

    get

    		Gets a job trigger.

    list

    		Lists job triggers.

    patch

    		Updates a job trigger.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: