Google Cloud Dataplex V1 Client - Class DiscoverySpec (0.1.6)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DiscoverySpec.

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

Generated from protobuf message google.cloud.dataplex.v1.Zone.DiscoverySpec

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ enabled
bool

Required. Whether discovery is enabled.

↳ include_patterns
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.

↳ exclude_patterns
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.

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

Optional. Configuration for CSV data.

↳ json_options
Google\Cloud\Dataplex\V1\Zone\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

Required. Whether discovery is enabled.

Generated from protobuf field bool enabled = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description
bool

setEnabled

Required. Whether discovery is enabled.

Generated from protobuf field bool enabled = 1 [(.google.api.field_behavior) = REQUIRED];

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.

Generated from protobuf field repeated string include_patterns = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
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.

Generated from protobuf field repeated string include_patterns = 2 [(.google.api.field_behavior) = OPTIONAL];

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.

Generated from protobuf field repeated string exclude_patterns = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
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.

Generated from protobuf field repeated string exclude_patterns = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getCsvOptions

Optional. Configuration for CSV data.

Generated from protobuf field .google.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4 [(.google.api.field_behavior) = OPTIONAL];

hasCsvOptions

clearCsvOptions

setCsvOptions

Optional. Configuration for CSV data.

Generated from protobuf field .google.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
$this

getJsonOptions

Optional. Configuration for Json data.

Generated from protobuf field .google.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5 [(.google.api.field_behavior) = OPTIONAL];

hasJsonOptions

clearJsonOptions

setJsonOptions

Optional. Configuration for Json data.

Generated from protobuf field .google.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
$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 * * * *", or "TZ=America/New_York 1 * * * *".

Generated from protobuf field string schedule = 10 [(.google.api.field_behavior) = OPTIONAL];

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

Generated from protobuf field string schedule = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTrigger

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: