Package com.google.cloud.dataplex.v1

Interface MetadataJob.ImportJobSpec.ImportJobScopeOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
MetadataJob.ImportJobSpec.ImportJobScope, MetadataJob.ImportJobSpec.ImportJobScope.Builder
Enclosing class:
MetadataJob.ImportJobSpec
public static interface MetadataJob.ImportJobSpec.ImportJobScopeOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getEntryGroupsList

      List<String> getEntryGroupsList()
       Required. The entry groups that are in scope for the import job,
 specified as relative resource names 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 groups are
 affected by the job.

 The entry groups and the job must be in the same location.
      repeated string entry_groups = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the entryGroups.

    • getEntryGroupsCount

      int getEntryGroupsCount()
       Required. The entry groups that are in scope for the import job,
 specified as relative resource names 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 groups are
 affected by the job.

 The entry groups and the job must be in the same location.
      repeated string entry_groups = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The count of entryGroups.

    • getEntryGroups

      String getEntryGroups(int index)
       Required. The entry groups that are in scope for the import job,
 specified as relative resource names 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 groups are
 affected by the job.

 The entry groups and the job must be in the same location.
      repeated string entry_groups = 1 [(.google.api.field_behavior) = REQUIRED, (.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)
       Required. The entry groups that are in scope for the import job,
 specified as relative resource names 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 groups are
 affected by the job.

 The entry groups and the job must be in the same location.
      repeated string entry_groups = 1 [(.google.api.field_behavior) = REQUIRED, (.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()
       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.
      repeated string entry_types = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the entryTypes.

    • getEntryTypesCount

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

    • getEntryTypes

      String getEntryTypes(int index)
       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.
      repeated string entry_types = 2 [(.google.api.field_behavior) = REQUIRED, (.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)
       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.
      repeated string entry_types = 2 [(.google.api.field_behavior) = REQUIRED, (.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()
       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.
      repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the aspectTypes.

    • getAspectTypesCount

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

    • getAspectTypes

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

    • getGlossariesList

      List<String> getGlossariesList()
       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.
      repeated string glossaries = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the glossaries.

    • getGlossariesCount

      int getGlossariesCount()
       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.
      repeated string glossaries = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The count of glossaries.

    • getGlossaries

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

    • getGlossariesBytes

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

    • getEntryLinkTypesList

      List<String> getEntryLinkTypesList()
       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.
      repeated string entry_link_types = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the entryLinkTypes.

    • getEntryLinkTypesCount

      int getEntryLinkTypesCount()
       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.
      repeated string entry_link_types = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of entryLinkTypes.

    • getEntryLinkTypes

      String getEntryLinkTypes(int index)
       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.
      repeated string entry_link_types = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The entryLinkTypes at the given index.

    • getEntryLinkTypesBytes

      com.google.protobuf.ByteString getEntryLinkTypesBytes(int index)
       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.
      repeated string entry_link_types = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the entryLinkTypes at the given index.

    • getReferencedEntryScopesList

      List<String> getReferencedEntryScopesList()
       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.
      repeated string referenced_entry_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the referencedEntryScopes.

    • getReferencedEntryScopesCount

      int getReferencedEntryScopesCount()
       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.
      repeated string referenced_entry_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of referencedEntryScopes.

    • getReferencedEntryScopes

      String getReferencedEntryScopes(int index)
       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.
      repeated string referenced_entry_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The referencedEntryScopes at the given index.

    • getReferencedEntryScopesBytes

      com.google.protobuf.ByteString getReferencedEntryScopesBytes(int index)
       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.
      repeated string referenced_entry_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the referencedEntryScopes at the given index.