Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1ZoneDiscoverySpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataplex_v1/classes.rb,
lib/google/apis/dataplex_v1/representations.rb,
lib/google/apis/dataplex_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1ZoneDiscoverySpec

Returns a new instance of GoogleCloudDataplexV1ZoneDiscoverySpec.



3126
3127
3128
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3126

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#csv_options ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions

Describe CSV and similar semi-structured data formats. Corresponds to the JSON property csvOptions

Returns:



3085
3086
3087
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3085

def csv_options
  @csv_options
end

#enabled ⇒ Boolean Also known as: enabled?

Required. Whether discovery is enabled. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


3090
3091
3092
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3090

def enabled
  @enabled
end

#exclude_patterns ⇒ 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. Corresponds to the JSON property excludePatterns

Returns:

  • (Array<String>) 


3099
3100
3101
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3099

def exclude_patterns
  @exclude_patterns
end

#include_patterns ⇒ 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. Corresponds to the JSON property includePatterns

Returns:

  • (Array<String>) 


3108
3109
3110
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3108

def include_patterns
  @include_patterns
end

#json_options ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions

Describe JSON data format. Corresponds to the JSON property jsonOptions

Returns:



3113
3114
3115
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3113

def json_options
  @json_options
end

#schedule ⇒ 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 * * * *", or "TZ=America/New_York 1 * * * *". Corresponds to the JSON property schedule

Returns:

  • (String) 


3124
3125
3126
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3124

def schedule
  @schedule
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3131

def update!(**args)
  @csv_options = args[:csv_options] if args.key?(:csv_options)
  @enabled = args[:enabled] if args.key?(:enabled)
  @exclude_patterns = args[:exclude_patterns] if args.key?(:exclude_patterns)
  @include_patterns = args[:include_patterns] if args.key?(:include_patterns)
  @json_options = args[:json_options] if args.key?(:json_options)
  @schedule = args[:schedule] if args.key?(:schedule)
end