Class: Google::Privacy::Dlp::V2::JobTrigger

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb

Overview

Contains a configuration to make dlp api calls on a repeating basis.

Defined Under Namespace

Modules: Status Classes: Trigger

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ Google::Protobuf::Timestamp

Returns The creation timestamp of a triggeredJob, output only field.

Returns:



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1577

class JobTrigger
  # What event needs to occur for a new job to be started.
  # @!attribute [rw] schedule
  #   @return [Google::Privacy::Dlp::V2::Schedule]
  #     Create a job on a repeating basis based on the elapse of time.
  class Trigger; end

  # 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.
  module Status
    STATUS_UNSPECIFIED = 0

    # Trigger is healthy.
    HEALTHY = 1

    # Trigger is temporarily paused.
    PAUSED = 2

    # Trigger is cancelled and can not be resumed.
    CANCELLED = 3
  end
end

#description ⇒ String

Returns User provided description (max 256 chars)

Returns:

  • (String) —

    User provided description (max 256 chars)



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1577

class JobTrigger
  # What event needs to occur for a new job to be started.
  # @!attribute [rw] schedule
  #   @return [Google::Privacy::Dlp::V2::Schedule]
  #     Create a job on a repeating basis based on the elapse of time.
  class Trigger; end

  # 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.
  module Status
    STATUS_UNSPECIFIED = 0

    # Trigger is healthy.
    HEALTHY = 1

    # Trigger is temporarily paused.
    PAUSED = 2

    # Trigger is cancelled and can not be resumed.
    CANCELLED = 3
  end
end

#display_name ⇒ String

Returns Display name (max 100 chars)

Returns:

  • (String) —

    Display name (max 100 chars)



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1577

class JobTrigger
  # What event needs to occur for a new job to be started.
  # @!attribute [rw] schedule
  #   @return [Google::Privacy::Dlp::V2::Schedule]
  #     Create a job on a repeating basis based on the elapse of time.
  class Trigger; end

  # 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.
  module Status
    STATUS_UNSPECIFIED = 0

    # Trigger is healthy.
    HEALTHY = 1

    # Trigger is temporarily paused.
    PAUSED = 2

    # Trigger is cancelled and can not be resumed.
    CANCELLED = 3
  end
end

#errors ⇒ Array<Google::Privacy::Dlp::V2::Error>

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

Returns:

  • (Array<Google::Privacy::Dlp::V2::Error>) —

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



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1577

class JobTrigger
  # What event needs to occur for a new job to be started.
  # @!attribute [rw] schedule
  #   @return [Google::Privacy::Dlp::V2::Schedule]
  #     Create a job on a repeating basis based on the elapse of time.
  class Trigger; end

  # 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.
  module Status
    STATUS_UNSPECIFIED = 0

    # Trigger is healthy.
    HEALTHY = 1

    # Trigger is temporarily paused.
    PAUSED = 2

    # Trigger is cancelled and can not be resumed.
    CANCELLED = 3
  end
end

#inspect_job ⇒ Google::Privacy::Dlp::V2::InspectJobConfig

Returns:



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1577

class JobTrigger
  # What event needs to occur for a new job to be started.
  # @!attribute [rw] schedule
  #   @return [Google::Privacy::Dlp::V2::Schedule]
  #     Create a job on a repeating basis based on the elapse of time.
  class Trigger; end

  # 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.
  module Status
    STATUS_UNSPECIFIED = 0

    # Trigger is healthy.
    HEALTHY = 1

    # Trigger is temporarily paused.
    PAUSED = 2

    # Trigger is cancelled and can not be resumed.
    CANCELLED = 3
  end
end

#last_run_time ⇒ Google::Protobuf::Timestamp

Returns The timestamp of the last time this trigger executed, output only field.

Returns:



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1577

class JobTrigger
  # What event needs to occur for a new job to be started.
  # @!attribute [rw] schedule
  #   @return [Google::Privacy::Dlp::V2::Schedule]
  #     Create a job on a repeating basis based on the elapse of time.
  class Trigger; end

  # 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.
  module Status
    STATUS_UNSPECIFIED = 0

    # Trigger is healthy.
    HEALTHY = 1

    # Trigger is temporarily paused.
    PAUSED = 2

    # Trigger is cancelled and can not be resumed.
    CANCELLED = 3
  end
end

#name ⇒ String

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

Returns:

  • (String) —

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



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1577

class JobTrigger
  # What event needs to occur for a new job to be started.
  # @!attribute [rw] schedule
  #   @return [Google::Privacy::Dlp::V2::Schedule]
  #     Create a job on a repeating basis based on the elapse of time.
  class Trigger; end

  # 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.
  module Status
    STATUS_UNSPECIFIED = 0

    # Trigger is healthy.
    HEALTHY = 1

    # Trigger is temporarily paused.
    PAUSED = 2

    # Trigger is cancelled and can not be resumed.
    CANCELLED = 3
  end
end

#status ⇒ Google::Privacy::Dlp::V2::JobTrigger::Status

Returns A status for this trigger. [required]

Returns:



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1577

class JobTrigger
  # What event needs to occur for a new job to be started.
  # @!attribute [rw] schedule
  #   @return [Google::Privacy::Dlp::V2::Schedule]
  #     Create a job on a repeating basis based on the elapse of time.
  class Trigger; end

  # 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.
  module Status
    STATUS_UNSPECIFIED = 0

    # Trigger is healthy.
    HEALTHY = 1

    # Trigger is temporarily paused.
    PAUSED = 2

    # Trigger is cancelled and can not be resumed.
    CANCELLED = 3
  end
end

#triggers ⇒ Array<Google::Privacy::Dlp::V2::JobTrigger::Trigger>

Returns 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.

Returns:

  • (Array<Google::Privacy::Dlp::V2::JobTrigger::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.



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1577

class JobTrigger
  # What event needs to occur for a new job to be started.
  # @!attribute [rw] schedule
  #   @return [Google::Privacy::Dlp::V2::Schedule]
  #     Create a job on a repeating basis based on the elapse of time.
  class Trigger; end

  # 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.
  module Status
    STATUS_UNSPECIFIED = 0

    # Trigger is healthy.
    HEALTHY = 1

    # Trigger is temporarily paused.
    PAUSED = 2

    # Trigger is cancelled and can not be resumed.
    CANCELLED = 3
  end
end

#update_time ⇒ Google::Protobuf::Timestamp

Returns The last update timestamp of a triggeredJob, output only field.

Returns:



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1577

class JobTrigger
  # What event needs to occur for a new job to be started.
  # @!attribute [rw] schedule
  #   @return [Google::Privacy::Dlp::V2::Schedule]
  #     Create a job on a repeating basis based on the elapse of time.
  class Trigger; end

  # 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.
  module Status
    STATUS_UNSPECIFIED = 0

    # Trigger is healthy.
    HEALTHY = 1

    # Trigger is temporarily paused.
    PAUSED = 2

    # Trigger is cancelled and can not be resumed.
    CANCELLED = 3
  end
end