Package com.google.cloud.dataplex.v1

Class Asset.DiscoverySpec

  • All Implemented Interfaces:
    Asset.DiscoverySpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Asset
    public static final class Asset.DiscoverySpec
extends com.google.protobuf.GeneratedMessageV3
implements Asset.DiscoverySpecOrBuilder
     Settings to manage the metadata discovery and publishing for an asset.
    Protobuf type google.cloud.dataplex.v1.Asset.DiscoverySpec
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getEnabled

        public boolean getEnabled()
         Optional. Whether discovery is enabled.
        bool enabled = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnabled in interface Asset.DiscoverySpecOrBuilder
        Returns:
        The enabled.

      • getIncludePatternsList

        public com.google.protobuf.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];
        Specified by:
        getIncludePatternsList in interface Asset.DiscoverySpecOrBuilder
        Returns:
        A list containing the includePatterns.

      • 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];
        Specified by:
        getIncludePatternsCount in interface Asset.DiscoverySpecOrBuilder
        Returns:
        The count of includePatterns.

      • getIncludePatterns

        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];
        Specified by:
        getIncludePatterns in interface Asset.DiscoverySpecOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The includePatterns at the given index.

      • getIncludePatternsBytes

        public com.google.protobuf.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];
        Specified by:
        getIncludePatternsBytes in interface Asset.DiscoverySpecOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the includePatterns at the given index.

      • getExcludePatternsList

        public com.google.protobuf.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];
        Specified by:
        getExcludePatternsList in interface Asset.DiscoverySpecOrBuilder
        Returns:
        A list containing the excludePatterns.

      • 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];
        Specified by:
        getExcludePatternsCount in interface Asset.DiscoverySpecOrBuilder
        Returns:
        The count of excludePatterns.

      • getExcludePatterns

        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];
        Specified by:
        getExcludePatterns in interface Asset.DiscoverySpecOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The excludePatterns at the given index.

      • getExcludePatternsBytes

        public com.google.protobuf.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];
        Specified by:
        getExcludePatternsBytes in interface Asset.DiscoverySpecOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the excludePatterns at the given index.

      • hasCsvOptions

        public boolean hasCsvOptions()
         Optional. Configuration for CSV data.
        .google.cloud.dataplex.v1.Asset.DiscoverySpec.CsvOptions csv_options = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasCsvOptions in interface Asset.DiscoverySpecOrBuilder
        Returns:
        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];
        Specified by:
        hasJsonOptions in interface Asset.DiscoverySpecOrBuilder
        Returns:
        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];
        Specified by:
        hasSchedule in interface Asset.DiscoverySpecOrBuilder
        Returns:
        Whether the schedule field is set.

      • 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];
        Specified by:
        getSchedule in interface Asset.DiscoverySpecOrBuilder
        Returns:
        The schedule.

      • getScheduleBytes

        public com.google.protobuf.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];
        Specified by:
        getScheduleBytes in interface Asset.DiscoverySpecOrBuilder
        Returns:
        The bytes for schedule.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Asset.DiscoverySpec parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Asset.DiscoverySpec parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Asset.DiscoverySpec parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Asset.DiscoverySpec parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Asset.DiscoverySpec parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Asset.DiscoverySpec parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Asset.DiscoverySpec parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Asset.DiscoverySpec.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Asset.DiscoverySpec.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Asset.DiscoverySpec.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Asset.DiscoverySpec> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Asset.DiscoverySpec getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder