Google Cloud Dataplex V1 Client - Class ImportJobScope (1.7.1)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ImportJobScope.

A boundary on the scope of impact that the metadata import job can have.

Generated from protobuf message google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.ImportJobScope

Namespace

Google \ Cloud \ Dataplex \ V1 \ MetadataJob \ ImportJobSpec

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ entry_groups array

Required. The entry group that is in scope for the import job, specified as a relative resource name 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 group are affected by the job. Must contain exactly one element. The entry group and the job must be in the same location.
↳ entry_types array

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.
↳ aspect_types array

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.

getEntryGroups

Required. The entry group that is in scope for the import job, specified as a relative resource name 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 group are affected by the job. Must contain exactly one element. The entry group and the job must be in the same location.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEntryGroups

Required. The entry group that is in scope for the import job, specified as a relative resource name 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 group are affected by the job. Must contain exactly one element. The entry group and the job must be in the same location.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getEntryTypes

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEntryTypes

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getAspectTypes

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAspectTypes

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this