Class: Google::Cloud::Dlp::V2::PrivacyMetric::KMapEstimationConfig

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

Overview

Reidentifiability metric. This corresponds to a risk model similar to what is called "journalist risk" in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset.

Defined Under Namespace

Classes: AuxiliaryTable, TaggedField

Instance Attribute Summary collapse

Instance Attribute Details

#auxiliary_tables ⇒ ::Array<::Google::Cloud::Dlp::V2::PrivacyMetric::KMapEstimationConfig::AuxiliaryTable>

Returns Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers column must appear in exactly one column of one auxiliary table.

Returns:



1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 1482

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

  # A column with a semantic tag attached.
  # @!attribute [rw] field
  #   @return [::Google::Cloud::Dlp::V2::FieldId]
  #     Required. Identifies the column.
  # @!attribute [rw] info_type
  #   @return [::Google::Cloud::Dlp::V2::InfoType]
  #     A column can be tagged with a InfoType to use the relevant public
  #     dataset as a statistical model of population, if available. We
  #     currently support US ZIP codes, region codes, ages and genders.
  #     To programmatically obtain the list of supported InfoTypes, use
  #     ListInfoTypes with the supported_by=RISK_ANALYSIS filter.
  # @!attribute [rw] custom_tag
  #   @return [::String]
  #     A column can be tagged with a custom tag. In this case, the user must
  #     indicate an auxiliary table that contains statistical information on
  #     the possible values of this column (below).
  # @!attribute [rw] inferred
  #   @return [::Google::Protobuf::Empty]
  #     If no semantic tag is indicated, we infer the statistical model from
  #     the distribution of values in the input data
  class TaggedField
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An auxiliary table contains statistical information on the relative
  # frequency of different quasi-identifiers values. It has one or several
  # quasi-identifiers columns, and one column that indicates the relative
  # frequency of each quasi-identifier tuple.
  # If a tuple is present in the data but not in the auxiliary table, the
  # corresponding relative frequency is assumed to be zero (and thus, the
  # tuple is highly reidentifiable).
  # @!attribute [rw] table
  #   @return [::Google::Cloud::Dlp::V2::BigQueryTable]
  #     Required. Auxiliary table location.
  # @!attribute [rw] quasi_ids
  #   @return [::Array<::Google::Cloud::Dlp::V2::PrivacyMetric::KMapEstimationConfig::AuxiliaryTable::QuasiIdField>]
  #     Required. Quasi-identifier columns.
  # @!attribute [rw] relative_frequency
  #   @return [::Google::Cloud::Dlp::V2::FieldId]
  #     Required. The relative frequency column must contain a floating-point number
  #     between 0 and 1 (inclusive). Null values are assumed to be zero.
  class AuxiliaryTable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A quasi-identifier column has a custom_tag, used to know which column
    # in the data corresponds to which column in the statistical model.
    # @!attribute [rw] field
    #   @return [::Google::Cloud::Dlp::V2::FieldId]
    #     Identifies the column.
    # @!attribute [rw] custom_tag
    #   @return [::String]
    #     A auxiliary field.
    class QuasiIdField
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#quasi_ids ⇒ ::Array<::Google::Cloud::Dlp::V2::PrivacyMetric::KMapEstimationConfig::TaggedField>

Returns Required. Fields considered to be quasi-identifiers. No two columns can have the same tag.

Returns:



