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: ExportJobResult, ExportJobSpec, 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:



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1461

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.
  # @!attribute [r] deleted_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     deleted.
  # @!attribute [r] created_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     created.
  # @!attribute [r] unchanged_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were left unchanged.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Summary results from a metadata export job. The results are a snapshot of
  # the metadata at the time when the job was created. The exported entries are
  # saved to a Cloud Storage bucket.
  # @!attribute [r] exported_entries
  #   @return [::Integer]
  #     Output only. The number of entries that were exported.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message if the metadata export job failed.
  class ExportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job.
  #
  # You can run the following kinds of metadata import jobs:
  #
  # * Full sync of entries with incremental import of their aspects.
  # Supported for custom entries.
  # * Incremental import of aspects only. Supported for aspects that belong
  # to custom entries and system entries. For custom entries, you can modify
  # both optional aspects and required aspects. For system entries, you can
  # modify optional aspects.
  # @!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 import 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.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  # @!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 groups that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries and aspects that belong to the specified entry groups are
    #     affected by the job.
    #
    #     The entry groups 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 and aspects 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.
    #
    #     This field is required when creating an aspect-only import job.
    #
    #     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.
    # @!attribute [rw] glossaries
    #   @return [::Array<::String>]
    #     Optional. The glossaries that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}`.
    #
    #     While importing Business Glossary entries, the user must
    #     provide glossaries. While importing entries, the user does not have to
    #     provide glossaries. If the metadata import file attempts to modify
    #     Business Glossary entries whose glossary isn't included in this list,
    #     the import job will skip those entries.
    #
    #     The location of a glossary must either match the location of the
    #     job, or the glossary must be global.
    # @!attribute [rw] entry_link_types
    #   @return [::Array<::String>]
    #     Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}`.
    #     The job modifies only the entryLinks that belong to these entry link
    #     types.
    #
    #     If the metadata import file attempts to create or delete an entry link
    #     whose entry link type isn't included in this list, the import job will
    #     skip those entry links.
    # @!attribute [rw] referenced_entry_scopes
    #   @return [::Array<::String>]
    #     Optional. Defines the scope of entries that can be referenced in the
    #     entry links.
    #
    #     Currently, projects are supported as valid scopes.
    #     Format: `projects/{project_number_or_id}`
    #
    #     If the metadata import file attempts to create an entry link
    #     which references an entry that is not in the scope, the import job will
    #     skip that entry link.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata import job are
    # updated. For more information, see [Sync
    # mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex Universal Catalog 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.
      #
      # This sync mode is supported for entries.
      FULL = 1

      # Only the resources 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.
      #
      # This sync mode is supported for aspects.
      INCREMENTAL = 2

      # If entry sync mode is `NONE`, then aspects are modified according
      # to the aspect sync mode. Other metadata that belongs to entries in the
      # job's scope isn't modified.
      #
      # This sync mode is supported for entries.
      NONE = 3
    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

  # Job specification for a metadata export job.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope]
  #     Required. The scope of the export job.
  # @!attribute [rw] output_path
  #   @return [::String]
  #     Required. The root path of the Cloud Storage bucket to export the
  #     metadata to, in the format `gs://{bucket}/`. You can optionally specify a
  #     custom prefix after the bucket name, in the format
  #     `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
  #     characters. Dataplex Universal Catalog constructs the object path for the
  #     exported files by using the bucket name and prefix that you provide,
  #     followed by a system-generated path.
  #
  #     The bucket must be in the same VPC Service Controls perimeter as the job.
  class ExportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The scope of the export job.
    # @!attribute [rw] organization_level
    #   @return [::Boolean]
    #     Whether the metadata export job is an organization-level export job.
    #
    #     - If `true`, the job exports the entries from the same organization and
    #     VPC Service Controls perimeter as the job. The project that the job
    #     belongs to determines the VPC Service Controls perimeter. If you set
    #     the job scope to be at the organization level, then don't provide a
    #     list of projects or entry groups.
    #     - If `false`, you must specify a list of projects or a list of entry
    #     groups whose entries you want to export.
    #
    #     The default is `false`.
    # @!attribute [rw] projects
    #   @return [::Array<::String>]
    #     The projects whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}`. Only the entries from
    #     the specified projects are exported.
    #
    #     The projects must be in the same organization and VPC Service Controls
    #     perimeter as the job.
    #
    #     If you set the job scope to be a list of projects, then set the
    #     organization-level export flag to false and don't provide a list of
    #     entry groups.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     The entry groups whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only the entries in the specified entry groups are exported.
    #
    #     The entry groups must be in the same location and the same VPC Service
    #     Controls perimeter as the job.
    #
    #     If you set the job scope to be a list of entry groups, then set the
    #     organization-level export flag to false and don't provide a list of
    #     projects.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     The entry types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
    #     Only entries that belong to the specified entry types are affected by
    #     the job.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     The aspect types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
    #     Only aspects that belong to the specified aspect types are affected by
    #     the job.
    class ExportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    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

    # Export job.
    EXPORT = 2
  end
end

#export_result ⇒ ::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobResult (readonly)

Returns Output only. Export job result.

