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. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.

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:



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1906

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)



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1906

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)



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1906

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 automatically 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 automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared. Output only field.



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1906

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:



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1906

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:



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1906

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.



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1906

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:



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1906

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.



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1906

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:



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1906

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