Class: Google::Cloud::Dataplex::V1::MetadataJob

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

Overview

A metadata job resource.

Defined Under Namespace

Modules: Type Classes: ImportJobResult, ImportJobSpec, LabelsEntry, Status

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. The time when the metadata job was created.

Returns:



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1307

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

  # Results from a metadata import job.
  # @!attribute [r] deleted_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were deleted.
  # @!attribute [r] updated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were updated.
  # @!attribute [r] created_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were created.
  # @!attribute [r] unchanged_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were unchanged.
  # @!attribute [r] recreated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were recreated.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job
  # @!attribute [rw] source_storage_uri
  #   @return [::String]
  #     Optional. The URI of a Cloud Storage bucket or folder (beginning with
  #     `gs://` and ending with `/`) that contains the metadata import files for
  #     this job.
  #
  #     A metadata import file defines the values to set for each of the entries
  #     and aspects in a metadata job. For more information about how to create a
  #     metadata import file and the file requirements, see [Metadata import
  #     file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
  #
  #     You can provide multiple metadata import files in the same metadata job.
  #     The bucket or folder must contain at least one metadata import file, in
  #     JSON Lines format (either `.json` or `.jsonl` file extension).
  #
  #     In `FULL` entry sync mode, don't save the metadata import file in a
  #     folder named `SOURCE_STORAGE_URI/deletions/`.
  #
  #     **Caution**: If the metadata import file contains no data, all entries
  #     and aspects that belong to the job's scope are deleted.
  # @!attribute [rw] source_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the process that created the metadata import
  #     files began.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope]
  #     Required. A boundary on the scope of impact that the metadata import job
  #     can have.
  # @!attribute [rw] entry_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for entries.
  #     Only `FULL` mode is supported for entries. All entries in the job's scope
  #     are modified. If an entry exists in Dataplex but isn't included in the
  #     metadata import file, the entry is deleted when you run the metadata job.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  #     Only `INCREMENTAL` mode is supported for aspects. An aspect is modified
  #     only if the metadata import file includes a reference to the aspect in
  #     the `update_mask` field and the `aspect_keys` field.
  # @!attribute [rw] log_level
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel]
  #     Optional. The level of logs to write to Cloud Logging for this job.
  #
  #     Debug-level logs provide highly-detailed information for
  #     troubleshooting, but their increased verbosity could incur [additional
  #     costs](https://cloud.google.com/stackdriver/pricing) that might not be
  #     merited for all jobs.
  #
  #     If unspecified, defaults to `INFO`.
  class ImportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A boundary on the scope of impact that the metadata import job can have.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     Required. The entry group that is in scope for the import job,
    #     specified as a relative resource name in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries that belong to the specified entry group are affected by
    #     the job.
    #
    #     Must contain exactly one element. The entry group and the job
    #     must be in the same location.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     Required. The entry types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`.
    #     The job modifies only the entries that belong to these entry types.
    #
    #     If the metadata import file attempts to modify an entry whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an entry type must either match the location of the
    #     job, or the entry type must be global.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     Optional. The aspect types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
    #     The job modifies only the aspects that belong to these aspect types.
    #
    #     If the metadata import file attempts to modify an aspect whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an aspect type must either match the location of the
    #     job, or the aspect type must be global.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata job are updated.
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex but isn't included in the metadata import file, the resource
      # is deleted when you run the metadata job. Use this mode to perform a
      # full sync of the set of entries in the job scope.
      FULL = 1

      # Only the entries and aspects that are explicitly included in the
      # metadata import file are modified. Use this mode to modify a subset of
      # resources while leaving unreferenced resources unchanged.
      INCREMENTAL = 2
    end

    # The level of logs to write to Cloud Logging for this job.
    module LogLevel
      # Log level unspecified.
      LOG_LEVEL_UNSPECIFIED = 0

      # Debug-level logging. Captures detailed logs for each import item. Use
      # debug-level logging to troubleshoot issues with specific import items.
      # For example, use debug-level logging to identify resources that are
      # missing from the job scope, entries or aspects that don't conform to
      # the associated entry type or aspect type, or other misconfigurations
      # with the metadata import file.
      #
      # Depending on the size of your metadata job and the number of logs that
      # are generated, debug-level logging might incur
      # [additional costs](https://cloud.google.com/stackdriver/pricing).
      DEBUG = 1

      # Info-level logging. Captures logs at the overall job level. Includes
      # aggregate logs about import items, but doesn't specify which import
      # item has an error.
      INFO = 2
    end
  end

  # Metadata job status.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::Status::State]
  #     Output only. State of the metadata job.
  # @!attribute [r] message
  #   @return [::String]
  #     Output only. Message relating to the progression of a metadata job.
  # @!attribute [r] completion_percent
  #   @return [::Integer]
  #     Output only. Progress tracking.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class Status
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of a metadata job.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # The job is queued.
      QUEUED = 1

      # The job is running.
      RUNNING = 2

      # The job is being canceled.
      CANCELING = 3

      # The job is canceled.
      CANCELED = 4

      # The job succeeded.
      SUCCEEDED = 5

      # The job failed.
      FAILED = 6

      # The job completed with some errors.
      SUCCEEDED_WITH_ERRORS = 7
    end
  end

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

  # Metadata job type.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Import job.
    IMPORT = 1
  end
end

#import_result ⇒ ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobResult (readonly)

Returns Output only. Import job result.

