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

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

Overview

A zone represents a logical group of related assets within a lake. A zone can be used to map to organizational structure or represent stages of data readiness from raw to curated. It provides managing behavior that is shared or inherited by all contained assets.

Defined Under Namespace

Modules: Type Classes: DiscoverySpec, LabelsEntry, ResourceSpec

Instance Attribute Summary collapse

Instance Attribute Details

#asset_status ⇒ ::Google::Cloud::Dataplex::V1::AssetStatus (readonly)

Returns Output only. Aggregated status of the underlying assets of the zone.

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the zone was created.

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end

#description ⇒ ::String

Returns Optional. Description of the zone.

Returns:

  • (::String) —

    Optional. Description of the zone.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end

#discovery_spec ⇒ ::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec

Returns Optional. Specification of the discovery feature applied to data in this zone.

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end

#display_name ⇒ ::String

Returns Optional. User friendly display name.

Returns:

  • (::String) —

    Optional. User friendly display name.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. User defined labels for the zone.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User defined labels for the zone.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.

Returns:

  • (::String) —

    Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end

#resource_spec ⇒ ::Google::Cloud::Dataplex::V1::Zone::ResourceSpec

Returns Required. Specification of the resources that are referenced by the assets within this zone.

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end

#state ⇒ ::Google::Cloud::Dataplex::V1::State (readonly)

Returns Output only. Current state of the zone.

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end

#type ⇒ ::Google::Cloud::Dataplex::V1::Zone::Type

Returns Required. Immutable. The type of the zone.

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. System generated globally unique ID for the zone. This ID will be different if the zone is deleted and re-created with the same name.

Returns:

  • (::String) —

    Output only. System generated globally unique ID for the zone. This ID will be different if the zone is deleted and re-created with the same name.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the zone was last updated.

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'proto_docs/google/cloud/dataplex/v1/resources.rb', line 195

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

  # Settings for resources attached as assets within a zone.
  # @!attribute [rw] location_type
  #   @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
  #     Required. Immutable. The location type of the resources that are allowed
  #     to be attached to the assets within this zone.
  class ResourceSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Location type of the resources attached to a zone.
    module LocationType
      # Unspecified location type.
      LOCATION_TYPE_UNSPECIFIED = 0

      # Resources that are associated with a single region.
      SINGLE_REGION = 1

      # Resources that are associated with a multi-region location.
      MULTI_REGION = 2
    end
  end

  # Settings to manage the metadata discovery and publishing in a zone.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Required. Whether discovery is enabled.
  # @!attribute [rw] include_patterns
  #   @return [::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.
  # @!attribute [rw] exclude_patterns
  #   @return [::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.
  # @!attribute [rw] csv_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
  #     Optional. Configuration for CSV data.
  # @!attribute [rw] json_options
  #   @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::JsonOptions]
  #     Optional. Configuration for Json data.
  # @!attribute [rw] schedule
  #   @return [::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 * * * *`.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of zone.
  module Type
    # Zone type not specified.
    TYPE_UNSPECIFIED = 0

    # A zone that contains data that needs further processing before it is
    # considered generally ready for consumption and analytics workloads.
    RAW = 1

    # A zone that contains data that is considered to be ready for broader
    # consumption and analytics workloads. Curated structured data stored in
    # Cloud Storage must conform to certain file formats (parquet, avro and
    # orc) and organized in a hive-compatible directory layout.
    CURATED = 2
  end
end