Package com.google.cloud.dataplex.v1

Class Zone.DiscoverySpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.Zone.DiscoverySpec
All Implemented Interfaces:
Zone.DiscoverySpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Zone
public static final class Zone.DiscoverySpec extends com.google.protobuf.GeneratedMessage implements Zone.DiscoverySpecOrBuilder
 Settings to manage the metadata discovery and publishing in a zone.
Protobuf type google.cloud.dataplex.v1.Zone.DiscoverySpec
See Also:

  • Field Details

    • ENABLED_FIELD_NUMBER

      public static final int ENABLED_FIELD_NUMBER
      See Also:

    • INCLUDE_PATTERNS_FIELD_NUMBER

      public static final int INCLUDE_PATTERNS_FIELD_NUMBER
      See Also:

    • EXCLUDE_PATTERNS_FIELD_NUMBER

      public static final int EXCLUDE_PATTERNS_FIELD_NUMBER
      See Also:

    • CSV_OPTIONS_FIELD_NUMBER

      public static final int CSV_OPTIONS_FIELD_NUMBER
      See Also:

    • JSON_OPTIONS_FIELD_NUMBER

      public static final int JSON_OPTIONS_FIELD_NUMBER
      See Also:

    • SCHEDULE_FIELD_NUMBER

      public static final int SCHEDULE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getTriggerCase

      public Zone.DiscoverySpec.TriggerCase getTriggerCase()
      Specified by:
      getTriggerCase in interface Zone.DiscoverySpecOrBuilder

    • getEnabled

      public boolean getEnabled()
       Required. Whether discovery is enabled.
      bool enabled = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEnabled in interface Zone.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 Zone.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 Zone.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 Zone.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 Zone.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 Zone.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 Zone.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 Zone.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 Zone.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.Zone.DiscoverySpec.CsvOptions csv_options = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCsvOptions in interface Zone.DiscoverySpecOrBuilder
      Returns:
      Whether the csvOptions field is set.

    • 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];
      Specified by:
      getCsvOptions in interface Zone.DiscoverySpecOrBuilder
      Returns:
      The csvOptions.

    • 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];
      Specified by:
      getCsvOptionsOrBuilder in interface Zone.DiscoverySpecOrBuilder

    • hasJsonOptions

      public boolean hasJsonOptions()
       Optional. Configuration for Json data.
      .google.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions json_options = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasJsonOptions in interface Zone.DiscoverySpecOrBuilder
      Returns:
      Whether the jsonOptions field is set.

    • 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];
      Specified by:
      getJsonOptions in interface Zone.DiscoverySpecOrBuilder
      Returns:
      The jsonOptions.

    • 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];
      Specified by:
      getJsonOptionsOrBuilder in interface Zone.DiscoverySpecOrBuilder

    • 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 Zone.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 Zone.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 Zone.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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 Zone.DiscoverySpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Zone.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 Zone.DiscoverySpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Zone.DiscoverySpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Zone.DiscoverySpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Zone.DiscoverySpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Zone.DiscoverySpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Zone.DiscoverySpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Zone.DiscoverySpec.Builder newBuilder()

    • newBuilder

      public static Zone.DiscoverySpec.Builder newBuilder(Zone.DiscoverySpec prototype)

    • toBuilder

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

    • newBuilderForType

      protected Zone.DiscoverySpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Zone.DiscoverySpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Zone.DiscoverySpec> parser()

    • getParserForType

      public com.google.protobuf.Parser<Zone.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.GeneratedMessage

    • getDefaultInstanceForType

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