Interface Zone.DiscoverySpecOrBuilder (1.40.0)

public static interface Zone.DiscoverySpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCsvOptions()

public abstract Zone.DiscoverySpec.CsvOptions getCsvOptions()

Optional. Configuration for CSV data.

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

Returns
Type Description
Zone.DiscoverySpec.CsvOptions

The csvOptions.

getCsvOptionsOrBuilder()

public abstract Zone.DiscoverySpec.CsvOptionsOrBuilder getCsvOptionsOrBuilder()

Optional. Configuration for CSV data.

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

Returns
Type Description
Zone.DiscoverySpec.CsvOptionsOrBuilder

getEnabled()

public abstract boolean getEnabled()

Required. Whether discovery is enabled.

bool enabled = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

The enabled.

getExcludePatterns(int index)

public abstract String getExcludePatterns(int index)

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.

repeated string exclude_patterns = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The excludePatterns at the given index.

getExcludePatternsBytes(int index)

public abstract ByteString getExcludePatternsBytes(int index)

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.

repeated string exclude_patterns = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the excludePatterns at the given index.

getExcludePatternsCount()

public abstract int getExcludePatternsCount()

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.

repeated string exclude_patterns = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of excludePatterns.

getExcludePatternsList()

public abstract List<String> getExcludePatternsList()

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.

repeated string exclude_patterns = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the excludePatterns.

getIncludePatterns(int index)

public abstract String getIncludePatterns(int index)

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.

repeated string include_patterns = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The includePatterns at the given index.

getIncludePatternsBytes(int index)

public abstract ByteString getIncludePatternsBytes(int index)

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.

repeated string include_patterns = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the includePatterns at the given index.

getIncludePatternsCount()

public abstract int getIncludePatternsCount()

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.

repeated string include_patterns = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of includePatterns.

getIncludePatternsList()

public abstract List<String> getIncludePatternsList()

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.

repeated string include_patterns = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the includePatterns.

getJsonOptions()

public abstract Zone.DiscoverySpec.JsonOptions getJsonOptions()

Optional. Configuration for Json data.

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

Returns
Type Description
Zone.DiscoverySpec.JsonOptions

The jsonOptions.

getJsonOptionsOrBuilder()

public abstract Zone.DiscoverySpec.JsonOptionsOrBuilder getJsonOptionsOrBuilder()

Optional. Configuration for Json data.

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

Returns
Type Description
Zone.DiscoverySpec.JsonOptionsOrBuilder

getSchedule()

public abstract String 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 * * * *.

string schedule = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The schedule.

getScheduleBytes()

public abstract ByteString getScheduleBytes()

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 * * * *.

string schedule = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for schedule.

getTriggerCase()

public abstract Zone.DiscoverySpec.TriggerCase getTriggerCase()
Returns
Type Description
Zone.DiscoverySpec.TriggerCase

hasCsvOptions()

public abstract boolean hasCsvOptions()

Optional. Configuration for CSV data.

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

Returns
Type Description
boolean

Whether the csvOptions field is set.

hasJsonOptions()

public abstract boolean hasJsonOptions()

Optional. Configuration for Json data.

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

Returns
Type Description
boolean

Whether the jsonOptions field is set.

hasSchedule()

public abstract boolean hasSchedule()

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 * * * *.

string schedule = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the schedule field is set.