Returns:



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1307

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

  # Results from a metadata import job.
  # @!attribute [r] deleted_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were deleted.
  # @!attribute [r] updated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were updated.
  # @!attribute [r] created_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were created.
  # @!attribute [r] unchanged_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were unchanged.
  # @!attribute [r] recreated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were recreated.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job
  # @!attribute [rw] source_storage_uri
  #   @return [::String]
  #     Optional. The URI of a Cloud Storage bucket or folder (beginning with
  #     `gs://` and ending with `/`) that contains the metadata import files for
  #     this job.
  #
  #     A metadata import file defines the values to set for each of the entries
  #     and aspects in a metadata job. For more information about how to create a
  #     metadata import file and the file requirements, see [Metadata import
  #     file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
  #
  #     You can provide multiple metadata import files in the same metadata job.
  #     The bucket or folder must contain at least one metadata import file, in
  #     JSON Lines format (either `.json` or `.jsonl` file extension).
  #
  #     In `FULL` entry sync mode, don't save the metadata import file in a
  #     folder named `SOURCE_STORAGE_URI/deletions/`.
  #
  #     **Caution**: If the metadata import file contains no data, all entries
  #     and aspects that belong to the job's scope are deleted.
  # @!attribute [rw] source_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the process that created the metadata import
  #     files began.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope]
  #     Required. A boundary on the scope of impact that the metadata import job
  #     can have.
  # @!attribute [rw] entry_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for entries.
  #     Only `FULL` mode is supported for entries. All entries in the job's scope
  #     are modified. If an entry exists in Dataplex but isn't included in the
  #     metadata import file, the entry is deleted when you run the metadata job.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  #     Only `INCREMENTAL` mode is supported for aspects. An aspect is modified
  #     only if the metadata import file includes a reference to the aspect in
  #     the `update_mask` field and the `aspect_keys` field.
  # @!attribute [rw] log_level
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel]
  #     Optional. The level of logs to write to Cloud Logging for this job.
  #
  #     Debug-level logs provide highly-detailed information for
  #     troubleshooting, but their increased verbosity could incur [additional
  #     costs](https://cloud.google.com/stackdriver/pricing) that might not be
  #     merited for all jobs.
  #
  #     If unspecified, defaults to `INFO`.
  class ImportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A boundary on the scope of impact that the metadata import job can have.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     Required. The entry group that is in scope for the import job,
    #     specified as a relative resource name in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries that belong to the specified entry group are affected by
    #     the job.
    #
    #     Must contain exactly one element. The entry group and the job
    #     must be in the same location.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     Required. The entry types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`.
    #     The job modifies only the entries that belong to these entry types.
    #
    #     If the metadata import file attempts to modify an entry whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an entry type must either match the location of the
    #     job, or the entry type must be global.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     Optional. The aspect types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
    #     The job modifies only the aspects that belong to these aspect types.
    #
    #     If the metadata import file attempts to modify an aspect whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an aspect type must either match the location of the
    #     job, or the aspect type must be global.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata job are updated.
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex but isn't included in the metadata import file, the resource
      # is deleted when you run the metadata job. Use this mode to perform a
      # full sync of the set of entries in the job scope.
      FULL = 1

      # Only the entries and aspects that are explicitly included in the
      # metadata import file are modified. Use this mode to modify a subset of
      # resources while leaving unreferenced resources unchanged.
      INCREMENTAL = 2
    end

    # The level of logs to write to Cloud Logging for this job.
    module LogLevel
      # Log level unspecified.
      LOG_LEVEL_UNSPECIFIED = 0

      # Debug-level logging. Captures detailed logs for each import item. Use
      # debug-level logging to troubleshoot issues with specific import items.
      # For example, use debug-level logging to identify resources that are
      # missing from the job scope, entries or aspects that don't conform to
      # the associated entry type or aspect type, or other misconfigurations
      # with the metadata import file.
      #
      # Depending on the size of your metadata job and the number of logs that
      # are generated, debug-level logging might incur
      # [additional costs](https://cloud.google.com/stackdriver/pricing).
      DEBUG = 1

      # Info-level logging. Captures logs at the overall job level. Includes
      # aggregate logs about import items, but doesn't specify which import
      # item has an error.
      INFO = 2
    end
  end

  # Metadata job status.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::Status::State]
  #     Output only. State of the metadata job.
  # @!attribute [r] message
  #   @return [::String]
  #     Output only. Message relating to the progression of a metadata job.
  # @!attribute [r] completion_percent
  #   @return [::Integer]
  #     Output only. Progress tracking.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class Status
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of a metadata job.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # The job is queued.
      QUEUED = 1

      # The job is running.
      RUNNING = 2

      # The job is being canceled.
      CANCELING = 3

      # The job is canceled.
      CANCELED = 4

      # The job succeeded.
      SUCCEEDED = 5

      # The job failed.
      FAILED = 6

      # The job completed with some errors.
      SUCCEEDED_WITH_ERRORS = 7
    end
  end

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

  # Metadata job type.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Import job.
    IMPORT = 1
  end
end

#import_spec ⇒ ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec

Returns Import job specification.

