public static final class Zone.DiscoverySpec extends GeneratedMessageV3 implements Zone.DiscoverySpecOrBuilder
Settings to manage the metadata discovery and publishing in a zone.
Protobuf type google.cloud.dataplex.v1.Zone.DiscoverySpec
Static Fields
CSV_OPTIONS_FIELD_NUMBER
public static final int CSV_OPTIONS_FIELD_NUMBER
Field Value
ENABLED_FIELD_NUMBER
public static final int ENABLED_FIELD_NUMBER
Field Value
EXCLUDE_PATTERNS_FIELD_NUMBER
public static final int EXCLUDE_PATTERNS_FIELD_NUMBER
Field Value
INCLUDE_PATTERNS_FIELD_NUMBER
public static final int INCLUDE_PATTERNS_FIELD_NUMBER
Field Value
JSON_OPTIONS_FIELD_NUMBER
public static final int JSON_OPTIONS_FIELD_NUMBER
Field Value
SCHEDULE_FIELD_NUMBER
public static final int SCHEDULE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Zone.DiscoverySpec getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Zone.DiscoverySpec.Builder newBuilder()
Returns
newBuilder(Zone.DiscoverySpec prototype)
public static Zone.DiscoverySpec.Builder newBuilder(Zone.DiscoverySpec prototype)
Parameter
Returns
public static Zone.DiscoverySpec parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Zone.DiscoverySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Zone.DiscoverySpec parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Zone.DiscoverySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Zone.DiscoverySpec parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Zone.DiscoverySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Zone.DiscoverySpec parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Zone.DiscoverySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Zone.DiscoverySpec parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Zone.DiscoverySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Zone.DiscoverySpec parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Zone.DiscoverySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Zone.DiscoverySpec> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCsvOptions()
public Zone.DiscoverySpec.CsvOptions getCsvOptions()
Optional. Configuration for CSV data.
.google.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4 [(.google.api.field_behavior) = OPTIONAL];
getCsvOptionsOrBuilder()
public Zone.DiscoverySpec.CsvOptionsOrBuilder getCsvOptionsOrBuilder()
Optional. Configuration for CSV data.
.google.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public Zone.DiscoverySpec getDefaultInstanceForType()
Returns
getEnabled()
public boolean getEnabled()
Required. Whether discovery is enabled.
bool enabled = 1 [(.google.api.field_behavior) = REQUIRED];
| 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 [(.google.api.field_behavior) = OPTIONAL];
| 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 [(.google.api.field_behavior) = OPTIONAL];
| 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 [(.google.api.field_behavior) = OPTIONAL];
| 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 [(.google.api.field_behavior) = OPTIONAL];
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 [(.google.api.field_behavior) = OPTIONAL];
| 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 [(.google.api.field_behavior) = OPTIONAL];
| 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 [(.google.api.field_behavior) = OPTIONAL];
| 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 [(.google.api.field_behavior) = OPTIONAL];
getJsonOptions()
public Zone.DiscoverySpec.JsonOptions getJsonOptions()
Optional. Configuration for Json data.
.google.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5 [(.google.api.field_behavior) = OPTIONAL];
getJsonOptionsOrBuilder()
public Zone.DiscoverySpec.JsonOptionsOrBuilder getJsonOptionsOrBuilder()
Optional. Configuration for Json data.
.google.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<Zone.DiscoverySpec> getParserForType()
Returns
Overrides
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 [(.google.api.field_behavior) = OPTIONAL];
| 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 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
| ByteString |
The bytes for schedule.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTriggerCase()
public Zone.DiscoverySpec.TriggerCase getTriggerCase()
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasCsvOptions()
public boolean hasCsvOptions()
Optional. Configuration for CSV data.
.google.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions csv_options = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
| boolean |
Whether the csvOptions field is set.
|
hasJsonOptions()
public boolean hasJsonOptions()
Optional. Configuration for Json data.
.google.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5 [(.google.api.field_behavior) = OPTIONAL];
| 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 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
| boolean |
Whether the schedule field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Zone.DiscoverySpec.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Zone.DiscoverySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Zone.DiscoverySpec.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
