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.
↳ projects
array
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.
↳ entry_groups
array
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.
↳ entry_types
array
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.
↳ aspect_types
array
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.
getOrganizationLevel
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
Type
Description
bool
setOrganizationLevel
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.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getProjects
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.
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.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getEntryGroups
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.
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.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getEntryTypes
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.
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.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getAspectTypes
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class ExportJobScope (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.MetadataJob.ExportJobSpec.ExportJobScope)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.MetadataJob.ExportJobSpec.ExportJobScope) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class ExportJobScope.\n\nThe scope of the export job.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1 \\\\ MetadataJob \\\\ ExportJobSpec\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getOrganizationLevel\n\nWhether the metadata export job is an organization-level export job.\n\n- 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.\n- 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`.\n\n### setOrganizationLevel\n\nWhether the metadata export job is an organization-level export job.\n\n- 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.\n- 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`.\n\n### getProjects\n\nThe projects whose metadata you want to export, in the format\n`projects/{project_id_or_number}`. Only the entries from\nthe specified projects are exported.\n\nThe projects must be in the same organization and VPC Service Controls\nperimeter as the job.\nIf you set the job scope to be a list of projects, then set the\norganization-level export flag to false and don't provide a list of\nentry groups.\n\n### setProjects\n\nThe projects whose metadata you want to export, in the format\n`projects/{project_id_or_number}`. Only the entries from\nthe specified projects are exported.\n\nThe projects must be in the same organization and VPC Service Controls\nperimeter as the job.\nIf you set the job scope to be a list of projects, then set the\norganization-level export flag to false and don't provide a list of\nentry groups.\n\n### getEntryGroups\n\nThe entry groups whose metadata you want to export, in the format\n`projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.\n\nOnly the entries in the specified entry groups are exported.\nThe entry groups must be in the same location and the same VPC Service\nControls perimeter as the job.\nIf you set the job scope to be a list of entry groups, then set the\norganization-level export flag to false and don't provide a list of\nprojects.\n\n### setEntryGroups\n\nThe entry groups whose metadata you want to export, in the format\n`projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.\n\nOnly the entries in the specified entry groups are exported.\nThe entry groups must be in the same location and the same VPC Service\nControls perimeter as the job.\nIf you set the job scope to be a list of entry groups, then set the\norganization-level export flag to false and don't provide a list of\nprojects.\n\n### getEntryTypes\n\nThe entry types that are in scope for the export job, specified as\nrelative resource names in the format\n`projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.\n\nOnly entries that belong to the specified entry types are affected by\nthe job.\n\n### setEntryTypes\n\nThe entry types that are in scope for the export job, specified as\nrelative resource names in the format\n`projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.\n\nOnly entries that belong to the specified entry types are affected by\nthe job.\n\n### getAspectTypes\n\nThe aspect types that are in scope for the export job, specified as\nrelative resource names in the format\n`projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.\n\nOnly aspects that belong to the specified aspect types are affected by\nthe job.\n\n### setAspectTypes\n\nThe aspect types that are in scope for the export job, specified as\nrelative resource names in the format\n`projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.\n\nOnly aspects that belong to the specified aspect types are affected by\nthe job."]]