Note: The following fields are mutually exclusive: export_result, import_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1461

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.
  # @!attribute [r] deleted_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     deleted.
  # @!attribute [r] created_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     created.
  # @!attribute [r] unchanged_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were left unchanged.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Summary results from a metadata export job. The results are a snapshot of
  # the metadata at the time when the job was created. The exported entries are
  # saved to a Cloud Storage bucket.
  # @!attribute [r] exported_entries
  #   @return [::Integer]
  #     Output only. The number of entries that were exported.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message if the metadata export job failed.
  class ExportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job.
  #
  # You can run the following kinds of metadata import jobs:
  #
  # * Full sync of entries with incremental import of their aspects.
  # Supported for custom entries.
  # * Incremental import of aspects only. Supported for aspects that belong
  # to custom entries and system entries. For custom entries, you can modify
  # both optional aspects and required aspects. For system entries, you can
  # modify optional aspects.
  # @!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 import 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.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  # @!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 groups that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries and aspects that belong to the specified entry groups are
    #     affected by the job.
    #
    #     The entry groups 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 and aspects 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.
    #
    #     This field is required when creating an aspect-only import job.
    #
    #     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.
    # @!attribute [rw] glossaries
    #   @return [::Array<::String>]
    #     Optional. The glossaries that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}`.
    #
    #     While importing Business Glossary entries, the user must
    #     provide glossaries. While importing entries, the user does not have to
    #     provide glossaries. If the metadata import file attempts to modify
    #     Business Glossary entries whose glossary isn't included in this list,
    #     the import job will skip those entries.
    #
    #     The location of a glossary must either match the location of the
    #     job, or the glossary must be global.
    # @!attribute [rw] entry_link_types
    #   @return [::Array<::String>]
    #     Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}`.
    #     The job modifies only the entryLinks that belong to these entry link
    #     types.
    #
    #     If the metadata import file attempts to create or delete an entry link
    #     whose entry link type isn't included in this list, the import job will
    #     skip those entry links.
    # @!attribute [rw] referenced_entry_scopes
    #   @return [::Array<::String>]
    #     Optional. Defines the scope of entries that can be referenced in the
    #     entry links.
    #
    #     Currently, projects are supported as valid scopes.
    #     Format: `projects/{project_number_or_id}`
    #
    #     If the metadata import file attempts to create an entry link
    #     which references an entry that is not in the scope, the import job will
    #     skip that entry link.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata import job are
    # updated. For more information, see [Sync
    # mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex Universal Catalog 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.
      #
      # This sync mode is supported for entries.
      FULL = 1

      # Only the resources 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.
      #
      # This sync mode is supported for aspects.
      INCREMENTAL = 2

      # If entry sync mode is `NONE`, then aspects are modified according
      # to the aspect sync mode. Other metadata that belongs to entries in the
      # job's scope isn't modified.
      #
      # This sync mode is supported for entries.
      NONE = 3
    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

  # Job specification for a metadata export job.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope]
  #     Required. The scope of the export job.
  # @!attribute [rw] output_path
  #   @return [::String]
  #     Required. The root path of the Cloud Storage bucket to export the
  #     metadata to, in the format `gs://{bucket}/`. You can optionally specify a
  #     custom prefix after the bucket name, in the format
  #     `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
  #     characters. Dataplex Universal Catalog constructs the object path for the
  #     exported files by using the bucket name and prefix that you provide,
  #     followed by a system-generated path.
  #
  #     The bucket must be in the same VPC Service Controls perimeter as the job.
  class ExportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The scope of the export job.
    # @!attribute [rw] organization_level
    #   @return [::Boolean]
    #     Whether the metadata export job is an organization-level export job.
    #
    #     - If `true`, the job exports the entries from the same organization and
    #     VPC Service Controls perimeter as the job. The project that the job
    #     belongs to determines the VPC Service Controls perimeter. If you set
    #     the job scope to be at the organization level, then don't provide a
    #     list of projects or entry groups.
    #     - If `false`, you must specify a list of projects or a list of entry
    #     groups whose entries you want to export.
    #
    #     The default is `false`.
    # @!attribute [rw] projects
    #   @return [::Array<::String>]
    #     The projects whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}`. Only the entries from
    #     the specified projects are exported.
    #
    #     The projects must be in the same organization and VPC Service Controls
    #     perimeter as the job.
    #
    #     If you set the job scope to be a list of projects, then set the
    #     organization-level export flag to false and don't provide a list of
    #     entry groups.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     The entry groups whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only the entries in the specified entry groups are exported.
    #
    #     The entry groups must be in the same location and the same VPC Service
    #     Controls perimeter as the job.
    #
    #     If you set the job scope to be a list of entry groups, then set the
    #     organization-level export flag to false and don't provide a list of
    #     projects.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     The entry types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
    #     Only entries that belong to the specified entry types are affected by
    #     the job.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     The aspect types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
    #     Only aspects that belong to the specified aspect types are affected by
    #     the job.
    class ExportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    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

    # Export job.
    EXPORT = 2
  end
end

#export_spec ⇒ ::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec

Returns Export job specification.

Note: The following fields are mutually exclusive: export_spec, import_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1461

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.
  # @!attribute [r] deleted_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     deleted.
  # @!attribute [r] created_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     created.
  # @!attribute [r] unchanged_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were left unchanged.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Summary results from a metadata export job. The results are a snapshot of
  # the metadata at the time when the job was created. The exported entries are
  # saved to a Cloud Storage bucket.
  # @!attribute [r] exported_entries
  #   @return [::Integer]
  #     Output only. The number of entries that were exported.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message if the metadata export job failed.
  class ExportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job.
  #
  # You can run the following kinds of metadata import jobs:
  #
  # * Full sync of entries with incremental import of their aspects.
  # Supported for custom entries.
  # * Incremental import of aspects only. Supported for aspects that belong
  # to custom entries and system entries. For custom entries, you can modify
  # both optional aspects and required aspects. For system entries, you can
  # modify optional aspects.
  # @!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 import 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.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  # @!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 groups that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries and aspects that belong to the specified entry groups are
    #     affected by the job.
    #
    #     The entry groups 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 and aspects 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.
    #
    #     This field is required when creating an aspect-only import job.
    #
    #     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.
    # @!attribute [rw] glossaries
    #   @return [::Array<::String>]
    #     Optional. The glossaries that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}`.
    #
    #     While importing Business Glossary entries, the user must
    #     provide glossaries. While importing entries, the user does not have to
    #     provide glossaries. If the metadata import file attempts to modify
    #     Business Glossary entries whose glossary isn't included in this list,
    #     the import job will skip those entries.
    #
    #     The location of a glossary must either match the location of the
    #     job, or the glossary must be global.
    # @!attribute [rw] entry_link_types
    #   @return [::Array<::String>]
    #     Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}`.
    #     The job modifies only the entryLinks that belong to these entry link
    #     types.
    #
    #     If the metadata import file attempts to create or delete an entry link
    #     whose entry link type isn't included in this list, the import job will
    #     skip those entry links.
    # @!attribute [rw] referenced_entry_scopes
    #   @return [::Array<::String>]
    #     Optional. Defines the scope of entries that can be referenced in the
    #     entry links.
    #
    #     Currently, projects are supported as valid scopes.
    #     Format: `projects/{project_number_or_id}`
    #
    #     If the metadata import file attempts to create an entry link
    #     which references an entry that is not in the scope, the import job will
    #     skip that entry link.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata import job are
    # updated. For more information, see [Sync
    # mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex Universal Catalog 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.
      #
      # This sync mode is supported for entries.
      FULL = 1

      # Only the resources 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.
      #
      # This sync mode is supported for aspects.
      INCREMENTAL = 2

      # If entry sync mode is `NONE`, then aspects are modified according
      # to the aspect sync mode. Other metadata that belongs to entries in the
      # job's scope isn't modified.
      #
      # This sync mode is supported for entries.
      NONE = 3
    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

  # Job specification for a metadata export job.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope]
  #     Required. The scope of the export job.
  # @!attribute [rw] output_path
  #   @return [::String]
  #     Required. The root path of the Cloud Storage bucket to export the
  #     metadata to, in the format `gs://{bucket}/`. You can optionally specify a
  #     custom prefix after the bucket name, in the format
  #     `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
  #     characters. Dataplex Universal Catalog constructs the object path for the
  #     exported files by using the bucket name and prefix that you provide,
  #     followed by a system-generated path.
  #
  #     The bucket must be in the same VPC Service Controls perimeter as the job.
  class ExportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The scope of the export job.
    # @!attribute [rw] organization_level
    #   @return [::Boolean]
    #     Whether the metadata export job is an organization-level export job.
    #
    #     - If `true`, the job exports the entries from the same organization and
    #     VPC Service Controls perimeter as the job. The project that the job
    #     belongs to determines the VPC Service Controls perimeter. If you set
    #     the job scope to be at the organization level, then don't provide a
    #     list of projects or entry groups.
    #     - If `false`, you must specify a list of projects or a list of entry
    #     groups whose entries you want to export.
    #
    #     The default is `false`.
    # @!attribute [rw] projects
    #   @return [::Array<::String>]
    #     The projects whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}`. Only the entries from
    #     the specified projects are exported.
    #
    #     The projects must be in the same organization and VPC Service Controls
    #     perimeter as the job.
    #
    #     If you set the job scope to be a list of projects, then set the
    #     organization-level export flag to false and don't provide a list of
    #     entry groups.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     The entry groups whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only the entries in the specified entry groups are exported.
    #
    #     The entry groups must be in the same location and the same VPC Service
    #     Controls perimeter as the job.
    #
    #     If you set the job scope to be a list of entry groups, then set the
    #     organization-level export flag to false and don't provide a list of
    #     projects.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     The entry types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
    #     Only entries that belong to the specified entry types are affected by
    #     the job.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     The aspect types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
    #     Only aspects that belong to the specified aspect types are affected by
    #     the job.
    class ExportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    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

    # Export job.
    EXPORT = 2
  end
