Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DiscoverySpec.
Settings to manage the metadata discovery and publishing for an asset.
Generated from protobuf messagegoogle.cloud.dataplex.v1.Asset.DiscoverySpec
Namespace
Google \ Cloud \ Dataplex \ V1 \ Asset
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ enabled
bool
Optional. Whether discovery is enabled.
↳ include_patterns
array
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.
↳ exclude_patterns
array
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.
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 * * * *.
getEnabled
Optional. Whether discovery is enabled.
Returns
Type
Description
bool
setEnabled
Optional. Whether discovery is enabled.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getIncludePatterns
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.
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.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getExcludePatterns
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.
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.
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
Type
Description
string
hasSchedule
setSchedule
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 * * * *.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class DiscoverySpec (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.Asset.DiscoverySpec)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.Asset.DiscoverySpec)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.Asset.DiscoverySpec)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.Asset.DiscoverySpec)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.Asset.DiscoverySpec)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.Asset.DiscoverySpec)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.Asset.DiscoverySpec)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.Asset.DiscoverySpec)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.Asset.DiscoverySpec)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.Asset.DiscoverySpec)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.Asset.DiscoverySpec)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.Asset.DiscoverySpec)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.Asset.DiscoverySpec)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.Asset.DiscoverySpec)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.Asset.DiscoverySpec)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.Asset.DiscoverySpec)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.Asset.DiscoverySpec)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.Asset.DiscoverySpec)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.Asset.DiscoverySpec)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.Asset.DiscoverySpec)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.Asset.DiscoverySpec)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.Asset.DiscoverySpec)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.Asset.DiscoverySpec)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.Asset.DiscoverySpec) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class DiscoverySpec.\n\nSettings to manage the metadata discovery and publishing for an asset.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.Asset.DiscoverySpec`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1 \\\\ Asset\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getEnabled\n\nOptional. Whether discovery is enabled.\n\n### setEnabled\n\nOptional. Whether discovery is enabled.\n\n### getIncludePatterns\n\nOptional. The list of patterns to apply for selecting data to include\nduring discovery if only a subset of the data should considered. For\nCloud Storage bucket assets, these are interpreted as glob patterns used\nto match object names. For BigQuery dataset assets, these are interpreted\nas patterns to match table names.\n\n### setIncludePatterns\n\nOptional. The list of patterns to apply for selecting data to include\nduring discovery if only a subset of the data should considered. For\nCloud Storage bucket assets, these are interpreted as glob patterns used\nto match object names. For BigQuery dataset assets, these are interpreted\nas patterns to match table names.\n\n### getExcludePatterns\n\nOptional. The list of patterns to apply for selecting data to exclude\nduring discovery. For Cloud Storage bucket assets, these are interpreted\nas glob patterns used to match object names. For BigQuery dataset assets,\nthese are interpreted as patterns to match table names.\n\n### setExcludePatterns\n\nOptional. The list of patterns to apply for selecting data to exclude\nduring discovery. For Cloud Storage bucket assets, these are interpreted\nas glob patterns used to match object names. For BigQuery dataset assets,\nthese are interpreted as patterns to match table names.\n\n### getCsvOptions\n\nOptional. Configuration for CSV data.\n\n### hasCsvOptions\n\n### clearCsvOptions\n\n### setCsvOptions\n\nOptional. Configuration for CSV data.\n\n### getJsonOptions\n\nOptional. Configuration for Json data.\n\n### hasJsonOptions\n\n### clearJsonOptions\n\n### setJsonOptions\n\nOptional. Configuration for Json data.\n\n### getSchedule\n\nOptional. Cron schedule (\u003chttps://en.wikipedia.org/wiki/Cron\u003e) for\nrunning discovery periodically. Successive discovery runs must be\nscheduled at least 60 minutes apart. The default value is to run\ndiscovery every 60 minutes.\n\nTo explicitly set a timezone to the cron tab, apply a prefix in the\ncron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or TZ=${IANA_TIME_ZONE}\".\nThe ${IANA_TIME_ZONE} may only be a valid string from IANA time zone\ndatabase. For example, `CRON_TZ=America/New_York 1 * * * *`, or\n`TZ=America/New_York 1 * * * *`.\n\n### hasSchedule\n\n### setSchedule\n\nOptional. Cron schedule (\u003chttps://en.wikipedia.org/wiki/Cron\u003e) for\nrunning discovery periodically. Successive discovery runs must be\nscheduled at least 60 minutes apart. The default value is to run\ndiscovery every 60 minutes.\n\nTo explicitly set a timezone to the cron tab, apply a prefix in the\ncron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or TZ=${IANA_TIME_ZONE}\".\nThe ${IANA_TIME_ZONE} may only be a valid string from IANA time zone\ndatabase. For example, `CRON_TZ=America/New_York 1 * * * *`, or\n`TZ=America/New_York 1 * * * *`.\n\n### getTrigger"]]
