Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ExportJobScope.
The scope of the export job.
Generated from protobuf message google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope
Namespace
Google \ Cloud \ Dataplex \ V1 \ MetadataJob \ ExportJobSpecMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ organization_level |
bool
Whether the metadata export job is an organization-level export job. - If |
↳ projects |
array
The projects whose metadata you want to export, in the format |
↳ entry_groups |
array
The entry groups whose metadata you want to export, in the format |
↳ entry_types |
array
The entry types that are in scope for the export job, specified as relative resource names in the format |
↳ aspect_types |
array
The aspect types that are in scope for the export job, specified as relative resource names in the format |
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 isfalse.
| 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 isfalse.
| 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setProjects
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEntryGroups
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEntryTypes
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAspectTypes
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|