end

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

Returns Output only. Import job result.

Note: The following fields are mutually exclusive: import_result, export_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1461

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.
  # @!attribute [r] deleted_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     deleted.
  # @!attribute [r] created_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     created.
  # @!attribute [r] unchanged_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were left unchanged.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Summary results from a metadata export job. The results are a snapshot of
  # the metadata at the time when the job was created. The exported entries are
  # saved to a Cloud Storage bucket.
  # @!attribute [r] exported_entries
  #   @return [::Integer]
  #     Output only. The number of entries that were exported.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message if the metadata export job failed.
  class ExportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job.
  #
  # You can run the following kinds of metadata import jobs:
  #
  # * Full sync of entries with incremental import of their aspects.
  # Supported for custom entries.
  # * Incremental import of aspects only. Supported for aspects that belong
  # to custom entries and system entries. For custom entries, you can modify
  # both optional aspects and required aspects. For system entries, you can
  # modify optional aspects.
  # @!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 import 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.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  # @!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 groups that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries and aspects that belong to the specified entry groups are
    #     affected by the job.
    #
    #     The entry groups 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 and aspects 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.
    #
    #     This field is required when creating an aspect-only import job.
    #
    #     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.
    # @!attribute [rw] glossaries
    #   @return [::Array<::String>]
    #     Optional. The glossaries that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}`.
    #
    #     While importing Business Glossary entries, the user must
    #     provide glossaries. While importing entries, the user does not have to
    #     provide glossaries. If the metadata import file attempts to modify
    #     Business Glossary entries whose glossary isn't included in this list,
    #     the import job will skip those entries.
    #
    #     The location of a glossary must either match the location of the
    #     job, or the glossary must be global.
    # @!attribute [rw] entry_link_types
    #   @return [::Array<::String>]
    #     Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}`.
    #     The job modifies only the entryLinks that belong to these entry link
    #     types.
    #
    #     If the metadata import file attempts to create or delete an entry link
    #     whose entry link type isn't included in this list, the import job will
    #     skip those entry links.
    # @!attribute [rw] referenced_entry_scopes
    #   @return [::Array<::String>]
    #     Optional. Defines the scope of entries that can be referenced in the
    #     entry links.
    #
    #     Currently, projects are supported as valid scopes.
    #     Format: `projects/{project_number_or_id}`
    #
    #     If the metadata import file attempts to create an entry link
    #     which references an entry that is not in the scope, the import job will
    #     skip that entry link.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata import job are
    # updated. For more information, see [Sync
    # mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex Universal Catalog 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.
      #
      # This sync mode is supported for entries.
      FULL = 1

      # Only the resources 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.
      #
      # This sync mode is supported for aspects.
      INCREMENTAL = 2

      # If entry sync mode is `NONE`, then aspects are modified according
      # to the aspect sync mode. Other metadata that belongs to entries in the
      # job's scope isn't modified.
      #
      # This sync mode is supported for entries.
      NONE = 3
    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

  # Job specification for a metadata export job.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope]
  #     Required. The scope of the export job.
  # @!attribute [rw] output_path
  #   @return [::String]
  #     Required. The root path of the Cloud Storage bucket to export the
  #     metadata to, in the format `gs://{bucket}/`. You can optionally specify a
  #     custom prefix after the bucket name, in the format
  #     `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
  #     characters. Dataplex Universal Catalog constructs the object path for the
  #     exported files by using the bucket name and prefix that you provide,
  #     followed by a system-generated path.
  #
  #     The bucket must be in the same VPC Service Controls perimeter as the job.
  class ExportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The scope of the export job.
    # @!attribute [rw] organization_level
    #   @return [::Boolean]
    #     Whether the metadata export job is an organization-level export job.
    #
    #     - If `true`, the job exports the entries from the same organization and
    #     VPC Service Controls perimeter as the job. The project that the job
    #     belongs to determines the VPC Service Controls perimeter. If you set
    #     the job scope to be at the organization level, then don't provide a
    #     list of projects or entry groups.
    #     - If `false`, you must specify a list of projects or a list of entry
    #     groups whose entries you want to export.
    #
    #     The default is `false`.
    # @!attribute [rw] projects
    #   @return [::Array<::String>]
    #     The projects whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}`. Only the entries from
    #     the specified projects are exported.
    #
    #     The projects must be in the same organization and VPC Service Controls
    #     perimeter as the job.
    #
    #     If you set the job scope to be a list of projects, then set the
    #     organization-level export flag to false and don't provide a list of
    #     entry groups.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     The entry groups whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only the entries in the specified entry groups are exported.
    #
    #     The entry groups must be in the same location and the same VPC Service
    #     Controls perimeter as the job.
    #
    #     If you set the job scope to be a list of entry groups, then set the
    #     organization-level export flag to false and don't provide a list of
    #     projects.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     The entry types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
    #     Only entries that belong to the specified entry types are affected by
    #     the job.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     The aspect types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
    #     Only aspects that belong to the specified aspect types are affected by
    #     the job.
    class ExportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    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

    # Export job.
    EXPORT = 2
  end
end

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

Returns Import job specification.

