Cloud Dataplex v1 API - Class MetadataJob.Types.ImportJobSpec.Types.ImportJobScope (3.10.0)

public sealed class MetadataJob.Types.ImportJobSpec.Types.ImportJobScope : IMessage<MetadataJob.Types.ImportJobSpec.Types.ImportJobScope>, IEquatable<MetadataJob.Types.ImportJobSpec.Types.ImportJobScope>, IDeepCloneable<MetadataJob.Types.ImportJobSpec.Types.ImportJobScope>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class MetadataJob.Types.ImportJobSpec.Types.ImportJobScope.

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

Inheritance

object > MetadataJob.Types.ImportJobSpec.Types.ImportJobScope

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

ImportJobScope()

public ImportJobScope()

ImportJobScope(ImportJobScope)

public ImportJobScope(MetadataJob.Types.ImportJobSpec.Types.ImportJobScope other)
Parameter
Name Description
other MetadataJobTypesImportJobSpecTypesImportJobScope

Properties

AspectTypes

public RepeatedField<string> AspectTypes { get; }

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.

Property Value
Type Description
RepeatedFieldstring

AspectTypesAsAspectTypeNames

public ResourceNameList<AspectTypeName> AspectTypesAsAspectTypeNames { get; }

AspectTypeName-typed view over the AspectTypes resource name property.

Property Value
Type Description
ResourceNameListAspectTypeName

EntryGroups

public RepeatedField<string> EntryGroups { get; }

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.

Property Value
Type Description
RepeatedFieldstring

EntryGroupsAsEntryGroupNames

public ResourceNameList<EntryGroupName> EntryGroupsAsEntryGroupNames { get; }

EntryGroupName-typed view over the EntryGroups resource name property.

Property Value
Type Description
ResourceNameListEntryGroupName

EntryLinkTypes

public RepeatedField<string> EntryLinkTypes { get; }

Optional. The entry link 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}/entryLinkTypes/{entry_link_type_id}. The job modifies only the entryLinks that belong to these entry link types.

If the metadata import file attempts to create or delete an entry link whose entry link type isn't included in this list, the import job will skip those entry links.

Property Value
Type Description
RepeatedFieldstring

EntryTypes

public RepeatedField<string> EntryTypes { get; }

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.

Property Value
Type Description
RepeatedFieldstring

EntryTypesAsEntryTypeNames

public ResourceNameList<EntryTypeName> EntryTypesAsEntryTypeNames { get; }

EntryTypeName-typed view over the EntryTypes resource name property.

Property Value
Type Description
ResourceNameListEntryTypeName

Glossaries

public RepeatedField<string> Glossaries { get; }

Optional. The glossaries that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}.

While importing Business Glossary entries, the user must provide glossaries. While importing entries, the user does not have to provide glossaries. If the metadata import file attempts to modify Business Glossary entries whose glossary isn't included in this list, the import job will skip those entries.

The location of a glossary must either match the location of the job, or the glossary must be global.

Property Value
Type Description
RepeatedFieldstring

GlossariesAsGlossaryNames

public ResourceNameList<GlossaryName> GlossariesAsGlossaryNames { get; }

GlossaryName-typed view over the Glossaries resource name property.

Property Value
Type Description
ResourceNameListGlossaryName

ReferencedEntryScopes

public RepeatedField<string> ReferencedEntryScopes { get; }

Optional. Defines the scope of entries that can be referenced in the entry links.

Currently, projects are supported as valid scopes. Format: projects/{project_number_or_id}

If the metadata import file attempts to create an entry link which references an entry that is not in the scope, the import job will skip that entry link.

Property Value
Type Description
RepeatedFieldstring