Returns:



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1307

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

  # Results from a metadata import job.
  # @!attribute [r] deleted_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were deleted.
  # @!attribute [r] updated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were updated.
  # @!attribute [r] created_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were created.
  # @!attribute [r] unchanged_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were unchanged.
  # @!attribute [r] recreated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were recreated.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job
  # @!attribute [rw] source_storage_uri
  #   @return [::String]
  #     Optional. The URI of a Cloud Storage bucket or folder (beginning with
  #     `gs://` and ending with `/`) that contains the metadata import files for
  #     this job.
  #
  #     A metadata import file defines the values to set for each of the entries
  #     and aspects in a metadata job. For more information about how to create a
  #     metadata import file and the file requirements, see [Metadata import
  #     file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
  #
  #     You can provide multiple metadata import files in the same metadata job.
  #     The bucket or folder must contain at least one metadata import file, in
  #     JSON Lines format (either `.json` or `.jsonl` file extension).
  #
  #     In `FULL` entry sync mode, don't save the metadata import file in a
  #     folder named `SOURCE_STORAGE_URI/deletions/`.
  #
  #     **Caution**: If the metadata import file contains no data, all entries
  #     and aspects that belong to the job's scope are deleted.
  # @!attribute [rw] source_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the process that created the metadata import
  #     files began.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope]
  #     Required. A boundary on the scope of impact that the metadata import job
  #     can have.
  # @!attribute [rw] entry_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for entries.
  #     Only `FULL` mode is supported for entries. All entries in the job's scope
  #     are modified. If an entry exists in Dataplex but isn't included in the
  #     metadata import file, the entry is deleted when you run the metadata job.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  #     Only `INCREMENTAL` mode is supported for aspects. An aspect is modified
  #     only if the metadata import file includes a reference to the aspect in
  #     the `update_mask` field and the `aspect_keys` field.
  # @!attribute [rw] log_level
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel]
  #     Optional. The level of logs to write to Cloud Logging for this job.
  #
  #     Debug-level logs provide highly-detailed information for
  #     troubleshooting, but their increased verbosity could incur [additional
  #     costs](https://cloud.google.com/stackdriver/pricing) that might not be
  #     merited for all jobs.
  #
  #     If unspecified, defaults to `INFO`.
  class ImportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A boundary on the scope of impact that the metadata import job can have.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     Required. The entry group that is in scope for the import job,
    #     specified as a relative resource name in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries that belong to the specified entry group are affected by
    #     the job.
    #
    #     Must contain exactly one element. The entry group and the job
    #     must be in the same location.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     Required. The entry types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`.
    #     The job modifies only the entries that belong to these entry types.
    #
    #     If the metadata import file attempts to modify an entry whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an entry type must either match the location of the
    #     job, or the entry type must be global.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     Optional. The aspect types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
    #     The job modifies only the aspects that belong to these aspect types.
    #
    #     If the metadata import file attempts to modify an aspect whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an aspect type must either match the location of the
    #     job, or the aspect type must be global.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata job are updated.
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex but isn't included in the metadata import file, the resource
      # is deleted when you run the metadata job. Use this mode to perform a
      # full sync of the set of entries in the job scope.
      FULL = 1

      # Only the entries and aspects that are explicitly included in the
      # metadata import file are modified. Use this mode to modify a subset of
      # resources while leaving unreferenced resources unchanged.
      INCREMENTAL = 2
    end

    # The level of logs to write to Cloud Logging for this job.
    module LogLevel
      # Log level unspecified.
      LOG_LEVEL_UNSPECIFIED = 0

      # Debug-level logging. Captures detailed logs for each import item. Use
      # debug-level logging to troubleshoot issues with specific import items.
      # For example, use debug-level logging to identify resources that are
      # missing from the job scope, entries or aspects that don't conform to
      # the associated entry type or aspect type, or other misconfigurations
      # with the metadata import file.
      #
      # Depending on the size of your metadata job and the number of logs that
      # are generated, debug-level logging might incur
      # [additional costs](https://cloud.google.com/stackdriver/pricing).
      DEBUG = 1

      # Info-level logging. Captures logs at the overall job level. Includes
      # aggregate logs about import items, but doesn't specify which import
      # item has an error.
      INFO = 2
    end
  end

  # Metadata job status.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::Status::State]
  #     Output only. State of the metadata job.
  # @!attribute [r] message
  #   @return [::String]
  #     Output only. Message relating to the progression of a metadata job.
  # @!attribute [r] completion_percent
  #   @return [::Integer]
  #     Output only. Progress tracking.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class Status
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of a metadata job.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # The job is queued.
      QUEUED = 1

      # The job is running.
      RUNNING = 2

      # The job is being canceled.
      CANCELING = 3

      # The job is canceled.
      CANCELED = 4

      # The job succeeded.
      SUCCEEDED = 5

      # The job failed.
      FAILED = 6

      # The job completed with some errors.
      SUCCEEDED_WITH_ERRORS = 7
    end
  end

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

  # Metadata job type.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Import job.
    IMPORT = 1
  end
end

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

Returns Optional. User-defined labels.