Note: The following fields are mutually exclusive: import_spec, export_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1461

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.
  # @!attribute [r] deleted_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     deleted.
  # @!attribute [r] created_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     created.
  # @!attribute [r] unchanged_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were left unchanged.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Summary results from a metadata export job. The results are a snapshot of
  # the metadata at the time when the job was created. The exported entries are
  # saved to a Cloud Storage bucket.
  # @!attribute [r] exported_entries
  #   @return [::Integer]
  #     Output only. The number of entries that were exported.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message if the metadata export job failed.
  class ExportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job.
  #
  # You can run the following kinds of metadata import jobs:
  #
  # * Full sync of entries with incremental import of their aspects.
  # Supported for custom entries.
  # * Incremental import of aspects only. Supported for aspects that belong
  # to custom entries and system entries. For custom entries, you can modify
  # both optional aspects and required aspects. For system entries, you can
  # modify optional aspects.
  # @!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 import 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.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  # @!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 groups that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries and aspects that belong to the specified entry groups are
    #     affected by the job.
    #
    #     The entry groups 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 and aspects 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.
    #
    #     This field is required when creating an aspect-only import job.
    #
    #     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.
    # @!attribute [rw] glossaries
    #   @return [::Array<::String>]
    #     Optional. The glossaries that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}`.
    #
    #     While importing Business Glossary entries, the user must
    #     provide glossaries. While importing entries, the user does not have to
    #     provide glossaries. If the metadata import file attempts to modify
    #     Business Glossary entries whose glossary isn't included in this list,
    #     the import job will skip those entries.
    #
    #     The location of a glossary must either match the location of the
    #     job, or the glossary must be global.
    # @!attribute [rw] entry_link_types
    #   @return [::Array<::String>]
    #     Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}`.
    #     The job modifies only the entryLinks that belong to these entry link
    #     types.
    #
    #     If the metadata import file attempts to create or delete an entry link
    #     whose entry link type isn't included in this list, the import job will
    #     skip those entry links.
    # @!attribute [rw] referenced_entry_scopes
    #   @return [::Array<::String>]
    #     Optional. Defines the scope of entries that can be referenced in the
    #     entry links.
    #
    #     Currently, projects are supported as valid scopes.
    #     Format: `projects/{project_number_or_id}`
    #
    #     If the metadata import file attempts to create an entry link
    #     which references an entry that is not in the scope, the import job will
    #     skip that entry link.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata import job are
    # updated. For more information, see [Sync
    # mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex Universal Catalog 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.
      #
      # This sync mode is supported for entries.
      FULL = 1

      # Only the resources 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.
      #
      # This sync mode is supported for aspects.
      INCREMENTAL = 2

      # If entry sync mode is `NONE`, then aspects are modified according
      # to the aspect sync mode. Other metadata that belongs to entries in the
      # job's scope isn't modified.
      #
      # This sync mode is supported for entries.
      NONE = 3
    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

  # Job specification for a metadata export job.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope]
  #     Required. The scope of the export job.
  # @!attribute [rw] output_path
  #   @return [::String]
  #     Required. The root path of the Cloud Storage bucket to export the
  #     metadata to, in the format `gs://{bucket}/`. You can optionally specify a
  #     custom prefix after the bucket name, in the format
  #     `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
  #     characters. Dataplex Universal Catalog constructs the object path for the
  #     exported files by using the bucket name and prefix that you provide,
  #     followed by a system-generated path.
  #
  #     The bucket must be in the same VPC Service Controls perimeter as the job.
  class ExportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The scope of the export job.
    # @!attribute [rw] organization_level
    #   @return [::Boolean]
    #     Whether the metadata export job is an organization-level export job.
    #
    #     - If `true`, the job exports the entries from the same organization and
    #     VPC Service Controls perimeter as the job. The project that the job
    #     belongs to determines the VPC Service Controls perimeter. If you set
    #     the job scope to be at the organization level, then don't provide a
    #     list of projects or entry groups.
    #     - If `false`, you must specify a list of projects or a list of entry
    #     groups whose entries you want to export.
    #
    #     The default is `false`.
    # @!attribute [rw] projects
    #   @return [::Array<::String>]
    #     The projects whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}`. Only the entries from
    #     the specified projects are exported.
    #
    #     The projects must be in the same organization and VPC Service Controls
    #     perimeter as the job.
    #
    #     If you set the job scope to be a list of projects, then set the
    #     organization-level export flag to false and don't provide a list of
    #     entry groups.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     The entry groups whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only the entries in the specified entry groups are exported.
    #
    #     The entry groups must be in the same location and the same VPC Service
    #     Controls perimeter as the job.
    #
    #     If you set the job scope to be a list of entry groups, then set the
    #     organization-level export flag to false and don't provide a list of
    #     projects.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     The entry types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
    #     Only entries that belong to the specified entry types are affected by
    #     the job.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     The aspect types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
    #     Only aspects that belong to the specified aspect types are affected by
    #     the job.
    class ExportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    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

    # Export job.
    EXPORT = 2
  end
end

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

Returns Optional. User-defined labels.

