Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataProfileSpec (v0.21.1)

Version 0.21.1

• 1.0.1 (latest)
• 1.0.0
• 0.23.0
• 0.22.0
• 0.21.1
• 0.20.0
• 0.19.0
• 0.18.2
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.1
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.1
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.0

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataProfileSpec.

DataProfileScan related setting.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#exclude_fields

def exclude_fields() -> ::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields

Returns

• (::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields) — Optional. The fields to exclude from data profile.

  If specified, the fields will be excluded from data profile, regardless of include_fields value.

#exclude_fields=

def exclude_fields=(value) -> ::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields

Parameter

• value (::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields) — Optional. The fields to exclude from data profile.

  If specified, the fields will be excluded from data profile, regardless of include_fields value.

Returns

• (::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields) — Optional. The fields to exclude from data profile.

  If specified, the fields will be excluded from data profile, regardless of include_fields value.

#include_fields

def include_fields() -> ::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields

Returns

• (::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields) — Optional. The fields to include in data profile.

  If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

#include_fields=

def include_fields=(value) -> ::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields

Parameter

• value (::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields) — Optional. The fields to include in data profile.

  If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

Returns

• (::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields) — Optional. The fields to include in data profile.

  If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

#post_scan_actions

def post_scan_actions() -> ::Google::Cloud::Dataplex::V1::DataProfileSpec::PostScanActions

Returns

• (::Google::Cloud::Dataplex::V1::DataProfileSpec::PostScanActions) — Optional. Actions to take upon job completion..

#post_scan_actions=

def post_scan_actions=(value) -> ::Google::Cloud::Dataplex::V1::DataProfileSpec::PostScanActions

Parameter

• value (::Google::Cloud::Dataplex::V1::DataProfileSpec::PostScanActions) — Optional. Actions to take upon job completion..

Returns

• (::Google::Cloud::Dataplex::V1::DataProfileSpec::PostScanActions) — Optional. Actions to take upon job completion..

#row_filter

def row_filter() -> ::String

Returns

• (::String) — Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10

#row_filter=

def row_filter=(value) -> ::String

Parameter

• value (::String) — Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10

Returns

• (::String) — Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10

#sampling_percent

def sampling_percent() -> ::Float

Returns

• (::Float) —

  Optional. The percentage of the records to be selected from the dataset for DataScan.

  • Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
  • Sampling is not applied if sampling_percent is not specified, 0 or 100.

#sampling_percent=

def sampling_percent=(value) -> ::Float

Parameter

• value (::Float) —

  Optional. The percentage of the records to be selected from the dataset for DataScan.

  • Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
  • Sampling is not applied if sampling_percent is not specified, 0 or 100.

Returns

• (::Float) —

  Optional. The percentage of the records to be selected from the dataset for DataScan.

  • Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
  • Sampling is not applied if sampling_percent is not specified, 0 or 100.