Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::CreateDlpJobRequest (v1.15.0)

Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::CreateDlpJobRequest.

Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#inspect_job

def inspect_job() -> ::Google::Cloud::Dlp::V2::InspectJobConfig
Returns
  • (::Google::Cloud::Dlp::V2::InspectJobConfig) — An inspection job scans a storage repository for InfoTypes.

    Note: The following fields are mutually exclusive: inspect_job, risk_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

#inspect_job=

def inspect_job=(value) -> ::Google::Cloud::Dlp::V2::InspectJobConfig
Parameter
  • value (::Google::Cloud::Dlp::V2::InspectJobConfig) — An inspection job scans a storage repository for InfoTypes.

    Note: The following fields are mutually exclusive: inspect_job, risk_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dlp::V2::InspectJobConfig) — An inspection job scans a storage repository for InfoTypes.

    Note: The following fields are mutually exclusive: inspect_job, risk_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

#job_id

def job_id() -> ::String
Returns
  • (::String) — The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

#job_id=

def job_id=(value) -> ::String
Parameter
  • value (::String) — The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.
Returns
  • (::String) — The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

#location_id

def location_id() -> ::String
Returns
  • (::String) — Deprecated. This field has no effect.

#location_id=

def location_id=(value) -> ::String
Parameter
  • value (::String) — Deprecated. This field has no effect.
Returns
  • (::String) — Deprecated. This field has no effect.

#parent

def parent() -> ::String
Returns
  • (::String) —

    Required. Parent resource name.

    The format of this value varies depending on whether you have specified a processing location:

    • Projects scope, location specified: projects/{project_id}/locations/{location_id}
    • Projects scope, no location specified (defaults to global): projects/{project_id}

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) —

    Required. Parent resource name.

    The format of this value varies depending on whether you have specified a processing location:

    • Projects scope, location specified: projects/{project_id}/locations/{location_id}
    • Projects scope, no location specified (defaults to global): projects/{project_id}

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
  • (::String) —

    Required. Parent resource name.

    The format of this value varies depending on whether you have specified a processing location:

    • Projects scope, location specified: projects/{project_id}/locations/{location_id}
    • Projects scope, no location specified (defaults to global): projects/{project_id}

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3

#risk_job

def risk_job() -> ::Google::Cloud::Dlp::V2::RiskAnalysisJobConfig
Returns
  • (::Google::Cloud::Dlp::V2::RiskAnalysisJobConfig) — A risk analysis job calculates re-identification risk metrics for a BigQuery table.

    Note: The following fields are mutually exclusive: risk_job, inspect_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

#risk_job=

def risk_job=(value) -> ::Google::Cloud::Dlp::V2::RiskAnalysisJobConfig
Parameter
  • value (::Google::Cloud::Dlp::V2::RiskAnalysisJobConfig) — A risk analysis job calculates re-identification risk metrics for a BigQuery table.

    Note: The following fields are mutually exclusive: risk_job, inspect_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dlp::V2::RiskAnalysisJobConfig) — A risk analysis job calculates re-identification risk metrics for a BigQuery table.

    Note: The following fields are mutually exclusive: risk_job, inspect_job. If a field in that set is populated, all other fields in the set will automatically be cleared.