Class: Google::Apis::DlpV2::GooglePrivacyDlpV2BigQueryOptions

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dlp_v2/classes.rb,
lib/google/apis/dlp_v2/representations.rb,
lib/google/apis/dlp_v2/representations.rb

Overview

Options defining BigQuery table and row identifiers.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2BigQueryOptions

Returns a new instance of GooglePrivacyDlpV2BigQueryOptions.



349
350
351
# File 'lib/google/apis/dlp_v2/classes.rb', line 349

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#excluded_fieldsArray<Google::Apis::DlpV2::GooglePrivacyDlpV2FieldId>

References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings. Corresponds to the JSON property excludedFields



304
305
306
# File 'lib/google/apis/dlp_v2/classes.rb', line 304

def excluded_fields
  @excluded_fields
end

#identifying_fieldsArray<Google::Apis::DlpV2::GooglePrivacyDlpV2FieldId>

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. Corresponds to the JSON property identifyingFields



313
314
315
# File 'lib/google/apis/dlp_v2/classes.rb', line 313

def identifying_fields
  @identifying_fields
end

#included_fieldsArray<Google::Apis::DlpV2::GooglePrivacyDlpV2FieldId>

Limit scanning only to these fields. Corresponds to the JSON property includedFields



318
319
320
# File 'lib/google/apis/dlp_v2/classes.rb', line 318

def included_fields
  @included_fields
end

#rows_limitFixnum

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. Corresponds to the JSON property rowsLimit

Returns:

  • (Fixnum)


326
327
328
# File 'lib/google/apis/dlp_v2/classes.rb', line 326

def rows_limit
  @rows_limit
end

#rows_limit_percentFixnum

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. Corresponds to the JSON property rowsLimitPercent

Returns:

  • (Fixnum)


335
336
337
# File 'lib/google/apis/dlp_v2/classes.rb', line 335

def rows_limit_percent
  @rows_limit_percent
end

#sample_methodString

Corresponds to the JSON property sampleMethod

Returns:

  • (String)


340
341
342
# File 'lib/google/apis/dlp_v2/classes.rb', line 340

def sample_method
  @sample_method
end

#table_referenceGoogle::Apis::DlpV2::GooglePrivacyDlpV2BigQueryTable

Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: :. or ... Corresponds to the JSON property tableReference



347
348
349
# File 'lib/google/apis/dlp_v2/classes.rb', line 347

def table_reference
  @table_reference
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



354
355
356
357
358
359
360
361
362
# File 'lib/google/apis/dlp_v2/classes.rb', line 354

def update!(**args)
  @excluded_fields = args[:excluded_fields] if args.key?(:excluded_fields)
  @identifying_fields = args[:identifying_fields] if args.key?(:identifying_fields)
  @included_fields = args[:included_fields] if args.key?(:included_fields)
  @rows_limit = args[:rows_limit] if args.key?(:rows_limit)
  @rows_limit_percent = args[:rows_limit_percent] if args.key?(:rows_limit_percent)
  @sample_method = args[:sample_method] if args.key?(:sample_method)
  @table_reference = args[:table_reference] if args.key?(:table_reference)
end