Cloud Dataplex v1 API - Class MetadataJob.Types.ExportJobSpec.Types.ExportJobScope (3.9.0)

public sealed class MetadataJob.Types.ExportJobSpec.Types.ExportJobScope : IMessage<MetadataJob.Types.ExportJobSpec.Types.ExportJobScope>, IEquatable<MetadataJob.Types.ExportJobSpec.Types.ExportJobScope>, IDeepCloneable<MetadataJob.Types.ExportJobSpec.Types.ExportJobScope>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class MetadataJob.Types.ExportJobSpec.Types.ExportJobScope.

The scope of the export job.

Inheritance

object > MetadataJob.Types.ExportJobSpec.Types.ExportJobScope

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

ExportJobScope()

public ExportJobScope()

ExportJobScope(ExportJobScope)

public ExportJobScope(MetadataJob.Types.ExportJobSpec.Types.ExportJobScope other)
Parameter
Name Description
other MetadataJobTypesExportJobSpecTypesExportJobScope

Properties

AspectTypes

public RepeatedField<string> AspectTypes { get; }

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.

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; }

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.

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

EntryTypes

public RepeatedField<string> EntryTypes { get; }

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.

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

OrganizationLevel

public bool OrganizationLevel { get; set; }

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.

Property Value
Type Description
bool

Projects

public RepeatedField<string> Projects { get; }

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.

Property Value
Type Description
RepeatedFieldstring

ProjectsAsProjectNames

public ResourceNameList<ProjectName> ProjectsAsProjectNames { get; }

ProjectName-typed view over the Projects resource name property.

Property Value
Type Description
ResourceNameListProjectName