Returns:

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

    Optional. User-defined labels.



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1307

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

  # Results from a metadata import job.
  # @!attribute [r] deleted_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were deleted.
  # @!attribute [r] updated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were updated.
  # @!attribute [r] created_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were created.
  # @!attribute [r] unchanged_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were unchanged.
  # @!attribute [r] recreated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were recreated.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job
  # @!attribute [rw] source_storage_uri
  #   @return [::String]
  #     Optional. The URI of a Cloud Storage bucket or folder (beginning with
  #     `gs://` and ending with `/`) that contains the metadata import files for
  #     this job.
  #
  #     A metadata import file defines the values to set for each of the entries
  #     and aspects in a metadata job. For more information about how to create a
  #     metadata import file and the file requirements, see [Metadata import
  #     file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
  #
  #     You can provide multiple metadata import files in the same metadata job.
  #     The bucket or folder must contain at least one metadata import file, in
  #     JSON Lines format (either `.json` or `.jsonl` file extension).
  #
  #     In `FULL` entry sync mode, don't save the metadata import file in a
  #     folder named `SOURCE_STORAGE_URI/deletions/`.
  #
  #     **Caution**: If the metadata import file contains no data, all entries
  #     and aspects that belong to the job's scope are deleted.
  # @!attribute [rw] source_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the process that created the metadata import
  #     files began.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope]
  #     Required. A boundary on the scope of impact that the metadata import job
  #     can have.
  # @!attribute [rw] entry_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for entries.
  #     Only `FULL` mode is supported for entries. All entries in the job's scope
  #     are modified. If an entry exists in Dataplex but isn't included in the
  #     metadata import file, the entry is deleted when you run the metadata job.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  #     Only `INCREMENTAL` mode is supported for aspects. An aspect is modified
  #     only if the metadata import file includes a reference to the aspect in
  #     the `update_mask` field and the `aspect_keys` field.
  # @!attribute [rw] log_level
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel]
  #     Optional. The level of logs to write to Cloud Logging for this job.
  #
  #     Debug-level logs provide highly-detailed information for
  #     troubleshooting, but their increased verbosity could incur [additional
  #     costs](https://cloud.google.com/stackdriver/pricing) that might not be
  #     merited for all jobs.
  #
  #     If unspecified, defaults to `INFO`.
  class ImportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A boundary on the scope of impact that the metadata import job can have.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     Required. The entry group that is in scope for the import job,
    #     specified as a relative resource name in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries that belong to the specified entry group are affected by
    #     the job.
    #
    #     Must contain exactly one element. The entry group and the job
    #     must be in the same location.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     Required. The entry types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`.
    #     The job modifies only the entries that belong to these entry types.
    #
    #     If the metadata import file attempts to modify an entry whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an entry type must either match the location of the
    #     job, or the entry type must be global.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     Optional. The aspect types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
    #     The job modifies only the aspects that belong to these aspect types.
    #
    #     If the metadata import file attempts to modify an aspect whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an aspect type must either match the location of the
    #     job, or the aspect type must be global.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata job are updated.
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex but isn't included in the metadata import file, the resource
      # is deleted when you run the metadata job. Use this mode to perform a
      # full sync of the set of entries in the job scope.
      FULL = 1

      # Only the entries and aspects that are explicitly included in the
      # metadata import file are modified. Use this mode to modify a subset of
      # resources while leaving unreferenced resources unchanged.
      INCREMENTAL = 2
    end

    # The level of logs to write to Cloud Logging for this job.
    module LogLevel
      # Log level unspecified.
      LOG_LEVEL_UNSPECIFIED = 0

      # Debug-level logging. Captures detailed logs for each import item. Use
      # debug-level logging to troubleshoot issues with specific import items.
      # For example, use debug-level logging to identify resources that are
      # missing from the job scope, entries or aspects that don't conform to
      # the associated entry type or aspect type, or other misconfigurations
      # with the metadata import file.
      #
      # Depending on the size of your metadata job and the number of logs that
      # are generated, debug-level logging might incur
      # [additional costs](https://cloud.google.com/stackdriver/pricing).
      DEBUG = 1

      # Info-level logging. Captures logs at the overall job level. Includes
      # aggregate logs about import items, but doesn't specify which import
      # item has an error.
      INFO = 2
    end
  end

  # Metadata job status.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::Status::State]
  #     Output only. State of the metadata job.
  # @!attribute [r] message
  #   @return [::String]
  #     Output only. Message relating to the progression of a metadata job.
  # @!attribute [r] completion_percent
  #   @return [::Integer]
  #     Output only. Progress tracking.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class Status
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of a metadata job.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # The job is queued.
      QUEUED = 1

      # The job is running.
      RUNNING = 2

      # The job is being canceled.
      CANCELING = 3

      # The job is canceled.
      CANCELED = 4

      # The job succeeded.
      SUCCEEDED = 5

      # The job failed.
      FAILED = 6

      # The job completed with some errors.
      SUCCEEDED_WITH_ERRORS = 7
    end
  end

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

  # Metadata job type.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Import job.
    IMPORT = 1
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Identifier. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.

Returns:

  • (::String) —

    Output only. Identifier. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1307

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

  # Results from a metadata import job.
  # @!attribute [r] deleted_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were deleted.
  # @!attribute [r] updated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were updated.
  # @!attribute [r] created_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were created.
  # @!attribute [r] unchanged_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were unchanged.
  # @!attribute [r] recreated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were recreated.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job
  # @!attribute [rw] source_storage_uri
  #   @return [::String]
  #     Optional. The URI of a Cloud Storage bucket or folder (beginning with
  #     `gs://` and ending with `/`) that contains the metadata import files for
  #     this job.
  #
  #     A metadata import file defines the values to set for each of the entries
  #     and aspects in a metadata job. For more information about how to create a
  #     metadata import file and the file requirements, see [Metadata import
  #     file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
  #
  #     You can provide multiple metadata import files in the same metadata job.
  #     The bucket or folder must contain at least one metadata import file, in
  #     JSON Lines format (either `.json` or `.jsonl` file extension).
  #
  #     In `FULL` entry sync mode, don't save the metadata import file in a
  #     folder named `SOURCE_STORAGE_URI/deletions/`.
  #
  #     **Caution**: If the metadata import file contains no data, all entries
  #     and aspects that belong to the job's scope are deleted.
  # @!attribute [rw] source_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the process that created the metadata import
  #     files began.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope]
  #     Required. A boundary on the scope of impact that the metadata import job
  #     can have.
  # @!attribute [rw] entry_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for entries.
  #     Only `FULL` mode is supported for entries. All entries in the job's scope
  #     are modified. If an entry exists in Dataplex but isn't included in the
  #     metadata import file, the entry is deleted when you run the metadata job.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  #     Only `INCREMENTAL` mode is supported for aspects. An aspect is modified
  #     only if the metadata import file includes a reference to the aspect in
  #     the `update_mask` field and the `aspect_keys` field.
  # @!attribute [rw] log_level
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel]
  #     Optional. The level of logs to write to Cloud Logging for this job.
  #
  #     Debug-level logs provide highly-detailed information for
  #     troubleshooting, but their increased verbosity could incur [additional
  #     costs](https://cloud.google.com/stackdriver/pricing) that might not be
  #     merited for all jobs.
  #
  #     If unspecified, defaults to `INFO`.
  class ImportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A boundary on the scope of impact that the metadata import job can have.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     Required. The entry group that is in scope for the import job,
    #     specified as a relative resource name in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries that belong to the specified entry group are affected by
    #     the job.
    #
    #     Must contain exactly one element. The entry group and the job
    #     must be in the same location.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     Required. The entry types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`.
    #     The job modifies only the entries that belong to these entry types.
    #
    #     If the metadata import file attempts to modify an entry whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an entry type must either match the location of the
    #     job, or the entry type must be global.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     Optional. The aspect types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
    #     The job modifies only the aspects that belong to these aspect types.
    #
    #     If the metadata import file attempts to modify an aspect whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an aspect type must either match the location of the
    #     job, or the aspect type must be global.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata job are updated.
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex but isn't included in the metadata import file, the resource
      # is deleted when you run the metadata job. Use this mode to perform a
      # full sync of the set of entries in the job scope.
      FULL = 1

      # Only the entries and aspects that are explicitly included in the
      # metadata import file are modified. Use this mode to modify a subset of
      # resources while leaving unreferenced resources unchanged.
      INCREMENTAL = 2
    end

    # The level of logs to write to Cloud Logging for this job.
    module LogLevel
      # Log level unspecified.
      LOG_LEVEL_UNSPECIFIED = 0

      # Debug-level logging. Captures detailed logs for each import item. Use
      # debug-level logging to troubleshoot issues with specific import items.
      # For example, use debug-level logging to identify resources that are
      # missing from the job scope, entries or aspects that don't conform to
      # the associated entry type or aspect type, or other misconfigurations
      # with the metadata import file.
      #
      # Depending on the size of your metadata job and the number of logs that
      # are generated, debug-level logging might incur
      # [additional costs](https://cloud.google.com/stackdriver/pricing).
      DEBUG = 1

      # Info-level logging. Captures logs at the overall job level. Includes
      # aggregate logs about import items, but doesn't specify which import
      # item has an error.
      INFO = 2
    end
  end

  # Metadata job status.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::Status::State]
  #     Output only. State of the metadata job.
  # @!attribute [r] message
  #   @return [::String]
  #     Output only. Message relating to the progression of a metadata job.
  # @!attribute [r] completion_percent
  #   @return [::Integer]
  #     Output only. Progress tracking.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class Status
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of a metadata job.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # The job is queued.
      QUEUED = 1

      # The job is running.
      RUNNING = 2

      # The job is being canceled.
      CANCELING = 3

      # The job is canceled.
      CANCELED = 4

      # The job succeeded.
      SUCCEEDED = 5

      # The job failed.
      FAILED = 6

      # The job completed with some errors.
      SUCCEEDED_WITH_ERRORS = 7
    end
  end

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

  # Metadata job type.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Import job.
    IMPORT = 1
  end
