Dataplex V1 API - Class Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope (v1.2.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#aspect_types

def aspect_types() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

    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.

#aspect_types=

def aspect_types=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.

    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
  • (::Array<::String>) — 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.

    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.

#entry_groups

def entry_groups() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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 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_groups=

def entry_groups=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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 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
  • (::Array<::String>) — 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 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

def entry_types() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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 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.

#entry_types=

def entry_types=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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 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
  • (::Array<::String>) — 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 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.