Returns:

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

    Optional. User-defined labels.



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1461

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.
  # @!attribute [r] deleted_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     deleted.
  # @!attribute [r] created_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     created.
  # @!attribute [r] unchanged_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were left unchanged.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Summary results from a metadata export job. The results are a snapshot of
  # the metadata at the time when the job was created. The exported entries are
  # saved to a Cloud Storage bucket.
  # @!attribute [r] exported_entries
  #   @return [::Integer]
  #     Output only. The number of entries that were exported.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message if the metadata export job failed.
  class ExportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job.
  #
  # You can run the following kinds of metadata import jobs:
  #
  # * Full sync of entries with incremental import of their aspects.
  # Supported for custom entries.
  # * Incremental import of aspects only. Supported for aspects that belong
  # to custom entries and system entries. For custom entries, you can modify
  # both optional aspects and required aspects. For system entries, you can
  # modify optional aspects.
  # @!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 import 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.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  # @!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 groups that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries and aspects that belong to the specified entry groups are
    #     affected by the job.
    #
    #     The entry groups 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 and aspects 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.
    #
    #     This field is required when creating an aspect-only import job.
    #
    #     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.
    # @!attribute [rw] glossaries
    #   @return [::Array<::String>]
    #     Optional. The glossaries that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}`.
    #
    #     While importing Business Glossary entries, the user must
    #     provide glossaries. While importing entries, the user does not have to
    #     provide glossaries. If the metadata import file attempts to modify
    #     Business Glossary entries whose glossary isn't included in this list,
    #     the import job will skip those entries.
    #
    #     The location of a glossary must either match the location of the
    #     job, or the glossary must be global.
    # @!attribute [rw] entry_link_types
    #   @return [::Array<::String>]
    #     Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}`.
    #     The job modifies only the entryLinks that belong to these entry link
    #     types.
    #
    #     If the metadata import file attempts to create or delete an entry link
    #     whose entry link type isn't included in this list, the import job will
    #     skip those entry links.
    # @!attribute [rw] referenced_entry_scopes
    #   @return [::Array<::String>]
    #     Optional. Defines the scope of entries that can be referenced in the
    #     entry links.
    #
    #     Currently, projects are supported as valid scopes.
    #     Format: `projects/{project_number_or_id}`
    #
    #     If the metadata import file attempts to create an entry link
    #     which references an entry that is not in the scope, the import job will
    #     skip that entry link.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata import job are
    # updated. For more information, see [Sync
    # mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex Universal Catalog 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.
      #
      # This sync mode is supported for entries.
      FULL = 1

      # Only the resources 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.
      #
      # This sync mode is supported for aspects.
      INCREMENTAL = 2

      # If entry sync mode is `NONE`, then aspects are modified according
      # to the aspect sync mode. Other metadata that belongs to entries in the
      # job's scope isn't modified.
      #
      # This sync mode is supported for entries.
      NONE = 3
    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

  # Job specification for a metadata export job.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope]
  #     Required. The scope of the export job.
  # @!attribute [rw] output_path
  #   @return [::String]
  #     Required. The root path of the Cloud Storage bucket to export the
  #     metadata to, in the format `gs://{bucket}/`. You can optionally specify a
  #     custom prefix after the bucket name, in the format
  #     `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
  #     characters. Dataplex Universal Catalog constructs the object path for the
  #     exported files by using the bucket name and prefix that you provide,
  #     followed by a system-generated path.
  #
  #     The bucket must be in the same VPC Service Controls perimeter as the job.
  class ExportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The scope of the export job.
    # @!attribute [rw] organization_level
    #   @return [::Boolean]
    #     Whether the metadata export job is an organization-level export job.
    #
    #     - If `true`, the job exports the entries from the same organization and
    #     VPC Service Controls perimeter as the job. The project that the job
    #     belongs to determines the VPC Service Controls perimeter. If you set
    #     the job scope to be at the organization level, then don't provide a
    #     list of projects or entry groups.
    #     - If `false`, you must specify a list of projects or a list of entry
    #     groups whose entries you want to export.
    #
    #     The default is `false`.
    # @!attribute [rw] projects
    #   @return [::Array<::String>]
    #     The projects whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}`. Only the entries from
    #     the specified projects are exported.
    #
    #     The projects must be in the same organization and VPC Service Controls
    #     perimeter as the job.
    #
    #     If you set the job scope to be a list of projects, then set the
    #     organization-level export flag to false and don't provide a list of
    #     entry groups.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     The entry groups whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only the entries in the specified entry groups are exported.
    #
    #     The entry groups must be in the same location and the same VPC Service
    #     Controls perimeter as the job.
    #
    #     If you set the job scope to be a list of entry groups, then set the
    #     organization-level export flag to false and don't provide a list of
    #     projects.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     The entry types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
    #     Only entries that belong to the specified entry types are affected by
    #     the job.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     The aspect types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
    #     Only aspects that belong to the specified aspect types are affected by
    #     the job.
    class ExportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    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

    # Export job.
    EXPORT = 2
  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}.



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1461

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.
  # @!attribute [r] deleted_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     deleted.
  # @!attribute [r] created_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     created.
  # @!attribute [r] unchanged_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were left unchanged.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Summary results from a metadata export job. The results are a snapshot of
  # the metadata at the time when the job was created. The exported entries are
  # saved to a Cloud Storage bucket.
  # @!attribute [r] exported_entries
  #   @return [::Integer]
  #     Output only. The number of entries that were exported.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message if the metadata export job failed.
  class ExportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job.
  #
  # You can run the following kinds of metadata import jobs:
  #
  # * Full sync of entries with incremental import of their aspects.
  # Supported for custom entries.
  # * Incremental import of aspects only. Supported for aspects that belong
  # to custom entries and system entries. For custom entries, you can modify
  # both optional aspects and required aspects. For system entries, you can
  # modify optional aspects.
  # @!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 import 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.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  # @!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 groups that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries and aspects that belong to the specified entry groups are
    #     affected by the job.
    #
    #     The entry groups 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 and aspects 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.
    #
    #     This field is required when creating an aspect-only import job.
    #
    #     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.
    # @!attribute [rw] glossaries
    #   @return [::Array<::String>]
    #     Optional. The glossaries that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}`.
    #
    #     While importing Business Glossary entries, the user must
    #     provide glossaries. While importing entries, the user does not have to
    #     provide glossaries. If the metadata import file attempts to modify
    #     Business Glossary entries whose glossary isn't included in this list,
    #     the import job will skip those entries.
    #
    #     The location of a glossary must either match the location of the
    #     job, or the glossary must be global.
    # @!attribute [rw] entry_link_types
    #   @return [::Array<::String>]
    #     Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}`.
    #     The job modifies only the entryLinks that belong to these entry link
    #     types.
    #
    #     If the metadata import file attempts to create or delete an entry link
    #     whose entry link type isn't included in this list, the import job will
    #     skip those entry links.
    # @!attribute [rw] referenced_entry_scopes
    #   @return [::Array<::String>]
    #     Optional. Defines the scope of entries that can be referenced in the
    #     entry links.
    #
    #     Currently, projects are supported as valid scopes.
    #     Format: `projects/{project_number_or_id}`
    #
    #     If the metadata import file attempts to create an entry link
    #     which references an entry that is not in the scope, the import job will
    #     skip that entry link.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata import job are
    # updated. For more information, see [Sync
    # mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex Universal Catalog 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.
      #
      # This sync mode is supported for entries.
      FULL = 1

      # Only the resources 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.
      #
      # This sync mode is supported for aspects.
      INCREMENTAL = 2

      # If entry sync mode is `NONE`, then aspects are modified according
      # to the aspect sync mode. Other metadata that belongs to entries in the
      # job's scope isn't modified.
      #
      # This sync mode is supported for entries.
      NONE = 3
    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

  # Job specification for a metadata export job.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope]
  #     Required. The scope of the export job.
  # @!attribute [rw] output_path
  #   @return [::String]
  #     Required. The root path of the Cloud Storage bucket to export the
  #     metadata to, in the format `gs://{bucket}/`. You can optionally specify a
  #     custom prefix after the bucket name, in the format
  #     `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
  #     characters. Dataplex Universal Catalog constructs the object path for the
  #     exported files by using the bucket name and prefix that you provide,
  #     followed by a system-generated path.
  #
  #     The bucket must be in the same VPC Service Controls perimeter as the job.
  class ExportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The scope of the export job.
    # @!attribute [rw] organization_level
    #   @return [::Boolean]
    #     Whether the metadata export job is an organization-level export job.
    #
    #     - If `true`, the job exports the entries from the same organization and
    #     VPC Service Controls perimeter as the job. The project that the job
    #     belongs to determines the VPC Service Controls perimeter. If you set
    #     the job scope to be at the organization level, then don't provide a
    #     list of projects or entry groups.
    #     - If `false`, you must specify a list of projects or a list of entry
    #     groups whose entries you want to export.
    #
    #     The default is `false`.
    # @!attribute [rw] projects
    #   @return [::Array<::String>]
    #     The projects whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}`. Only the entries from
    #     the specified projects are exported.
    #
    #     The projects must be in the same organization and VPC Service Controls
    #     perimeter as the job.
    #
    #     If you set the job scope to be a list of projects, then set the
    #     organization-level export flag to false and don't provide a list of
    #     entry groups.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     The entry groups whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only the entries in the specified entry groups are exported.
    #
    #     The entry groups must be in the same location and the same VPC Service
    #     Controls perimeter as the job.
    #
    #     If you set the job scope to be a list of entry groups, then set the
    #     organization-level export flag to false and don't provide a list of
    #     projects.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     The entry types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
    #     Only entries that belong to the specified entry types are affected by
    #     the job.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     The aspect types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
    #     Only aspects that belong to the specified aspect types are affected by
    #     the job.
    class ExportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    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

    # Export job.
    EXPORT = 2
  end