end

#status ⇒ ::Google::Cloud::Dataplex::V1::MetadataJob::Status (readonly)

Returns Output only. Metadata job status.

Returns:



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1307

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

  # Results from a metadata import job.
  # @!attribute [r] deleted_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were deleted.
  # @!attribute [r] updated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were updated.
  # @!attribute [r] created_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were created.
  # @!attribute [r] unchanged_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were unchanged.
  # @!attribute [r] recreated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were recreated.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job
  # @!attribute [rw] source_storage_uri
  #   @return [::String]
  #     Optional. The URI of a Cloud Storage bucket or folder (beginning with
  #     `gs://` and ending with `/`) that contains the metadata import files for
  #     this job.
  #
  #     A metadata import file defines the values to set for each of the entries
  #     and aspects in a metadata job. For more information about how to create a
  #     metadata import file and the file requirements, see [Metadata import
  #     file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
  #
  #     You can provide multiple metadata import files in the same metadata job.
  #     The bucket or folder must contain at least one metadata import file, in
  #     JSON Lines format (either `.json` or `.jsonl` file extension).
  #
  #     In `FULL` entry sync mode, don't save the metadata import file in a
  #     folder named `SOURCE_STORAGE_URI/deletions/`.
  #
  #     **Caution**: If the metadata import file contains no data, all entries
  #     and aspects that belong to the job's scope are deleted.
  # @!attribute [rw] source_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the process that created the metadata import
  #     files began.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope]
  #     Required. A boundary on the scope of impact that the metadata import job
  #     can have.
  # @!attribute [rw] entry_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for entries.
  #     Only `FULL` mode is supported for entries. All entries in the job's scope
  #     are modified. If an entry exists in Dataplex but isn't included in the
  #     metadata import file, the entry is deleted when you run the metadata job.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  #     Only `INCREMENTAL` mode is supported for aspects. An aspect is modified
  #     only if the metadata import file includes a reference to the aspect in
  #     the `update_mask` field and the `aspect_keys` field.
  # @!attribute [rw] log_level
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel]
  #     Optional. The level of logs to write to Cloud Logging for this job.
  #
  #     Debug-level logs provide highly-detailed information for
  #     troubleshooting, but their increased verbosity could incur [additional
  #     costs](https://cloud.google.com/stackdriver/pricing) that might not be
  #     merited for all jobs.
  #
  #     If unspecified, defaults to `INFO`.
  class ImportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A boundary on the scope of impact that the metadata import job can have.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     Required. The entry group that is in scope for the import job,
    #     specified as a relative resource name in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries that belong to the specified entry group are affected by
    #     the job.
    #
    #     Must contain exactly one element. The entry group and the job
    #     must be in the same location.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     Required. The entry types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`.
    #     The job modifies only the entries that belong to these entry types.
    #
    #     If the metadata import file attempts to modify an entry whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an entry type must either match the location of the
    #     job, or the entry type must be global.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     Optional. The aspect types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
    #     The job modifies only the aspects that belong to these aspect types.
    #
    #     If the metadata import file attempts to modify an aspect whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an aspect type must either match the location of the
    #     job, or the aspect type must be global.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata job are updated.
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex but isn't included in the metadata import file, the resource
      # is deleted when you run the metadata job. Use this mode to perform a
      # full sync of the set of entries in the job scope.
      FULL = 1

      # Only the entries and aspects that are explicitly included in the
      # metadata import file are modified. Use this mode to modify a subset of
      # resources while leaving unreferenced resources unchanged.
      INCREMENTAL = 2
    end

    # The level of logs to write to Cloud Logging for this job.
    module LogLevel
      # Log level unspecified.
      LOG_LEVEL_UNSPECIFIED = 0

      # Debug-level logging. Captures detailed logs for each import item. Use
      # debug-level logging to troubleshoot issues with specific import items.
      # For example, use debug-level logging to identify resources that are
      # missing from the job scope, entries or aspects that don't conform to
      # the associated entry type or aspect type, or other misconfigurations
      # with the metadata import file.
      #
      # Depending on the size of your metadata job and the number of logs that
      # are generated, debug-level logging might incur
      # [additional costs](https://cloud.google.com/stackdriver/pricing).
      DEBUG = 1

      # Info-level logging. Captures logs at the overall job level. Includes
      # aggregate logs about import items, but doesn't specify which import
      # item has an error.
      INFO = 2
    end
  end

  # Metadata job status.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::Status::State]
  #     Output only. State of the metadata job.
  # @!attribute [r] message
  #   @return [::String]
  #     Output only. Message relating to the progression of a metadata job.
  # @!attribute [r] completion_percent
  #   @return [::Integer]
  #     Output only. Progress tracking.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class Status
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of a metadata job.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # The job is queued.
      QUEUED = 1

      # The job is running.
      RUNNING = 2

      # The job is being canceled.
      CANCELING = 3

      # The job is canceled.
      CANCELED = 4

      # The job succeeded.
      SUCCEEDED = 5

      # The job failed.
      FAILED = 6

      # The job completed with some errors.
      SUCCEEDED_WITH_ERRORS = 7
    end
  end

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

  # Metadata job type.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Import job.
    IMPORT = 1
  end
