Class Asset.DiscoverySpec (1.25.0)

public static final class Asset.DiscoverySpec extends GeneratedMessageV3 implements Asset.DiscoverySpecOrBuilder

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

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

Static Fields

CSV_OPTIONS_FIELD_NUMBER

public static final int CSV_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

EXCLUDE_PATTERNS_FIELD_NUMBER

public static final int EXCLUDE_PATTERNS_FIELD_NUMBER
Field Value
TypeDescription
int

INCLUDE_PATTERNS_FIELD_NUMBER

public static final int INCLUDE_PATTERNS_FIELD_NUMBER
Field Value
TypeDescription
int

JSON_OPTIONS_FIELD_NUMBER

public static final int JSON_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

SCHEDULE_FIELD_NUMBER

public static final int SCHEDULE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Asset.DiscoverySpec getDefaultInstance()
Returns
TypeDescription
Asset.DiscoverySpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Asset.DiscoverySpec.Builder newBuilder()
Returns
TypeDescription
Asset.DiscoverySpec.Builder

newBuilder(Asset.DiscoverySpec prototype)

public static Asset.DiscoverySpec.Builder newBuilder(Asset.DiscoverySpec prototype)
Parameter
NameDescription
prototypeAsset.DiscoverySpec
Returns
TypeDescription
Asset.DiscoverySpec.Builder

parseDelimitedFrom(InputStream input)

public static Asset.DiscoverySpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Asset.DiscoverySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Asset.DiscoverySpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Asset.DiscoverySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Asset.DiscoverySpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Asset.DiscoverySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Asset.DiscoverySpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Asset.DiscoverySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Asset.DiscoverySpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Asset.DiscoverySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Asset.DiscoverySpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Asset.DiscoverySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Asset.DiscoverySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Asset.DiscoverySpec> parser()
Returns
TypeDescription
Parser<DiscoverySpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCsvOptions()

public Asset.DiscoverySpec.CsvOptions getCsvOptions()

Optional. Configuration for CSV data.

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

Returns
TypeDescription
Asset.DiscoverySpec.CsvOptions

The csvOptions.

getCsvOptionsOrBuilder()

public Asset.DiscoverySpec.CsvOptionsOrBuilder getCsvOptionsOrBuilder()

Optional. Configuration for CSV data.

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

Returns
TypeDescription
Asset.DiscoverySpec.CsvOptionsOrBuilder

getDefaultInstanceForType()

public Asset.DiscoverySpec getDefaultInstanceForType()
Returns
TypeDescription
Asset.DiscoverySpec

getEnabled()

public boolean getEnabled()

Optional. Whether discovery is enabled.

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

Returns
TypeDescription
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];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
ProtocolStringList

A list containing the includePatterns.

getJsonOptions()

public Asset.DiscoverySpec.JsonOptions getJsonOptions()

Optional. Configuration for Json data.

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

Returns
TypeDescription
Asset.DiscoverySpec.JsonOptions

The jsonOptions.

getJsonOptionsOrBuilder()

public Asset.DiscoverySpec.JsonOptionsOrBuilder getJsonOptionsOrBuilder()

Optional. Configuration for Json data.

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

Returns
TypeDescription
Asset.DiscoverySpec.JsonOptionsOrBuilder

getParserForType()

public Parser<Asset.DiscoverySpec> getParserForType()
Returns
TypeDescription
Parser<DiscoverySpec>
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];

Returns
TypeDescription
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];

Returns
TypeDescription
ByteString

The bytes for schedule.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTriggerCase()

public Asset.DiscoverySpec.TriggerCase getTriggerCase()
Returns
TypeDescription
Asset.DiscoverySpec.TriggerCase

hasCsvOptions()

public boolean hasCsvOptions()

Optional. Configuration for CSV data.

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

Returns
TypeDescription
boolean

Whether the csvOptions field is set.

hasJsonOptions()

public boolean hasJsonOptions()

Optional. Configuration for Json data.

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

Returns
TypeDescription
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];

Returns
TypeDescription
boolean

Whether the schedule field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Asset.DiscoverySpec.Builder newBuilderForType()
Returns
TypeDescription
Asset.DiscoverySpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Asset.DiscoverySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Asset.DiscoverySpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Asset.DiscoverySpec.Builder toBuilder()
Returns
TypeDescription
Asset.DiscoverySpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException