Class: Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope

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

Overview

Scope of the export job.

Instance Attribute Summary collapse

Instance Attribute Details

#aspect_types ⇒ ::Array<::String>

Returns The aspect types that are in scope for the export job. Optional. If specified, only aspects of the specified types will be affected by the job. Must follow the format: "projects//locations//aspectTypes/".

Returns:

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

    The aspect types that are in scope for the export job. Optional. If specified, only aspects of the specified types will be affected by the job. Must follow the format: "projects//locations//aspectTypes/"



1588
1589
1590
1591
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1588

class ExportJobScope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#entry_groups ⇒ ::Array<::String>

Returns The entry groups that are in scope for the export job. Optional. If specified, only entries in the specified entry groups will be exported by the job. Must be in the VPC-SC perimeter of the job. The location of the entry groups must be the same as the job. Either projects or entry_groups can be specified when organization_level_export is set to false. Must follow the format: "projects//locations//entryGroups/".

Returns:

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

    The entry groups that are in scope for the export job. Optional. If specified, only entries in the specified entry groups will be exported by the job. Must be in the VPC-SC perimeter of the job. The location of the entry groups must be the same as the job. Either projects or entry_groups can be specified when organization_level_export is set to false. Must follow the format: "projects//locations//entryGroups/"



1588
1589
1590
1591
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1588

class ExportJobScope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#entry_types ⇒ ::Array<::String>

Returns If specified, only entries of the specified types will be affected by the job. Must follow the format: "projects//locations//entryTypes/".

Returns:

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

    If specified, only entries of the specified types will be affected by the job. Must follow the format: "projects//locations//entryTypes/"



1588
1589
1590
1591
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1588

class ExportJobScope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#organization_level ⇒ ::Boolean

Returns Indicating if it is an organization level export job.

  • When set to true, exports all entries from entry groups and projects sharing the same organization id of the Metadata Job. Only projects and entry groups in the VPC-SC perimeter will be exported. The projects and entry groups are ignored.
  • When set to false, one of the projects or entry groups must be specified.
  • Default to false.

Returns:

  • (::Boolean) —

    Indicating if it is an organization level export job.

    • When set to true, exports all entries from entry groups and projects sharing the same organization id of the Metadata Job. Only projects and entry groups in the VPC-SC perimeter will be exported. The projects and entry groups are ignored.
    • When set to false, one of the projects or entry groups must be specified.
    • Default to false.


1588
1589
1590
1591
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1588

class ExportJobScope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#projects ⇒ ::Array<::String>

Returns The projects that are in the scope of the export job. Can either be project numbers or project IDs. If specified, only the entries from the specified projects will be exported. The projects must be in the same organization and in the VPC-SC perimeter. Either projects or entry_groups can be specified when organization_level_export is set to false. Must follow the format: "projects/".

Returns:

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

    The projects that are in the scope of the export job. Can either be project numbers or project IDs. If specified, only the entries from the specified projects will be exported. The projects must be in the same organization and in the VPC-SC perimeter. Either projects or entry_groups can be specified when organization_level_export is set to false. Must follow the format: "projects/"



1588
1589
1590
1591
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1588

class ExportJobScope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end