Class: Google::Privacy::Dlp::V2::DlpJob

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

Overview

Combines all of the information about a DLP job.

Defined Under Namespace

Modules: JobState

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ Google::Protobuf::Timestamp

Returns Time when the job was created.

Returns:



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1896

class DlpJob
  module JobState
    JOB_STATE_UNSPECIFIED = 0

    # The job has not yet started.
    PENDING = 1

    # The job is currently running.
    RUNNING = 2

    # The job is no longer running.
    DONE = 3

    # The job was canceled before it could complete.
    CANCELED = 4

    # The job had an error and did not complete.
    FAILED = 5
  end
end

#end_time ⇒ Google::Protobuf::Timestamp

Returns Time when the job finished.

Returns:



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1896

class DlpJob
  module JobState
    JOB_STATE_UNSPECIFIED = 0

    # The job has not yet started.
    PENDING = 1

    # The job is currently running.
    RUNNING = 2

    # The job is no longer running.
    DONE = 3

    # The job was canceled before it could complete.
    CANCELED = 4

    # The job had an error and did not complete.
    FAILED = 5
  end
end

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

Returns A stream of errors encountered running the job.

Returns:



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1896

class DlpJob
  module JobState
    JOB_STATE_UNSPECIFIED = 0

    # The job has not yet started.
    PENDING = 1

    # The job is currently running.
    RUNNING = 2

    # The job is no longer running.
    DONE = 3

    # The job was canceled before it could complete.
    CANCELED = 4

    # The job had an error and did not complete.
    FAILED = 5
  end
end

#inspect_details ⇒ Google::Privacy::Dlp::V2::InspectDataSourceDetails

Returns Results from inspecting a data source.

Returns:



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1896

class DlpJob
  module JobState
    JOB_STATE_UNSPECIFIED = 0

    # The job has not yet started.
    PENDING = 1

    # The job is currently running.
    RUNNING = 2

    # The job is no longer running.
    DONE = 3

    # The job was canceled before it could complete.
    CANCELED = 4

    # The job had an error and did not complete.
    FAILED = 5
  end
end

#job_trigger_name ⇒ String

Returns If created by a job trigger, the resource name of the trigger that instantiated the job.

Returns:

  • (String) —

    If created by a job trigger, the resource name of the trigger that instantiated the job.



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1896

class DlpJob
  module JobState
    JOB_STATE_UNSPECIFIED = 0

    # The job has not yet started.
    PENDING = 1

    # The job is currently running.
    RUNNING = 2

    # The job is no longer running.
    DONE = 3

    # The job was canceled before it could complete.
    CANCELED = 4

    # The job had an error and did not complete.
    FAILED = 5
  end
end

#name ⇒ String

Returns The server-assigned name.

Returns:

  • (String) —

    The server-assigned name.



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1896

class DlpJob
  module JobState
    JOB_STATE_UNSPECIFIED = 0

    # The job has not yet started.
    PENDING = 1

    # The job is currently running.
    RUNNING = 2

    # The job is no longer running.
    DONE = 3

    # The job was canceled before it could complete.
    CANCELED = 4

    # The job had an error and did not complete.
    FAILED = 5
  end
end

#risk_details ⇒ Google::Privacy::Dlp::V2::AnalyzeDataSourceRiskDetails

Returns Results from analyzing risk of a data source.

Returns:



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1896

class DlpJob
  module JobState
    JOB_STATE_UNSPECIFIED = 0

    # The job has not yet started.
    PENDING = 1

    # The job is currently running.
    RUNNING = 2

    # The job is no longer running.
    DONE = 3

    # The job was canceled before it could complete.
    CANCELED = 4

    # The job had an error and did not complete.
    FAILED = 5
  end
end

#start_time ⇒ Google::Protobuf::Timestamp

Returns Time when the job started.

Returns:



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1896

class DlpJob
  module JobState
    JOB_STATE_UNSPECIFIED = 0

    # The job has not yet started.
    PENDING = 1

    # The job is currently running.
    RUNNING = 2

    # The job is no longer running.
    DONE = 3

    # The job was canceled before it could complete.
    CANCELED = 4

    # The job had an error and did not complete.
    FAILED = 5
  end
end

#state ⇒ Google::Privacy::Dlp::V2::DlpJob::JobState

Returns State of a job.

Returns:



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1896

class DlpJob
  module JobState
    JOB_STATE_UNSPECIFIED = 0

    # The job has not yet started.
    PENDING = 1

    # The job is currently running.
    RUNNING = 2

    # The job is no longer running.
    DONE = 3

    # The job was canceled before it could complete.
    CANCELED = 4

    # The job had an error and did not complete.
    FAILED = 5
  end
end

#type ⇒ Google::Privacy::Dlp::V2::DlpJobType

Returns The type of job.

Returns:



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 1896

class DlpJob
  module JobState
    JOB_STATE_UNSPECIFIED = 0

    # The job has not yet started.
    PENDING = 1

    # The job is currently running.
    RUNNING = 2

    # The job is no longer running.
    DONE = 3

    # The job was canceled before it could complete.
    CANCELED = 4

    # The job had an error and did not complete.
    FAILED = 5
  end
end