end

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

Returns Output only. Metadata job status.

Returns:



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1461

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.
  # @!attribute [r] deleted_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     deleted.
  # @!attribute [r] created_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     created.
  # @!attribute [r] unchanged_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were left unchanged.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Summary results from a metadata export job. The results are a snapshot of
  # the metadata at the time when the job was created. The exported entries are
  # saved to a Cloud Storage bucket.
  # @!attribute [r] exported_entries
  #   @return [::Integer]
  #     Output only. The number of entries that were exported.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message if the metadata export job failed.
  class ExportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job.
  #
  # You can run the following kinds of metadata import jobs:
  #
  # * Full sync of entries with incremental import of their aspects.
  # Supported for custom entries.
  # * Incremental import of aspects only. Supported for aspects that belong
  # to custom entries and system entries. For custom entries, you can modify
  # both optional aspects and required aspects. For system entries, you can
  # modify optional aspects.
  # @!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 import 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.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  # @!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 groups that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries and aspects that belong to the specified entry groups are
    #     affected by the job.
    #
    #     The entry groups 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 and aspects 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.
    #
    #     This field is required when creating an aspect-only import job.
    #
    #     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.
    # @!attribute [rw] glossaries
    #   @return [::Array<::String>]
    #     Optional. The glossaries that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}`.
    #
    #     While importing Business Glossary entries, the user must
    #     provide glossaries. While importing entries, the user does not have to
    #     provide glossaries. If the metadata import file attempts to modify
    #     Business Glossary entries whose glossary isn't included in this list,
    #     the import job will skip those entries.
    #
    #     The location of a glossary must either match the location of the
    #     job, or the glossary must be global.
    # @!attribute [rw] entry_link_types
    #   @return [::Array<::String>]
    #     Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}`.
    #     The job modifies only the entryLinks that belong to these entry link
    #     types.
    #
    #     If the metadata import file attempts to create or delete an entry link
    #     whose entry link type isn't included in this list, the import job will
    #     skip those entry links.
    # @!attribute [rw] referenced_entry_scopes
    #   @return [::Array<::String>]
    #     Optional. Defines the scope of entries that can be referenced in the
    #     entry links.
    #
    #     Currently, projects are supported as valid scopes.
    #     Format: `projects/{project_number_or_id}`
    #
    #     If the metadata import file attempts to create an entry link
    #     which references an entry that is not in the scope, the import job will
    #     skip that entry link.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata import job are
    # updated. For more information, see [Sync
    # mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex Universal Catalog 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.
      #
      # This sync mode is supported for entries.
      FULL = 1

      # Only the resources 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.
      #
      # This sync mode is supported for aspects.
      INCREMENTAL = 2

      # If entry sync mode is `NONE`, then aspects are modified according
      # to the aspect sync mode. Other metadata that belongs to entries in the
      # job's scope isn't modified.
      #
      # This sync mode is supported for entries.
      NONE = 3
    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

  # Job specification for a metadata export job.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope]
  #     Required. The scope of the export job.
  # @!attribute [rw] output_path
  #   @return [::String]
  #     Required. The root path of the Cloud Storage bucket to export the
  #     metadata to, in the format `gs://{bucket}/`. You can optionally specify a
  #     custom prefix after the bucket name, in the format
  #     `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
  #     characters. Dataplex Universal Catalog constructs the object path for the
  #     exported files by using the bucket name and prefix that you provide,
  #     followed by a system-generated path.
  #
  #     The bucket must be in the same VPC Service Controls perimeter as the job.
  class ExportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The scope of the export job.
    # @!attribute [rw] organization_level
    #   @return [::Boolean]
    #     Whether the metadata export job is an organization-level export job.
    #
    #     - If `true`, the job exports the entries from the same organization and
    #     VPC Service Controls perimeter as the job. The project that the job
    #     belongs to determines the VPC Service Controls perimeter. If you set
    #     the job scope to be at the organization level, then don't provide a
    #     list of projects or entry groups.
    #     - If `false`, you must specify a list of projects or a list of entry
    #     groups whose entries you want to export.
    #
    #     The default is `false`.
    # @!attribute [rw] projects
    #   @return [::Array<::String>]
    #     The projects whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}`. Only the entries from
    #     the specified projects are exported.
    #
    #     The projects must be in the same organization and VPC Service Controls
    #     perimeter as the job.
    #
    #     If you set the job scope to be a list of projects, then set the
    #     organization-level export flag to false and don't provide a list of
    #     entry groups.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     The entry groups whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only the entries in the specified entry groups are exported.
    #
    #     The entry groups must be in the same location and the same VPC Service
    #     Controls perimeter as the job.
    #
    #     If you set the job scope to be a list of entry groups, then set the
    #     organization-level export flag to false and don't provide a list of
    #     projects.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     The entry types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
    #     Only entries that belong to the specified entry types are affected by
    #     the job.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     The aspect types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
    #     Only aspects that belong to the specified aspect types are affected by
    #     the job.
    class ExportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    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

    # Export job.
    EXPORT = 2
  end
end

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

Returns Required. Metadata job type.

