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.



488
489
490
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 488

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

Instance Attribute Details

#excluded_fields ⇒ Array<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. 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. Corresponds to the JSON property excludedFields

Returns:



438
439
440
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 438

def excluded_fields
  @excluded_fields
end

#identifying_fields ⇒ Array<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

Returns:



447
448
449
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 447

def identifying_fields
  @identifying_fields
end

#included_fields ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2FieldId>

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

Returns:



454
455
456
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 454

def included_fields
  @included_fields
end

#rows_limit ⇒ Fixnum

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) 


462
463
464
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 462

def rows_limit
  @rows_limit
end

#rows_limit_percent ⇒ Fixnum

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. Caution: A known issue is causing the rowsLimitPercent field to behave unexpectedly. We recommend using rowsLimit instead. Corresponds to the JSON property rowsLimitPercent

Returns:

  • (Fixnum) 


474
475
476
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 474

def rows_limit_percent
  @rows_limit_percent
end

#sample_method ⇒ String

How to sample the data. Corresponds to the JSON property sampleMethod

Returns:

  • (String) 


479
480
481
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 479

def sample_method
  @sample_method
end

#table_reference ⇒ Google::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

Returns:



486
487
488
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 486

def table_reference
  @table_reference
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



493
494
495
496
497
498
499
500
501
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 493

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