Class: Google::Cloud::Dataplex::V1::Zone::DiscoverySpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/resources.rb

Overview

Settings to manage the metadata discovery and publishing in a zone.

Defined Under Namespace

Classes: CsvOptions, JsonOptions

Instance Attribute Summary collapse

Instance Attribute Details

#csv_options ⇒ ::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions

Returns Optional. Configuration for CSV data.

Returns:



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 254

class DiscoverySpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe CSV and similar semi-structured data formats.
  # @!attribute [rw] header_rows
  #   @return [::Integer]
  #     Optional. The number of rows to interpret as header rows that should be
  #     skipped when reading data rows.
  # @!attribute [rw] delimiter
  #   @return [::String]
  #     Optional. The delimiter being used to separate values. This defaults to
  #     ','.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for CSV data.
  #     If true, all columns will be registered as strings.
  class CsvOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describe JSON data format.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for Json data.
  #     If true, all columns will be registered as their primitive types
  #     (strings, number or boolean).
  class JsonOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#enabled ⇒ ::Boolean

Returns Required. Whether discovery is enabled.

Returns:

  • (::Boolean) —

    Required. Whether discovery is enabled.



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 254

class DiscoverySpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe CSV and similar semi-structured data formats.
  # @!attribute [rw] header_rows
  #   @return [::Integer]
  #     Optional. The number of rows to interpret as header rows that should be
  #     skipped when reading data rows.
  # @!attribute [rw] delimiter
  #   @return [::String]
  #     Optional. The delimiter being used to separate values. This defaults to
  #     ','.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for CSV data.
  #     If true, all columns will be registered as strings.
  class CsvOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describe JSON data format.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for Json data.
  #     If true, all columns will be registered as their primitive types
  #     (strings, number or boolean).
  class JsonOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#exclude_patterns ⇒ ::Array<::String>

Returns 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.

Returns:

  • (::Array<::String>) —

    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.



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 254

class DiscoverySpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe CSV and similar semi-structured data formats.
  # @!attribute [rw] header_rows
  #   @return [::Integer]
  #     Optional. The number of rows to interpret as header rows that should be
  #     skipped when reading data rows.
  # @!attribute [rw] delimiter
  #   @return [::String]
  #     Optional. The delimiter being used to separate values. This defaults to
  #     ','.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for CSV data.
  #     If true, all columns will be registered as strings.
  class CsvOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describe JSON data format.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for Json data.
  #     If true, all columns will be registered as their primitive types
  #     (strings, number or boolean).
  class JsonOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#include_patterns ⇒ ::Array<::String>

Returns 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.

Returns:

  • (::Array<::String>) —

    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.



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 254

class DiscoverySpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe CSV and similar semi-structured data formats.
  # @!attribute [rw] header_rows
  #   @return [::Integer]
  #     Optional. The number of rows to interpret as header rows that should be
  #     skipped when reading data rows.
  # @!attribute [rw] delimiter
  #   @return [::String]
  #     Optional. The delimiter being used to separate values. This defaults to
  #     ','.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for CSV data.
  #     If true, all columns will be registered as strings.
  class CsvOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describe JSON data format.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for Json data.
  #     If true, all columns will be registered as their primitive types
  #     (strings, number or boolean).
  class JsonOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#json_options ⇒ ::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions

Returns Optional. Configuration for Json data.

Returns:



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 254

class DiscoverySpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe CSV and similar semi-structured data formats.
  # @!attribute [rw] header_rows
  #   @return [::Integer]
  #     Optional. The number of rows to interpret as header rows that should be
  #     skipped when reading data rows.
  # @!attribute [rw] delimiter
  #   @return [::String]
  #     Optional. The delimiter being used to separate values. This defaults to
  #     ','.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for CSV data.
  #     If true, all columns will be registered as strings.
  class CsvOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describe JSON data format.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for Json data.
  #     If true, all columns will be registered as their primitive types
  #     (strings, number or boolean).
  class JsonOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#schedule ⇒ ::String

Returns 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

  • * * *, orTZ=America/New_York 1 * * * *`.

Returns:

  • (::String) —

    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

    • * * *, orTZ=America/New_York 1 * * * *`.


254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 254

class DiscoverySpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe CSV and similar semi-structured data formats.
  # @!attribute [rw] header_rows
  #   @return [::Integer]
  #     Optional. The number of rows to interpret as header rows that should be
  #     skipped when reading data rows.
  # @!attribute [rw] delimiter
  #   @return [::String]
  #     Optional. The delimiter being used to separate values. This defaults to
  #     ','.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for CSV data.
  #     If true, all columns will be registered as strings.
  class CsvOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describe JSON data format.
  # @!attribute [rw] encoding
  #   @return [::String]
  #     Optional. The character encoding of the data. The default is UTF-8.
  # @!attribute [rw] disable_type_inference
  #   @return [::Boolean]
  #     Optional. Whether to disable the inference of data type for Json data.
  #     If true, all columns will be registered as their primitive types
  #     (strings, number or boolean).
  class JsonOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end