end

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

Returns Required. Metadata job type.

Returns:



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1307

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

  # Results from a metadata import job.
  # @!attribute [r] deleted_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were deleted.
  # @!attribute [r] updated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were updated.
  # @!attribute [r] created_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were created.
  # @!attribute [r] unchanged_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were unchanged.
  # @!attribute [r] recreated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were recreated.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job
  # @!attribute [rw] source_storage_uri
  #   @return [::String]
  #     Optional. The URI of a Cloud Storage bucket or folder (beginning with
  #     `gs://` and ending with `/`) that contains the metadata import files for
  #     this job.
  #
  #     A metadata import file defines the values to set for each of the entries
  #     and aspects in a metadata job. For more information about how to create a
  #     metadata import file and the file requirements, see [Metadata import
  #     file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
  #
  #     You can provide multiple metadata import files in the same metadata job.
  #     The bucket or folder must contain at least one metadata import file, in
  #     JSON Lines format (either `.json` or `.jsonl` file extension).
  #
  #     In `FULL` entry sync mode, don't save the metadata import file in a
  #     folder named `SOURCE_STORAGE_URI/deletions/`.
  #
  #     **Caution**: If the metadata import file contains no data, all entries
  #     and aspects that belong to the job's scope are deleted.
  # @!attribute [rw] source_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the process that created the metadata import
  #     files began.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope]
  #     Required. A boundary on the scope of impact that the metadata import job
  #     can have.
  # @!attribute [rw] entry_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for entries.
  #     Only `FULL` mode is supported for entries. All entries in the job's scope
  #     are modified. If an entry exists in Dataplex but isn't included in the
  #     metadata import file, the entry is deleted when you run the metadata job.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  #     Only `INCREMENTAL` mode is supported for aspects. An aspect is modified
  #     only if the metadata import file includes a reference to the aspect in
  #     the `update_mask` field and the `aspect_keys` field.
  # @!attribute [rw] log_level
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel]
  #     Optional. The level of logs to write to Cloud Logging for this job.
  #
  #     Debug-level logs provide highly-detailed information for
  #     troubleshooting, but their increased verbosity could incur [additional
  #     costs](https://cloud.google.com/stackdriver/pricing) that might not be
  #     merited for all jobs.
  #
  #     If unspecified, defaults to `INFO`.
  class ImportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A boundary on the scope of impact that the metadata import job can have.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     Required. The entry group that is in scope for the import job,
    #     specified as a relative resource name in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries that belong to the specified entry group are affected by
    #     the job.
    #
    #     Must contain exactly one element. The entry group and the job
    #     must be in the same location.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     Required. The entry types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`.
    #     The job modifies only the entries that belong to these entry types.
    #
    #     If the metadata import file attempts to modify an entry whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an entry type must either match the location of the
    #     job, or the entry type must be global.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     Optional. The aspect types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
    #     The job modifies only the aspects that belong to these aspect types.
    #
    #     If the metadata import file attempts to modify an aspect whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an aspect type must either match the location of the
    #     job, or the aspect type must be global.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata job are updated.
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex but isn't included in the metadata import file, the resource
      # is deleted when you run the metadata job. Use this mode to perform a
      # full sync of the set of entries in the job scope.
      FULL = 1

      # Only the entries and aspects that are explicitly included in the
      # metadata import file are modified. Use this mode to modify a subset of
      # resources while leaving unreferenced resources unchanged.
      INCREMENTAL = 2
    end

    # The level of logs to write to Cloud Logging for this job.
    module LogLevel
      # Log level unspecified.
      LOG_LEVEL_UNSPECIFIED = 0

      # Debug-level logging. Captures detailed logs for each import item. Use
      # debug-level logging to troubleshoot issues with specific import items.
      # For example, use debug-level logging to identify resources that are
      # missing from the job scope, entries or aspects that don't conform to
      # the associated entry type or aspect type, or other misconfigurations
      # with the metadata import file.
      #
      # Depending on the size of your metadata job and the number of logs that
      # are generated, debug-level logging might incur
      # [additional costs](https://cloud.google.com/stackdriver/pricing).
      DEBUG = 1

      # Info-level logging. Captures logs at the overall job level. Includes
      # aggregate logs about import items, but doesn't specify which import
      # item has an error.
      INFO = 2
    end
  end

  # Metadata job status.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::Status::State]
  #     Output only. State of the metadata job.
  # @!attribute [r] message
  #   @return [::String]
  #     Output only. Message relating to the progression of a metadata job.
  # @!attribute [r] completion_percent
  #   @return [::Integer]
  #     Output only. Progress tracking.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class Status
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of a metadata job.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # The job is queued.
      QUEUED = 1

      # The job is running.
      RUNNING = 2

      # The job is being canceled.
      CANCELING = 3

      # The job is canceled.
      CANCELED = 4

      # The job succeeded.
      SUCCEEDED = 5

      # The job failed.
      FAILED = 6

      # The job completed with some errors.
      SUCCEEDED_WITH_ERRORS = 7
    end
  end

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

  # Metadata job type.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Import job.
    IMPORT = 1
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.

