Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::BigQueryOptions (v0.19.0)

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

Options defining BigQuery table and row identifiers.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#excluded_fields

def excluded_fields() -> ::Array<::Google::Cloud::Dlp::V2::FieldId>
Returns
  • (::Array<::Google::Cloud::Dlp::V2::FieldId>) — References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings. When inspecting a table, we recommend that you inspect all columns. Otherwise, findings might be affected because hints from excluded columns will not be used.

#excluded_fields=

def excluded_fields=(value) -> ::Array<::Google::Cloud::Dlp::V2::FieldId>
Parameter
  • value (::Array<::Google::Cloud::Dlp::V2::FieldId>) — References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings. When inspecting a table, we recommend that you inspect all columns. Otherwise, findings might be affected because hints from excluded columns will not be used.
Returns
  • (::Array<::Google::Cloud::Dlp::V2::FieldId>) — References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings. When inspecting a table, we recommend that you inspect all columns. Otherwise, findings might be affected because hints from excluded columns will not be used.

#identifying_fields

def identifying_fields() -> ::Array<::Google::Cloud::Dlp::V2::FieldId>
Returns
  • (::Array<::Google::Cloud::Dlp::V2::FieldId>) — Table fields that may uniquely identify a row within the table. When actions.saveFindings.outputConfig.table is specified, the values of columns specified here are available in the output table under location.content_locations.record_location.record_key.id_values. Nested fields such as person.birthdate.year are allowed.

#identifying_fields=

def identifying_fields=(value) -> ::Array<::Google::Cloud::Dlp::V2::FieldId>
Parameter
  • value (::Array<::Google::Cloud::Dlp::V2::FieldId>) — Table fields that may uniquely identify a row within the table. When actions.saveFindings.outputConfig.table is specified, the values of columns specified here are available in the output table under location.content_locations.record_location.record_key.id_values. Nested fields such as person.birthdate.year are allowed.
Returns
  • (::Array<::Google::Cloud::Dlp::V2::FieldId>) — Table fields that may uniquely identify a row within the table. When actions.saveFindings.outputConfig.table is specified, the values of columns specified here are available in the output table under location.content_locations.record_location.record_key.id_values. Nested fields such as person.birthdate.year are allowed.

#included_fields

def included_fields() -> ::Array<::Google::Cloud::Dlp::V2::FieldId>
Returns
  • (::Array<::Google::Cloud::Dlp::V2::FieldId>) — Limit scanning only to these fields. When inspecting a table, we recommend that you inspect all columns. Otherwise, findings might be affected because hints from excluded columns will not be used.

#included_fields=

def included_fields=(value) -> ::Array<::Google::Cloud::Dlp::V2::FieldId>
Parameter
  • value (::Array<::Google::Cloud::Dlp::V2::FieldId>) — Limit scanning only to these fields. When inspecting a table, we recommend that you inspect all columns. Otherwise, findings might be affected because hints from excluded columns will not be used.
Returns
  • (::Array<::Google::Cloud::Dlp::V2::FieldId>) — Limit scanning only to these fields. When inspecting a table, we recommend that you inspect all columns. Otherwise, findings might be affected because hints from excluded columns will not be used.

#rows_limit

def rows_limit() -> ::Integer
Returns
  • (::Integer) — Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

#rows_limit=

def rows_limit=(value) -> ::Integer
Parameter
  • value (::Integer) — Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.
Returns
  • (::Integer) — Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

#rows_limit_percent

def rows_limit_percent() -> ::Integer
Returns
  • (::Integer) — Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

#rows_limit_percent=

def rows_limit_percent=(value) -> ::Integer
Parameter
  • value (::Integer) — Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.
Returns
  • (::Integer) — Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

#sample_method

def sample_method() -> ::Google::Cloud::Dlp::V2::BigQueryOptions::SampleMethod
Returns

#sample_method=

def sample_method=(value) -> ::Google::Cloud::Dlp::V2::BigQueryOptions::SampleMethod
Parameter
Returns

#table_reference

def table_reference() -> ::Google::Cloud::Dlp::V2::BigQueryTable
Returns

#table_reference=

def table_reference=(value) -> ::Google::Cloud::Dlp::V2::BigQueryTable
Parameter
Returns