Class Zone.DiscoverySpec.Builder (0.16.0)

public static final class Zone.DiscoverySpec.Builder extends GeneratedMessageV3.Builder<Zone.DiscoverySpec.Builder> implements Zone.DiscoverySpecOrBuilder

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

Protobuf type google.events.cloud.dataplex.v1.Zone.DiscoverySpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllExcludePatterns(Iterable<String> values)

public Zone.DiscoverySpec.Builder addAllExcludePatterns(Iterable<String> values)

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;

Parameter
Name Description
values Iterable<String>

The excludePatterns to add.

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

addAllIncludePatterns(Iterable<String> values)

public Zone.DiscoverySpec.Builder addAllIncludePatterns(Iterable<String> values)

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;

Parameter
Name Description
values Iterable<String>

The includePatterns to add.

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

addExcludePatterns(String value)

public Zone.DiscoverySpec.Builder addExcludePatterns(String value)

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;

Parameter
Name Description
value String

The excludePatterns to add.

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

addExcludePatternsBytes(ByteString value)

public Zone.DiscoverySpec.Builder addExcludePatternsBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes of the excludePatterns to add.

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

addIncludePatterns(String value)

public Zone.DiscoverySpec.Builder addIncludePatterns(String value)

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;

Parameter
Name Description
value String

The includePatterns to add.

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

addIncludePatternsBytes(ByteString value)

public Zone.DiscoverySpec.Builder addIncludePatternsBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes of the includePatterns to add.

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Zone.DiscoverySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Zone.DiscoverySpec.Builder
Overrides

build()

public Zone.DiscoverySpec build()
Returns
Type Description
Zone.DiscoverySpec

buildPartial()

public Zone.DiscoverySpec buildPartial()
Returns
Type Description
Zone.DiscoverySpec

clear()

public Zone.DiscoverySpec.Builder clear()
Returns
Type Description
Zone.DiscoverySpec.Builder
Overrides

clearCsvOptions()

public Zone.DiscoverySpec.Builder clearCsvOptions()

Optional. Configuration for CSV data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4;

Returns
Type Description
Zone.DiscoverySpec.Builder

clearEnabled()

public Zone.DiscoverySpec.Builder clearEnabled()

Required. Whether discovery is enabled.

bool enabled = 1;

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

clearExcludePatterns()

public Zone.DiscoverySpec.Builder clearExcludePatterns()

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;

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Zone.DiscoverySpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Zone.DiscoverySpec.Builder
Overrides

clearIncludePatterns()

public Zone.DiscoverySpec.Builder clearIncludePatterns()

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;

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

clearJsonOptions()

public Zone.DiscoverySpec.Builder clearJsonOptions()

Optional. Configuration for Json data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5;

Returns
Type Description
Zone.DiscoverySpec.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Zone.DiscoverySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Zone.DiscoverySpec.Builder
Overrides

clearSchedule()

public Zone.DiscoverySpec.Builder clearSchedule()

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;

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

clearTrigger()

public Zone.DiscoverySpec.Builder clearTrigger()
Returns
Type Description
Zone.DiscoverySpec.Builder

clone()

public Zone.DiscoverySpec.Builder clone()
Returns
Type Description
Zone.DiscoverySpec.Builder
Overrides

getCsvOptions()

public Zone.DiscoverySpec.CsvOptions getCsvOptions()

Optional. Configuration for CSV data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4;

Returns
Type Description
Zone.DiscoverySpec.CsvOptions

The csvOptions.

getCsvOptionsBuilder()

public Zone.DiscoverySpec.CsvOptions.Builder getCsvOptionsBuilder()

Optional. Configuration for CSV data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4;

Returns
Type Description
Zone.DiscoverySpec.CsvOptions.Builder

getCsvOptionsOrBuilder()

public Zone.DiscoverySpec.CsvOptionsOrBuilder getCsvOptionsOrBuilder()

Optional. Configuration for CSV data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4;

Returns
Type Description
Zone.DiscoverySpec.CsvOptionsOrBuilder

getDefaultInstanceForType()

public Zone.DiscoverySpec getDefaultInstanceForType()
Returns
Type Description
Zone.DiscoverySpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnabled()

public boolean getEnabled()

Required. Whether discovery is enabled.

bool enabled = 1;

Returns
Type Description
boolean

The enabled.

getExcludePatterns(int index)

public 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;

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 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;

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 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;

Returns
Type Description
int

The count of excludePatterns.

getExcludePatternsList()

public ProtocolStringList 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;

Returns
Type Description
ProtocolStringList

A list containing the excludePatterns.

getIncludePatterns(int index)

public 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;

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 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;

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 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;

Returns
Type Description
int

The count of includePatterns.

getIncludePatternsList()

public ProtocolStringList 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;

Returns
Type Description
ProtocolStringList

A list containing the includePatterns.

getJsonOptions()

public Zone.DiscoverySpec.JsonOptions getJsonOptions()

Optional. Configuration for Json data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5;

Returns
Type Description
Zone.DiscoverySpec.JsonOptions

The jsonOptions.

getJsonOptionsBuilder()