Returns:

  • (::String) —

    Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1307

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

  # Results from a metadata import job.
  # @!attribute [r] deleted_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were deleted.
  # @!attribute [r] updated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were updated.
  # @!attribute [r] created_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were created.
  # @!attribute [r] unchanged_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were unchanged.
  # @!attribute [r] recreated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were recreated.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job
  # @!attribute [rw] source_storage_uri
  #   @return [::String]
  #     Optional. The URI of a Cloud Storage bucket or folder (beginning with
  #     `gs://` and ending with `/`) that contains the metadata import files for
  #     this job.
  #
  #     A metadata import file defines the values to set for each of the entries
  #     and aspects in a metadata job. For more information about how to create a
  #     metadata import file and the file requirements, see [Metadata import
  #     file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
  #
  #     You can provide multiple metadata import files in the same metadata job.
  #     The bucket or folder must contain at least one metadata import file, in
  #     JSON Lines format (either `.json` or `.jsonl` file extension).
  #
  #     In `FULL` entry sync mode, don't save the metadata import file in a
  #     folder named `SOURCE_STORAGE_URI/deletions/`.
  #
  #     **Caution**: If the metadata import file contains no data, all entries
  #     and aspects that belong to the job's scope are deleted.
  # @!attribute [rw] source_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the process that created the metadata import
  #     files began.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope]
  #     Required. A boundary on the scope of impact that the metadata import job
  #     can have.
  # @!attribute [rw] entry_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for entries.
  #     Only `FULL` mode is supported for entries. All entries in the job's scope
  #     are modified. If an entry exists in Dataplex but isn't included in the
  #     metadata import file, the entry is deleted when you run the metadata job.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  #     Only `INCREMENTAL` mode is supported for aspects. An aspect is modified
  #     only if the metadata import file includes a reference to the aspect in
  #     the `update_mask` field and the `aspect_keys` field.
  # @!attribute [rw] log_level
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel]
  #     Optional. The level of logs to write to Cloud Logging for this job.
  #
  #     Debug-level logs provide highly-detailed information for
  #     troubleshooting, but their increased verbosity could incur [additional
  #     costs](https://cloud.google.com/stackdriver/pricing) that might not be
  #     merited for all jobs.
  #
  #     If unspecified, defaults to `INFO`.
  class ImportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A boundary on the scope of impact that the metadata import job can have.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     Required. The entry group that is in scope for the import job,
    #     specified as a relative resource name in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries that belong to the specified entry group are affected by
    #     the job.
    #
    #     Must contain exactly one element. The entry group and the job
    #     must be in the same location.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     Required. The entry types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`.
    #     The job modifies only the entries that belong to these entry types.
    #
    #     If the metadata import file attempts to modify an entry whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an entry type must either match the location of the
    #     job, or the entry type must be global.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     Optional. The aspect types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
    #     The job modifies only the aspects that belong to these aspect types.
    #
    #     If the metadata import file attempts to modify an aspect whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an aspect type must either match the location of the
    #     job, or the aspect type must be global.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata job are updated.
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex but isn't included in the metadata import file, the resource
      # is deleted when you run the metadata job. Use this mode to perform a
      # full sync of the set of entries in the job scope.
      FULL = 1

      # Only the entries and aspects that are explicitly included in the
      # metadata import file are modified. Use this mode to modify a subset of
      # resources while leaving unreferenced resources unchanged.
      INCREMENTAL = 2
    end

    # The level of logs to write to Cloud Logging for this job.
    module LogLevel
      # Log level unspecified.
      LOG_LEVEL_UNSPECIFIED = 0

      # Debug-level logging. Captures detailed logs for each import item. Use
      # debug-level logging to troubleshoot issues with specific import items.
      # For example, use debug-level logging to identify resources that are
      # missing from the job scope, entries or aspects that don't conform to
      # the associated entry type or aspect type, or other misconfigurations
      # with the metadata import file.
      #
      # Depending on the size of your metadata job and the number of logs that
      # are generated, debug-level logging might incur
      # [additional costs](https://cloud.google.com/stackdriver/pricing).
      DEBUG = 1

      # Info-level logging. Captures logs at the overall job level. Includes
      # aggregate logs about import items, but doesn't specify which import
      # item has an error.
      INFO = 2
    end
  end

  # Metadata job status.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::Status::State]
  #     Output only. State of the metadata job.
  # @!attribute [r] message
  #   @return [::String]
  #     Output only. Message relating to the progression of a metadata job.
  # @!attribute [r] completion_percent
  #   @return [::Integer]
  #     Output only. Progress tracking.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class Status
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of a metadata job.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # The job is queued.
      QUEUED = 1

      # The job is running.
      RUNNING = 2

      # The job is being canceled.
      CANCELING = 3

      # The job is canceled.
      CANCELED = 4

      # The job succeeded.
      SUCCEEDED = 5

      # The job failed.
      FAILED = 6

      # The job completed with some errors.
      SUCCEEDED_WITH_ERRORS = 7
    end
  end

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

  # Metadata job type.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Import job.
    IMPORT = 1
  end