Returns:



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1461

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.
  # @!attribute [r] deleted_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     deleted.
  # @!attribute [r] created_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     created.
  # @!attribute [r] unchanged_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were left unchanged.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Summary results from a metadata export job. The results are a snapshot of
  # the metadata at the time when the job was created. The exported entries are
  # saved to a Cloud Storage bucket.
  # @!attribute [r] exported_entries
  #   @return [::Integer]
  #     Output only. The number of entries that were exported.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message if the metadata export job failed.
  class ExportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job.
  #
  # You can run the following kinds of metadata import jobs:
  #
  # * Full sync of entries with incremental import of their aspects.
  # Supported for custom entries.
  # * Incremental import of aspects only. Supported for aspects that belong
  # to custom entries and system entries. For custom entries, you can modify
  # both optional aspects and required aspects. For system entries, you can
  # modify optional aspects.
  # @!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 import 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.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  # @!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 groups that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries and aspects that belong to the specified entry groups are
    #     affected by the job.
    #
    #     The entry groups 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 and aspects 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.
    #
    #     This field is required when creating an aspect-only import job.
    #
    #     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.
    # @!attribute [rw] glossaries
    #   @return [::Array<::String>]
    #     Optional. The glossaries that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}`.
    #
    #     While importing Business Glossary entries, the user must
    #     provide glossaries. While importing entries, the user does not have to
    #     provide glossaries. If the metadata import file attempts to modify
    #     Business Glossary entries whose glossary isn't included in this list,
    #     the import job will skip those entries.
    #
    #     The location of a glossary must either match the location of the
    #     job, or the glossary must be global.
    # @!attribute [rw] entry_link_types
    #   @return [::Array<::String>]
    #     Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}`.
    #     The job modifies only the entryLinks that belong to these entry link
    #     types.
    #
    #     If the metadata import file attempts to create or delete an entry link
    #     whose entry link type isn't included in this list, the import job will
    #     skip those entry links.
    # @!attribute [rw] referenced_entry_scopes
    #   @return [::Array<::String>]
    #     Optional. Defines the scope of entries that can be referenced in the
    #     entry links.
    #
    #     Currently, projects are supported as valid scopes.
    #     Format: `projects/{project_number_or_id}`
    #
    #     If the metadata import file attempts to create an entry link
    #     which references an entry that is not in the scope, the import job will
    #     skip that entry link.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata import job are
    # updated. For more information, see [Sync
    # mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex Universal Catalog 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.
      #
      # This sync mode is supported for entries.
      FULL = 1

      # Only the resources 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.
      #
      # This sync mode is supported for aspects.
      INCREMENTAL = 2

      # If entry sync mode is `NONE`, then aspects are modified according
      # to the aspect sync mode. Other metadata that belongs to entries in the
      # job's scope isn't modified.
      #
      # This sync mode is supported for entries.
      NONE = 3
    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

  # Job specification for a metadata export job.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope]
  #     Required. The scope of the export job.
  # @!attribute [rw] output_path
  #   @return [::String]
  #     Required. The root path of the Cloud Storage bucket to export the
  #     metadata to, in the format `gs://{bucket}/`. You can optionally specify a
  #     custom prefix after the bucket name, in the format
  #     `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
  #     characters. Dataplex Universal Catalog constructs the object path for the
  #     exported files by using the bucket name and prefix that you provide,
  #     followed by a system-generated path.
  #
  #     The bucket must be in the same VPC Service Controls perimeter as the job.
  class ExportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The scope of the export job.
    # @!attribute [rw] organization_level
    #   @return [::Boolean]
    #     Whether the metadata export job is an organization-level export job.
    #
    #     - If `true`, the job exports the entries from the same organization and
    #     VPC Service Controls perimeter as the job. The project that the job
    #     belongs to determines the VPC Service Controls perimeter. If you set
    #     the job scope to be at the organization level, then don't provide a
    #     list of projects or entry groups.
    #     - If `false`, you must specify a list of projects or a list of entry
    #     groups whose entries you want to export.
    #
    #     The default is `false`.
    # @!attribute [rw] projects
    #   @return [::Array<::String>]
    #     The projects whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}`. Only the entries from
    #     the specified projects are exported.
    #
    #     The projects must be in the same organization and VPC Service Controls
    #     perimeter as the job.
    #
    #     If you set the job scope to be a list of projects, then set the
    #     organization-level export flag to false and don't provide a list of
    #     entry groups.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     The entry groups whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only the entries in the specified entry groups are exported.
    #
    #     The entry groups must be in the same location and the same VPC Service
    #     Controls perimeter as the job.
    #
    #     If you set the job scope to be a list of entry groups, then set the
    #     organization-level export flag to false and don't provide a list of
    #     projects.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     The entry types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
    #     Only entries that belong to the specified entry types are affected by
    #     the job.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     The aspect types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
    #     Only aspects that belong to the specified aspect types are affected by
    #     the job.
    class ExportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    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

    # Export job.
    EXPORT = 2
  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.



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1461

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.
  # @!attribute [r] deleted_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     deleted.
  # @!attribute [r] created_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     created.
  # @!attribute [r] unchanged_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were left unchanged.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Summary results from a metadata export job. The results are a snapshot of
  # the metadata at the time when the job was created. The exported entries are
  # saved to a Cloud Storage bucket.
  # @!attribute [r] exported_entries
  #   @return [::Integer]
  #     Output only. The number of entries that were exported.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message if the metadata export job failed.
  class ExportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job.
  #
  # You can run the following kinds of metadata import jobs:
  #
  # * Full sync of entries with incremental import of their aspects.
  # Supported for custom entries.
  # * Incremental import of aspects only. Supported for aspects that belong
  # to custom entries and system entries. For custom entries, you can modify
  # both optional aspects and required aspects. For system entries, you can
  # modify optional aspects.
  # @!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 import 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.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  # @!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 groups that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries and aspects that belong to the specified entry groups are
    #     affected by the job.
    #
    #     The entry groups 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 and aspects 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.
    #
    #     This field is required when creating an aspect-only import job.
    #
    #     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.
    # @!attribute [rw] glossaries
    #   @return [::Array<::String>]
    #     Optional. The glossaries that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}`.
    #
    #     While importing Business Glossary entries, the user must
    #     provide glossaries. While importing entries, the user does not have to
    #     provide glossaries. If the metadata import file attempts to modify
    #     Business Glossary entries whose glossary isn't included in this list,
    #     the import job will skip those entries.
    #
    #     The location of a glossary must either match the location of the
    #     job, or the glossary must be global.
    # @!attribute [rw] entry_link_types
    #   @return [::Array<::String>]
    #     Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}`.
    #     The job modifies only the entryLinks that belong to these entry link
    #     types.
    #
    #     If the metadata import file attempts to create or delete an entry link
    #     whose entry link type isn't included in this list, the import job will
    #     skip those entry links.
    # @!attribute [rw] referenced_entry_scopes
    #   @return [::Array<::String>]
    #     Optional. Defines the scope of entries that can be referenced in the
    #     entry links.
    #
    #     Currently, projects are supported as valid scopes.
    #     Format: `projects/{project_number_or_id}`
    #
    #     If the metadata import file attempts to create an entry link
    #     which references an entry that is not in the scope, the import job will
    #     skip that entry link.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata import job are
    # updated. For more information, see [Sync
    # mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex Universal Catalog 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.
      #
      # This sync mode is supported for entries.
      FULL = 1

      # Only the resources 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.
      #
      # This sync mode is supported for aspects.
      INCREMENTAL = 2

      # If entry sync mode is `NONE`, then aspects are modified according
      # to the aspect sync mode. Other metadata that belongs to entries in the
      # job's scope isn't modified.
      #
      # This sync mode is supported for entries.
      NONE = 3
    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

  # Job specification for a metadata export job.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope]
  #     Required. The scope of the export job.
  # @!attribute [rw] output_path
  #   @return [::String]
  #     Required. The root path of the Cloud Storage bucket to export the
  #     metadata to, in the format `gs://{bucket}/`. You can optionally specify a
  #     custom prefix after the bucket name, in the format
  #     `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
  #     characters. Dataplex Universal Catalog constructs the object path for the
  #     exported files by using the bucket name and prefix that you provide,
  #     followed by a system-generated path.
  #
  #     The bucket must be in the same VPC Service Controls perimeter as the job.
  class ExportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The scope of the export job.
    # @!attribute [rw] organization_level
    #   @return [::Boolean]
    #     Whether the metadata export job is an organization-level export job.
    #
    #     - If `true`, the job exports the entries from the same organization and
    #     VPC Service Controls perimeter as the job. The project that the job
    #     belongs to determines the VPC Service Controls perimeter. If you set
    #     the job scope to be at the organization level, then don't provide a
    #     list of projects or entry groups.
    #     - If `false`, you must specify a list of projects or a list of entry
    #     groups whose entries you want to export.
    #
    #     The default is `false`.
    # @!attribute [rw] projects
    #   @return [::Array<::String>]
    #     The projects whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}`. Only the entries from
    #     the specified projects are exported.
    #
    #     The projects must be in the same organization and VPC Service Controls
    #     perimeter as the job.
    #
    #     If you set the job scope to be a list of projects, then set the
    #     organization-level export flag to false and don't provide a list of
    #     entry groups.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     The entry groups whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only the entries in the specified entry groups are exported.
    #
    #     The entry groups must be in the same location and the same VPC Service
    #     Controls perimeter as the job.
    #
    #     If you set the job scope to be a list of entry groups, then set the
    #     organization-level export flag to false and don't provide a list of
    #     projects.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     The entry types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
    #     Only entries that belong to the specified entry types are affected by
    #     the job.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     The aspect types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
    #     Only aspects that belong to the specified aspect types are affected by
    #     the job.
    class ExportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    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

    # Export job.
    EXPORT = 2
  end
