Google Cloud Dataplex V1 Client - Class DiscoverySpec (0.8.0)

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 message google.cloud.dataplex.v1.Asset.DiscoverySpec

Namespace

Google \ Cloud \ Dataplex \ V1 \ Asset

Methods

__construct

Constructor.

Parameters
NameDescription
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.

↳ csv_options Google\Cloud\Dataplex\V1\Asset\DiscoverySpec\CsvOptions

Optional. Configuration for CSV data.

↳ json_options Google\Cloud\Dataplex\V1\Asset\DiscoverySpec\JsonOptions

Optional. Configuration for Json data.

↳ schedule 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 * * * *, or TZ=America/New_York 1 * * * *.

getEnabled

Optional. Whether discovery is enabled.

Returns
TypeDescription
bool

setEnabled

Optional. Whether discovery is enabled.

Parameter
NameDescription
var bool
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIncludePatterns

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
NameDescription
var string[]
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setExcludePatterns

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.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getCsvOptions

Optional. Configuration for CSV data.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Asset\DiscoverySpec\CsvOptions|null

hasCsvOptions

clearCsvOptions

setCsvOptions

Optional. Configuration for CSV data.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Asset\DiscoverySpec\CsvOptions
Returns
TypeDescription
$this

getJsonOptions

Optional. Configuration for Json data.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Asset\DiscoverySpec\JsonOptions|null

hasJsonOptions

clearJsonOptions

setJsonOptions

Optional. Configuration for Json data.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Asset\DiscoverySpec\JsonOptions
Returns
TypeDescription
$this

getSchedule

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
TypeDescription
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 * * * *`.
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTrigger

Returns
TypeDescription
string