Class Asset.DiscoverySpec.Builder (0.16.0)

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

Settings to manage the metadata discovery and publishing for an asset.

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

Static Methods

getDescriptor()

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

Methods

addAllExcludePatterns(Iterable<String> values)

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

addAllIncludePatterns(Iterable<String> values)

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

addExcludePatterns(String value)

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

addExcludePatternsBytes(ByteString value)

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

addIncludePatterns(String value)

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

addIncludePatternsBytes(ByteString value)

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearCsvOptions()

public Asset.DiscoverySpec.Builder clearCsvOptions()

Optional. Configuration for CSV data.

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

Returns
Type Description
Asset.DiscoverySpec.Builder

clearEnabled()

public Asset.DiscoverySpec.Builder clearEnabled()

Optional. Whether discovery is enabled.

bool enabled = 1;

Returns
Type Description
Asset.DiscoverySpec.Builder

This builder for chaining.

clearExcludePatterns()

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIncludePatterns()

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

clearJsonOptions()

public Asset.DiscoverySpec.Builder clearJsonOptions()

Optional. Configuration for Json data.

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

Returns
Type Description
Asset.DiscoverySpec.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSchedule()

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

clearTrigger()

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

clone()

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

getCsvOptions()

public Asset.DiscoverySpec.CsvOptions getCsvOptions()

Optional. Configuration for CSV data.

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

Returns
Type Description
Asset.DiscoverySpec.CsvOptions

The csvOptions.

getCsvOptionsBuilder()

public Asset.DiscoverySpec.CsvOptions.Builder getCsvOptionsBuilder()

Optional. Configuration for CSV data.

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

Returns
Type Description
Asset.DiscoverySpec.CsvOptions.Builder

getCsvOptionsOrBuilder()

public Asset.DiscoverySpec.CsvOptionsOrBuilder getCsvOptionsOrBuilder()

Optional. Configuration for CSV data.

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

Returns
Type Description
Asset.DiscoverySpec.CsvOptionsOrBuilder

getDefaultInstanceForType()

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

getDescriptorForType()

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

getEnabled()

public boolean getEnabled()

Optional. 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 Asset.DiscoverySpec.JsonOptions getJsonOptions()

Optional. Configuration for Json data.

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

Returns
Type Description
Asset.DiscoverySpec.JsonOptions

The jsonOptions.

getJsonOptionsBuilder()

public Asset.DiscoverySpec.JsonOptions.Builder getJsonOptionsBuilder()

Optional. Configuration for Json data.

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

Returns
Type Description
Asset.DiscoverySpec.JsonOptions.Builder

getJsonOptionsOrBuilder()

public Asset.DiscoverySpec.JsonOptionsOrBuilder getJsonOptionsOrBuilder()

Optional. Configuration for Json data.

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

Returns
Type Description
Asset.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 Asset.DiscoverySpec.TriggerCase getTriggerCase()
Returns
Type Description
Asset.DiscoverySpec.TriggerCase

hasCsvOptions()

public boolean hasCsvOptions()

Optional. Configuration for CSV data.

.google.events.cloud.dataplex.v1.Asset.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.Asset.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(Asset.DiscoverySpec.CsvOptions value)

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

Optional. Configuration for CSV data.

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

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

mergeFrom(Asset.DiscoverySpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeJsonOptions(Asset.DiscoverySpec.JsonOptions value)

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

Optional. Configuration for Json data.

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

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCsvOptions(Asset.DiscoverySpec.CsvOptions value)

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

Optional. Configuration for CSV data.

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

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

setCsvOptions(Asset.DiscoverySpec.CsvOptions.Builder builderForValue)

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

Optional. Configuration for CSV data.

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

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

setEnabled(boolean value)

public Asset.DiscoverySpec.Builder setEnabled(boolean value)

Optional. Whether discovery is enabled.

bool enabled = 1;

Parameter
Name Description
value boolean

The enabled to set.

Returns
Type Description
Asset.DiscoverySpec.Builder

This builder for chaining.

setExcludePatterns(int index, String value)

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIncludePatterns(int index, String value)

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

setJsonOptions(Asset.DiscoverySpec.JsonOptions value)

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

Optional. Configuration for Json data.

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

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

setJsonOptions(Asset.DiscoverySpec.JsonOptions.Builder builderForValue)

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

Optional. Configuration for Json data.

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

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

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

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

setSchedule(String value)

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

setScheduleBytes(ByteString value)

public Asset.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
Asset.DiscoverySpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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