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

The 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, 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.

Returns:

  • (::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.



1603
1604
1605
1606
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1603

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

#entry_groups ⇒ ::Array<::String>

Returns 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.

Returns:

  • (::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.



1603
1604
1605
1606
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1603

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

#entry_types ⇒ ::Array<::String>

Returns 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.

Returns:

  • (::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.



1603
1604
1605
1606
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1603

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

#organization_level ⇒ ::Boolean

Returns 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.

Returns:

  • (::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.



1603
1604
1605
1606
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1603

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

#projects ⇒ ::Array<::String>

Returns 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.

Returns:

  • (::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.



1603
1604
1605
1606
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1603

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