end

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

Returns Output only. The time when the metadata job was updated.

Returns:



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1307

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

  # Results from a metadata import job.
  # @!attribute [r] deleted_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were deleted.
  # @!attribute [r] updated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were updated.
  # @!attribute [r] created_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were created.
  # @!attribute [r] unchanged_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were unchanged.
  # @!attribute [r] recreated_entries
  #   @return [::Integer]
  #     Output only. The total number of entries that were recreated.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job
  # @!attribute [rw] source_storage_uri
  #   @return [::String]
  #     Optional. The URI of a Cloud Storage bucket or folder (beginning with
  #     `gs://` and ending with `/`) that contains the metadata import files for
  #     this job.
  #
  #     A metadata import file defines the values to set for each of the entries
  #     and aspects in a metadata job. For more information about how to create a
  #     metadata import file and the file requirements, see [Metadata import
  #     file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
  #
  #     You can provide multiple metadata import files in the same metadata job.
  #     The bucket or folder must contain at least one metadata import file, in
  #     JSON Lines format (either `.json` or `.jsonl` file extension).
  #
  #     In `FULL` entry sync mode, don't save the metadata import file in a
  #     folder named `SOURCE_STORAGE_URI/deletions/`.
  #
  #     **Caution**: If the metadata import file contains no data, all entries
  #     and aspects that belong to the job's scope are deleted.
  # @!attribute [rw] source_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the process that created the metadata import
  #     files began.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope]
  #     Required. A boundary on the scope of impact that the metadata import job
  #     can have.
  # @!attribute [rw] entry_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for entries.
  #     Only `FULL` mode is supported for entries. All entries in the job's scope
  #     are modified. If an entry exists in Dataplex but isn't included in the
  #     metadata import file, the entry is deleted when you run the metadata job.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  #     Only `INCREMENTAL` mode is supported for aspects. An aspect is modified
  #     only if the metadata import file includes a reference to the aspect in
  #     the `update_mask` field and the `aspect_keys` field.
  # @!attribute [rw] log_level
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel]
  #     Optional. The level of logs to write to Cloud Logging for this job.
  #
  #     Debug-level logs provide highly-detailed information for
  #     troubleshooting, but their increased verbosity could incur [additional
  #     costs](https://cloud.google.com/stackdriver/pricing) that might not be
  #     merited for all jobs.
  #
  #     If unspecified, defaults to `INFO`.
  class ImportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A boundary on the scope of impact that the metadata import job can have.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     Required. The entry group that is in scope for the import job,
    #     specified as a relative resource name in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries that belong to the specified entry group are affected by
    #     the job.
    #
    #     Must contain exactly one element. The entry group and the job
    #     must be in the same location.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     Required. The entry types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`.
    #     The job modifies only the entries that belong to these entry types.
    #
    #     If the metadata import file attempts to modify an entry whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an entry type must either match the location of the
    #     job, or the entry type must be global.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     Optional. The aspect types that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
    #     The job modifies only the aspects that belong to these aspect types.
    #
    #     If the metadata import file attempts to modify an aspect whose type
    #     isn't included in this list, the import job is halted before modifying
    #     any entries or aspects.
    #
    #     The location of an aspect type must either match the location of the
    #     job, or the aspect type must be global.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata job are updated.
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex but isn't included in the metadata import file, the resource
      # is deleted when you run the metadata job. Use this mode to perform a
      # full sync of the set of entries in the job scope.
      FULL = 1

      # Only the entries and aspects that are explicitly included in the
      # metadata import file are modified. Use this mode to modify a subset of
      # resources while leaving unreferenced resources unchanged.
      INCREMENTAL = 2
    end

    # The level of logs to write to Cloud Logging for this job.
    module LogLevel
      # Log level unspecified.
      LOG_LEVEL_UNSPECIFIED = 0

      # Debug-level logging. Captures detailed logs for each import item. Use
      # debug-level logging to troubleshoot issues with specific import items.
      # For example, use debug-level logging to identify resources that are
      # missing from the job scope, entries or aspects that don't conform to
      # the associated entry type or aspect type, or other misconfigurations
      # with the metadata import file.
      #
      # Depending on the size of your metadata job and the number of logs that
      # are generated, debug-level logging might incur
      # [additional costs](https://cloud.google.com/stackdriver/pricing).
      DEBUG = 1

      # Info-level logging. Captures logs at the overall job level. Includes
      # aggregate logs about import items, but doesn't specify which import
      # item has an error.
      INFO = 2
    end
  end

  # Metadata job status.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::Status::State]
  #     Output only. State of the metadata job.
  # @!attribute [r] message
  #   @return [::String]
  #     Output only. Message relating to the progression of a metadata job.
  # @!attribute [r] completion_percent
  #   @return [::Integer]
  #     Output only. Progress tracking.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the status was updated.
  class Status
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of a metadata job.
    module State
      # State unspecified.
      STATE_UNSPECIFIED = 0

      # The job is queued.
      QUEUED = 1

      # The job is running.
      RUNNING = 2

      # The job is being canceled.
      CANCELING = 3

      # The job is canceled.
      CANCELED = 4

      # The job succeeded.
      SUCCEEDED = 5

      # The job failed.
      FAILED = 6

      # The job completed with some errors.
      SUCCEEDED_WITH_ERRORS = 7
    end
  end

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

  # Metadata job type.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Import job.
    IMPORT = 1
  end
end