Cloud Dataplex v1 API - Class MetadataJob.Types.ExportJobSpec.Types.ExportJobScope (3.8.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.

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. Optional. If specified, only aspects of the specified types will be affected by the job. Must follow the format: "projects/<project_id_or_number>/locations/<location>/aspectTypes/<aspect_type_id>"

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 that are in scope for the export job. Optional. If specified, only entries in the specified entry groups will be exported by the job. Must be in the VPC-SC perimeter of the job. The location of the entry groups must be the same as the job. Either projects or entry_groups can be specified when organization_level_export is set to false. Must follow the format: "projects/<project_id_or_number>/locations/<location>/entryGroups/<entry_group_id>"

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

If specified, only entries of the specified types will be affected by the job. Must follow the format: "projects/<project_id_or_number>/locations/<location>/entryTypes/<entry_type_id>"

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

Indicating if it is an organization level export job.

  • When set to true, exports all entries from entry groups and projects sharing the same organization id of the Metadata Job. Only projects and entry groups in the VPC-SC perimeter will be exported. The projects and entry groups are ignored.
  • When set to false, one of the projects or entry groups must be specified.
  • Default to false.
Property Value
Type Description
bool

Projects

public RepeatedField<string> Projects { get; }

The projects that are in the scope of the export job. Can either be project numbers or project IDs. If specified, only the entries from the specified projects will be exported. The projects must be in the same organization and in the VPC-SC perimeter. Either projects or entry_groups can be specified when organization_level_export is set to false. Must follow the format: "projects/<project_id_or_number>"

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