Class: Google::Cloud::Dlp::V2::BigQueryOptions

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/privacy/dlp/v2/storage.rb

Overview

Options defining BigQuery table and row identifiers.

Defined Under Namespace

Modules: SampleMethod

Instance Attribute Summary collapse

Instance Attribute Details

#excluded_fields ⇒ ::Array<::Google::Cloud::Dlp::V2::FieldId>

Returns 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.



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 560

class BigQueryOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How to sample rows if not all rows are scanned. Meaningful only when used
  # in conjunction with either rows_limit or rows_limit_percent. If not
  # specified, rows are scanned in the order BigQuery reads them.
  module SampleMethod
    # No sampling.
    SAMPLE_METHOD_UNSPECIFIED = 0

    # Scan groups of rows in the order BigQuery provides (default). Multiple
    # groups of rows may be scanned in parallel, so results may not appear in
    # the same order the rows are read.
    TOP = 1

    # Randomly pick groups of rows to scan.
    RANDOM_START = 2
  end
end

#identifying_fields ⇒ ::Array<::Google::Cloud::Dlp::V2::FieldId>

Returns 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.



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 560

class BigQueryOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How to sample rows if not all rows are scanned. Meaningful only when used
  # in conjunction with either rows_limit or rows_limit_percent. If not
  # specified, rows are scanned in the order BigQuery reads them.
  module SampleMethod
    # No sampling.
    SAMPLE_METHOD_UNSPECIFIED = 0

    # Scan groups of rows in the order BigQuery provides (default). Multiple
    # groups of rows may be scanned in parallel, so results may not appear in
    # the same order the rows are read.
    TOP = 1

    # Randomly pick groups of rows to scan.
    RANDOM_START = 2
  end
end

#included_fields ⇒ ::Array<::Google::Cloud::Dlp::V2::FieldId>

Returns 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.



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 560

class BigQueryOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How to sample rows if not all rows are scanned. Meaningful only when used
  # in conjunction with either rows_limit or rows_limit_percent. If not
  # specified, rows are scanned in the order BigQuery reads them.
  module SampleMethod
    # No sampling.
    SAMPLE_METHOD_UNSPECIFIED = 0

    # Scan groups of rows in the order BigQuery provides (default). Multiple
    # groups of rows may be scanned in parallel, so results may not appear in
    # the same order the rows are read.
    TOP = 1

    # Randomly pick groups of rows to scan.
    RANDOM_START = 2
  end
end

#rows_limit ⇒ ::Integer

Returns 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.



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 560

class BigQueryOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How to sample rows if not all rows are scanned. Meaningful only when used
  # in conjunction with either rows_limit or rows_limit_percent. If not
  # specified, rows are scanned in the order BigQuery reads them.
  module SampleMethod
    # No sampling.
    SAMPLE_METHOD_UNSPECIFIED = 0

    # Scan groups of rows in the order BigQuery provides (default). Multiple
    # groups of rows may be scanned in parallel, so results may not appear in
    # the same order the rows are read.
    TOP = 1

    # Randomly pick groups of rows to scan.
    RANDOM_START = 2
  end
end

#rows_limit_percent ⇒ ::Integer

Returns 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.

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.

    Caution: A known issue is causing the rowsLimitPercent field to behave unexpectedly. We recommend using rowsLimit instead.



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 560

class BigQueryOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How to sample rows if not all rows are scanned. Meaningful only when used
  # in conjunction with either rows_limit or rows_limit_percent. If not
  # specified, rows are scanned in the order BigQuery reads them.
  module SampleMethod
    # No sampling.
    SAMPLE_METHOD_UNSPECIFIED = 0

    # Scan groups of rows in the order BigQuery provides (default). Multiple
    # groups of rows may be scanned in parallel, so results may not appear in
    # the same order the rows are read.
    TOP = 1

    # Randomly pick groups of rows to scan.
    RANDOM_START = 2
  end
end

#sample_method ⇒ ::Google::Cloud::Dlp::V2::BigQueryOptions::SampleMethod

Returns How to sample the data.

Returns:



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 560

class BigQueryOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How to sample rows if not all rows are scanned. Meaningful only when used
  # in conjunction with either rows_limit or rows_limit_percent. If not
  # specified, rows are scanned in the order BigQuery reads them.
  module SampleMethod
    # No sampling.
    SAMPLE_METHOD_UNSPECIFIED = 0

    # Scan groups of rows in the order BigQuery provides (default). Multiple
    # groups of rows may be scanned in parallel, so results may not appear in
    # the same order the rows are read.
    TOP = 1

    # Randomly pick groups of rows to scan.
    RANDOM_START = 2
  end
end

#table_reference ⇒ ::Google::Cloud::Dlp::V2::BigQueryTable

Returns Complete BigQuery table reference.

Returns:



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 560

class BigQueryOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How to sample rows if not all rows are scanned. Meaningful only when used
  # in conjunction with either rows_limit or rows_limit_percent. If not
  # specified, rows are scanned in the order BigQuery reads them.
  module SampleMethod
    # No sampling.
    SAMPLE_METHOD_UNSPECIFIED = 0

    # Scan groups of rows in the order BigQuery provides (default). Multiple
    # groups of rows may be scanned in parallel, so results may not appear in
    # the same order the rows are read.
    TOP = 1

    # Randomly pick groups of rows to scan.
    RANDOM_START = 2
  end
end