end

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

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

Returns:



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1461

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.
  # @!attribute [r] deleted_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     deleted.
  # @!attribute [r] created_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were successfully
  #     created.
  # @!attribute [r] unchanged_entry_links
  #   @return [::Integer]
  #     Output only. The total number of entry links that were left unchanged.
  class ImportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Summary results from a metadata export job. The results are a snapshot of
  # the metadata at the time when the job was created. The exported entries are
  # saved to a Cloud Storage bucket.
  # @!attribute [r] exported_entries
  #   @return [::Integer]
  #     Output only. The number of entries that were exported.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message if the metadata export job failed.
  class ExportJobResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Job specification for a metadata import job.
  #
  # You can run the following kinds of metadata import jobs:
  #
  # * Full sync of entries with incremental import of their aspects.
  # Supported for custom entries.
  # * Incremental import of aspects only. Supported for aspects that belong
  # to custom entries and system entries. For custom entries, you can modify
  # both optional aspects and required aspects. For system entries, you can
  # modify optional aspects.
  # @!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 import 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.
  # @!attribute [rw] aspect_sync_mode
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode]
  #     Required. The sync mode for aspects.
  # @!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 groups that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only entries and aspects that belong to the specified entry groups are
    #     affected by the job.
    #
    #     The entry groups 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 and aspects 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.
    #
    #     This field is required when creating an aspect-only import job.
    #
    #     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.
    # @!attribute [rw] glossaries
    #   @return [::Array<::String>]
    #     Optional. The glossaries that are in scope for the import job,
    #     specified as relative resource names in the format
    #     `projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}`.
    #
    #     While importing Business Glossary entries, the user must
    #     provide glossaries. While importing entries, the user does not have to
    #     provide glossaries. If the metadata import file attempts to modify
    #     Business Glossary entries whose glossary isn't included in this list,
    #     the import job will skip those entries.
    #
    #     The location of a glossary must either match the location of the
    #     job, or the glossary must be global.
    # @!attribute [rw] entry_link_types
    #   @return [::Array<::String>]
    #     Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}`.
    #     The job modifies only the entryLinks that belong to these entry link
    #     types.
    #
    #     If the metadata import file attempts to create or delete an entry link
    #     whose entry link type isn't included in this list, the import job will
    #     skip those entry links.
    # @!attribute [rw] referenced_entry_scopes
    #   @return [::Array<::String>]
    #     Optional. Defines the scope of entries that can be referenced in the
    #     entry links.
    #
    #     Currently, projects are supported as valid scopes.
    #     Format: `projects/{project_number_or_id}`
    #
    #     If the metadata import file attempts to create an entry link
    #     which references an entry that is not in the scope, the import job will
    #     skip that entry link.
    class ImportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies how the entries and aspects in a metadata import job are
    # updated. For more information, see [Sync
    # mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
    module SyncMode
      # Sync mode unspecified.
      SYNC_MODE_UNSPECIFIED = 0

      # All resources in the job's scope are modified. If a resource exists in
      # Dataplex Universal Catalog 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.
      #
      # This sync mode is supported for entries.
      FULL = 1

      # Only the resources 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.
      #
      # This sync mode is supported for aspects.
      INCREMENTAL = 2

      # If entry sync mode is `NONE`, then aspects are modified according
      # to the aspect sync mode. Other metadata that belongs to entries in the
      # job's scope isn't modified.
      #
      # This sync mode is supported for entries.
      NONE = 3
    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

  # Job specification for a metadata export job.
  # @!attribute [rw] scope
  #   @return [::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope]
  #     Required. The scope of the export job.
  # @!attribute [rw] output_path
  #   @return [::String]
  #     Required. The root path of the Cloud Storage bucket to export the
  #     metadata to, in the format `gs://{bucket}/`. You can optionally specify a
  #     custom prefix after the bucket name, in the format
  #     `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
  #     characters. Dataplex Universal Catalog constructs the object path for the
  #     exported files by using the bucket name and prefix that you provide,
  #     followed by a system-generated path.
  #
  #     The bucket must be in the same VPC Service Controls perimeter as the job.
  class ExportJobSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The scope of the export job.
    # @!attribute [rw] organization_level
    #   @return [::Boolean]
    #     Whether the metadata export job is an organization-level export job.
    #
    #     - If `true`, the job exports the entries from the same organization and
    #     VPC Service Controls perimeter as the job. The project that the job
    #     belongs to determines the VPC Service Controls perimeter. If you set
    #     the job scope to be at the organization level, then don't provide a
    #     list of projects or entry groups.
    #     - If `false`, you must specify a list of projects or a list of entry
    #     groups whose entries you want to export.
    #
    #     The default is `false`.
    # @!attribute [rw] projects
    #   @return [::Array<::String>]
    #     The projects whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}`. Only the entries from
    #     the specified projects are exported.
    #
    #     The projects must be in the same organization and VPC Service Controls
    #     perimeter as the job.
    #
    #     If you set the job scope to be a list of projects, then set the
    #     organization-level export flag to false and don't provide a list of
    #     entry groups.
    # @!attribute [rw] entry_groups
    #   @return [::Array<::String>]
    #     The entry groups whose metadata you want to export, in the format
    #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    #     Only the entries in the specified entry groups are exported.
    #
    #     The entry groups must be in the same location and the same VPC Service
    #     Controls perimeter as the job.
    #
    #     If you set the job scope to be a list of entry groups, then set the
    #     organization-level export flag to false and don't provide a list of
    #     projects.
    # @!attribute [rw] entry_types
    #   @return [::Array<::String>]
    #     The entry types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
    #     Only entries that belong to the specified entry types are affected by
    #     the job.
    # @!attribute [rw] aspect_types
    #   @return [::Array<::String>]
    #     The aspect types that are in scope for the export job, specified as
    #     relative resource names in the format
    #     `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
    #     Only aspects that belong to the specified aspect types are affected by
    #     the job.
    class ExportJobScope
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    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

    # Export job.
    EXPORT = 2
  end
end