Dataplex V1 API - Class Google::Cloud::Dataplex::V1::Zone::DiscoverySpec (v0.15.0)

Version 0.15.0

• 1.2.0 (latest)
• 1.1.0
• 1.0.1
• 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::Zone::DiscoverySpec.

Settings to manage the metadata discovery and publishing in a zone.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#csv_options

def csv_options() -> ::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions

Returns

• (::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions) — Optional. Configuration for CSV data.

#csv_options=

def csv_options=(value) -> ::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions

Parameter

• value (::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions) — Optional. Configuration for CSV data.

Returns

• (::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions) — Optional. Configuration for CSV data.

#enabled

def enabled() -> ::Boolean

Returns

• (::Boolean) — Required. Whether discovery is enabled.

#enabled=

def enabled=(value) -> ::Boolean

Parameter

• value (::Boolean) — Required. Whether discovery is enabled.

Returns

• (::Boolean) — Required. Whether discovery is enabled.

#exclude_patterns

def exclude_patterns() -> ::Array<::String>

Returns

• (::Array<::String>) — Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.

#exclude_patterns=

def exclude_patterns=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.

Returns

• (::Array<::String>) — Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.

#include_patterns

def include_patterns() -> ::Array<::String>

Returns

• (::Array<::String>) — Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.

#include_patterns=

def include_patterns=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.

Returns

• (::Array<::String>) — Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.

#json_options

def json_options() -> ::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions

Returns

• (::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions) — Optional. Configuration for Json data.

#json_options=

def json_options=(value) -> ::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions

Parameter

• value (::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions) — Optional. Configuration for Json data.

Returns

• (::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions) — Optional. Configuration for Json data.

#schedule

def schedule() -> ::String

Returns

• (::String) —

  Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, `CRON_TZ=America/New_York 1

  • * * *, orTZ=America/New_York 1 * * * *`.

#schedule=

def schedule=(value) -> ::String

Parameter

• value (::String) —

  Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, `CRON_TZ=America/New_York 1

  • * * *, orTZ=America/New_York 1 * * * *`.

Returns

• (::String) —

  Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, `CRON_TZ=America/New_York 1

  • * * *, orTZ=America/New_York 1 * * * *`.