Package com.google.cloud.dataplex.v1

Interface MetadataJob.ExportJobSpec.ExportJobScopeOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
MetadataJob.ExportJobSpec.ExportJobScope, MetadataJob.ExportJobSpec.ExportJobScope.Builder
Enclosing class:
MetadataJob.ExportJobSpec
public static interface MetadataJob.ExportJobSpec.ExportJobScopeOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAspectTypes(int index)
    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}`.
    com.google.protobuf.ByteString
    getAspectTypesBytes(int index)
    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}`.
    int
    getAspectTypesCount()
    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}`.
    List<String>
    getAspectTypesList()
    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}`.
    String
    getEntryGroups(int index)
    The entry groups whose metadata you want to export, in the format `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    com.google.protobuf.ByteString
    getEntryGroupsBytes(int index)
    The entry groups whose metadata you want to export, in the format `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    int
    getEntryGroupsCount()
    The entry groups whose metadata you want to export, in the format `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    List<String>
    getEntryGroupsList()
    The entry groups whose metadata you want to export, in the format `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
    String
    getEntryTypes(int index)
    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}`.
    com.google.protobuf.ByteString
    getEntryTypesBytes(int index)
    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}`.
    int
    getEntryTypesCount()
    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}`.
    List<String>
    getEntryTypesList()
    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}`.
    boolean
    getOrganizationLevel()
    Whether the metadata export job is an organization-level export job
    String
    getProjects(int index)
    The projects whose metadata you want to export, in the format `projects/{project_id_or_number}`.
    com.google.protobuf.ByteString
    getProjectsBytes(int index)
    The projects whose metadata you want to export, in the format `projects/{project_id_or_number}`.
    int
    getProjectsCount()
    The projects whose metadata you want to export, in the format `projects/{project_id_or_number}`.
    List<String>
    getProjectsList()
    The projects whose metadata you want to export, in the format `projects/{project_id_or_number}`.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getOrganizationLevel

      boolean getOrganizationLevel()
       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`.
      bool organization_level = 1;
      Returns:
      The organizationLevel.

    • getProjectsList

      List<String> getProjectsList()
       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.
      repeated string projects = 2 [(.google.api.resource_reference) = { ... }
      Returns:
      A list containing the projects.

    • getProjectsCount

      int getProjectsCount()
       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.
      repeated string projects = 2 [(.google.api.resource_reference) = { ... }
      Returns:
      The count of projects.

    • getProjects

      String getProjects(int index)
       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.
      repeated string projects = 2 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The projects at the given index.

    • getProjectsBytes

      com.google.protobuf.ByteString getProjectsBytes(int index)
       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.
      repeated string projects = 2 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the projects at the given index.

    • getEntryGroupsList

      List<String> getEntryGroupsList()
       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.
      repeated string entry_groups = 3 [(.google.api.resource_reference) = { ... }
      Returns:
      A list containing the entryGroups.

    • getEntryGroupsCount

      int getEntryGroupsCount()
       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.
      repeated string entry_groups = 3 [(.google.api.resource_reference) = { ... }
      Returns:
      The count of entryGroups.

    • getEntryGroups

      String getEntryGroups(int index)
       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.
      repeated string entry_groups = 3 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The entryGroups at the given index.

    • getEntryGroupsBytes

      com.google.protobuf.ByteString getEntryGroupsBytes(int index)
       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.
      repeated string entry_groups = 3 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the entryGroups at the given index.

    • getEntryTypesList

      List<String> getEntryTypesList()
       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.
      repeated string entry_types = 4 [(.google.api.resource_reference) = { ... }
      Returns:
      A list containing the entryTypes.

    • getEntryTypesCount

      int getEntryTypesCount()
       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.
      repeated string entry_types = 4 [(.google.api.resource_reference) = { ... }
      Returns:
      The count of entryTypes.

    • getEntryTypes

      String getEntryTypes(int index)
       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.
      repeated string entry_types = 4 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The entryTypes at the given index.

    • getEntryTypesBytes

      com.google.protobuf.ByteString getEntryTypesBytes(int index)
       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.
      repeated string entry_types = 4 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the entryTypes at the given index.

    • getAspectTypesList

      List<String> getAspectTypesList()
       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.
      repeated string aspect_types = 5 [(.google.api.resource_reference) = { ... }
      Returns:
      A list containing the aspectTypes.

    • getAspectTypesCount

      int getAspectTypesCount()
       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.
      repeated string aspect_types = 5 [(.google.api.resource_reference) = { ... }
      Returns:
      The count of aspectTypes.

    • getAspectTypes

      String getAspectTypes(int index)
       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.
      repeated string aspect_types = 5 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The aspectTypes at the given index.

    • getAspectTypesBytes

      com.google.protobuf.ByteString getAspectTypesBytes(int index)
       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.
      repeated string aspect_types = 5 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the aspectTypes at the given index.