public Zone.DiscoverySpec.JsonOptions.Builder getJsonOptionsBuilder()

Optional. Configuration for Json data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5;

Returns
Type Description
Zone.DiscoverySpec.JsonOptions.Builder

getJsonOptionsOrBuilder()

public Zone.DiscoverySpec.JsonOptionsOrBuilder getJsonOptionsOrBuilder()

Optional. Configuration for Json data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5;

Returns
Type Description
Zone.DiscoverySpec.JsonOptionsOrBuilder

getSchedule()

public 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;

Returns
Type Description
String

The schedule.

getScheduleBytes()

public 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;

Returns
Type Description
ByteString

The bytes for schedule.

getTriggerCase()

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

hasCsvOptions()

public boolean hasCsvOptions()

Optional. Configuration for CSV data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4;

Returns
Type Description
boolean

Whether the csvOptions field is set.

hasJsonOptions()

public boolean hasJsonOptions()

Optional. Configuration for Json data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5;

Returns
Type Description
boolean

Whether the jsonOptions field is set.

hasSchedule()

public 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;

Returns
Type Description
boolean

Whether the schedule field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCsvOptions(Zone.DiscoverySpec.CsvOptions value)

public Zone.DiscoverySpec.Builder mergeCsvOptions(Zone.DiscoverySpec.CsvOptions value)

Optional. Configuration for CSV data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4;

Parameter
Name Description
value Zone.DiscoverySpec.CsvOptions
Returns
Type Description
Zone.DiscoverySpec.Builder

mergeFrom(Zone.DiscoverySpec other)

public Zone.DiscoverySpec.Builder mergeFrom(Zone.DiscoverySpec other)
Parameter
Name Description
other Zone.DiscoverySpec
Returns
Type Description
Zone.DiscoverySpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Zone.DiscoverySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Zone.DiscoverySpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Zone.DiscoverySpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Zone.DiscoverySpec.Builder
Overrides

mergeJsonOptions(Zone.DiscoverySpec.JsonOptions value)

public Zone.DiscoverySpec.Builder mergeJsonOptions(Zone.DiscoverySpec.JsonOptions value)

Optional. Configuration for Json data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5;

Parameter
Name Description
value Zone.DiscoverySpec.JsonOptions
Returns
Type Description
Zone.DiscoverySpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Zone.DiscoverySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Zone.DiscoverySpec.Builder
Overrides

setCsvOptions(Zone.DiscoverySpec.CsvOptions value)

public Zone.DiscoverySpec.Builder setCsvOptions(Zone.DiscoverySpec.CsvOptions value)

Optional. Configuration for CSV data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4;

Parameter
Name Description
value Zone.DiscoverySpec.CsvOptions
Returns
Type Description
Zone.DiscoverySpec.Builder

setCsvOptions(Zone.DiscoverySpec.CsvOptions.Builder builderForValue)

public Zone.DiscoverySpec.Builder setCsvOptions(Zone.DiscoverySpec.CsvOptions.Builder builderForValue)

Optional. Configuration for CSV data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4;

Parameter
Name Description
builderForValue Zone.DiscoverySpec.CsvOptions.Builder
Returns
Type Description
Zone.DiscoverySpec.Builder

setEnabled(boolean value)

public Zone.DiscoverySpec.Builder setEnabled(boolean value)

Required. Whether discovery is enabled.

bool enabled = 1;

Parameter
Name Description
value boolean

The enabled to set.

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

setExcludePatterns(int index, String value)

public Zone.DiscoverySpec.Builder setExcludePatterns(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The excludePatterns to set.

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Zone.DiscoverySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Zone.DiscoverySpec.Builder
Overrides

setIncludePatterns(int index, String value)

public Zone.DiscoverySpec.Builder setIncludePatterns(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The includePatterns to set.

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

setJsonOptions(Zone.DiscoverySpec.JsonOptions value)

public Zone.DiscoverySpec.Builder setJsonOptions(Zone.DiscoverySpec.JsonOptions value)

Optional. Configuration for Json data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5;

Parameter
Name Description
value Zone.DiscoverySpec.JsonOptions
Returns
Type Description
Zone.DiscoverySpec.Builder

setJsonOptions(Zone.DiscoverySpec.JsonOptions.Builder builderForValue)

public Zone.DiscoverySpec.Builder setJsonOptions(Zone.DiscoverySpec.JsonOptions.Builder builderForValue)

Optional. Configuration for Json data.

.google.events.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5;

Parameter
Name Description
builderForValue Zone.DiscoverySpec.JsonOptions.Builder
Returns
Type Description
Zone.DiscoverySpec.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Zone.DiscoverySpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Zone.DiscoverySpec.Builder
Overrides

setSchedule(String value)

public Zone.DiscoverySpec.Builder setSchedule(String value)

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;

Parameter
Name Description
value String

The schedule to set.

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

setScheduleBytes(ByteString value)

public Zone.DiscoverySpec.Builder setScheduleBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for schedule to set.

Returns
Type Description
Zone.DiscoverySpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Zone.DiscoverySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Zone.DiscoverySpec.Builder
Overrides