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

Inherits:

Object

• Object
• Google::Privacy::Dlp::V2::DlpJob

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

• #create_time ⇒ Google::Protobuf::Timestamp

  Time when the job was created.

• #end_time ⇒ Google::Protobuf::Timestamp

  Time when the job finished.

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

  A stream of errors encountered running the job.

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

  Results from inspecting a data source.

• #job_trigger_name ⇒ String

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

• #name ⇒ String

  The server-assigned name.

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

  Results from analyzing risk of a data source.

• #start_time ⇒ Google::Protobuf::Timestamp

  Time when the job started.

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

  State of a job.

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

  The type of job.

Instance Attribute Details

#create_time ⇒ Google::Protobuf::Timestamp

Returns Time when the job was created.

Returns:

• (Google::Protobuf::Timestamp) —

  Time when the job was created.

# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2251

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:

• (Google::Protobuf::Timestamp) —

  Time when the job finished.

# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2251

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:

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

  A stream of errors encountered running the job.

# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2251

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:

• (Google::Privacy::Dlp::V2::InspectDataSourceDetails) —

  Results from inspecting a data source.

# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2251

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.

# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2251

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.

# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2251

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:

• (Google::Privacy::Dlp::V2::AnalyzeDataSourceRiskDetails) —

  Results from analyzing risk of a data source.

# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2251

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:

• (Google::Protobuf::Timestamp) —

  Time when the job started.

# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2251

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:

• (Google::Privacy::Dlp::V2::DlpJob::JobState) —

  State of a job.

# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2251

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:

• (Google::Privacy::Dlp::V2::DlpJobType) —

  The type of job.

# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2251

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