1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 1482

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

  # A column with a semantic tag attached.
  # @!attribute [rw] field
  #   @return [::Google::Cloud::Dlp::V2::FieldId]
  #     Required. Identifies the column.
  # @!attribute [rw] info_type
  #   @return [::Google::Cloud::Dlp::V2::InfoType]
  #     A column can be tagged with a InfoType to use the relevant public
  #     dataset as a statistical model of population, if available. We
  #     currently support US ZIP codes, region codes, ages and genders.
  #     To programmatically obtain the list of supported InfoTypes, use
  #     ListInfoTypes with the supported_by=RISK_ANALYSIS filter.
  # @!attribute [rw] custom_tag
  #   @return [::String]
  #     A column can be tagged with a custom tag. In this case, the user must
  #     indicate an auxiliary table that contains statistical information on
  #     the possible values of this column (below).
  # @!attribute [rw] inferred
  #   @return [::Google::Protobuf::Empty]
  #     If no semantic tag is indicated, we infer the statistical model from
  #     the distribution of values in the input data
  class TaggedField
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An auxiliary table contains statistical information on the relative
  # frequency of different quasi-identifiers values. It has one or several
  # quasi-identifiers columns, and one column that indicates the relative
  # frequency of each quasi-identifier tuple.
  # If a tuple is present in the data but not in the auxiliary table, the
  # corresponding relative frequency is assumed to be zero (and thus, the
  # tuple is highly reidentifiable).
  # @!attribute [rw] table
  #   @return [::Google::Cloud::Dlp::V2::BigQueryTable]
  #     Required. Auxiliary table location.
  # @!attribute [rw] quasi_ids
  #   @return [::Array<::Google::Cloud::Dlp::V2::PrivacyMetric::KMapEstimationConfig::AuxiliaryTable::QuasiIdField>]
  #     Required. Quasi-identifier columns.
  # @!attribute [rw] relative_frequency
  #   @return [::Google::Cloud::Dlp::V2::FieldId]
  #     Required. The relative frequency column must contain a floating-point number
  #     between 0 and 1 (inclusive). Null values are assumed to be zero.
  class AuxiliaryTable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A quasi-identifier column has a custom_tag, used to know which column
    # in the data corresponds to which column in the statistical model.
    # @!attribute [rw] field
    #   @return [::Google::Cloud::Dlp::V2::FieldId]
    #     Identifies the column.
    # @!attribute [rw] custom_tag
    #   @return [::String]
    #     A auxiliary field.
    class QuasiIdField
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#region_code ⇒ ::String

Returns ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.

Returns:

  • (::String) —

    ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.



1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 1482

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

  # A column with a semantic tag attached.
  # @!attribute [rw] field
  #   @return [::Google::Cloud::Dlp::V2::FieldId]
  #     Required. Identifies the column.
  # @!attribute [rw] info_type
  #   @return [::Google::Cloud::Dlp::V2::InfoType]
  #     A column can be tagged with a InfoType to use the relevant public
  #     dataset as a statistical model of population, if available. We
  #     currently support US ZIP codes, region codes, ages and genders.
  #     To programmatically obtain the list of supported InfoTypes, use
  #     ListInfoTypes with the supported_by=RISK_ANALYSIS filter.
  # @!attribute [rw] custom_tag
  #   @return [::String]
  #     A column can be tagged with a custom tag. In this case, the user must
  #     indicate an auxiliary table that contains statistical information on
  #     the possible values of this column (below).
  # @!attribute [rw] inferred
  #   @return [::Google::Protobuf::Empty]
  #     If no semantic tag is indicated, we infer the statistical model from
  #     the distribution of values in the input data
  class TaggedField
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An auxiliary table contains statistical information on the relative
  # frequency of different quasi-identifiers values. It has one or several
  # quasi-identifiers columns, and one column that indicates the relative
  # frequency of each quasi-identifier tuple.
  # If a tuple is present in the data but not in the auxiliary table, the
  # corresponding relative frequency is assumed to be zero (and thus, the
  # tuple is highly reidentifiable).
  # @!attribute [rw] table
  #   @return [::Google::Cloud::Dlp::V2::BigQueryTable]
  #     Required. Auxiliary table location.
  # @!attribute [rw] quasi_ids
  #   @return [::Array<::Google::Cloud::Dlp::V2::PrivacyMetric::KMapEstimationConfig::AuxiliaryTable::QuasiIdField>]
  #     Required. Quasi-identifier columns.
  # @!attribute [rw] relative_frequency
  #   @return [::Google::Cloud::Dlp::V2::FieldId]
  #     Required. The relative frequency column must contain a floating-point number
  #     between 0 and 1 (inclusive). Null values are assumed to be zero.
  class AuxiliaryTable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A quasi-identifier column has a custom_tag, used to know which column
    # in the data corresponds to which column in the statistical model.
    # @!attribute [rw] field
    #   @return [::Google::Cloud::Dlp::V2::FieldId]
    #     Identifies the column.
    # @!attribute [rw] custom_tag
    #   @return [::String]
    #     A auxiliary field.
    class QuasiIdField
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end