Interface MetadataJob.ImportJobSpec.ImportJobScopeOrBuilder (1.73.0) 

public static interface MetadataJob.ImportJobSpec.ImportJobScopeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAspectTypes(int index)

public abstract 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) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The aspectTypes at the given index.

getAspectTypesBytes(int index)

public abstract 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) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the aspectTypes at the given index.

getAspectTypesCount()

public abstract 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
Type Description
int

The count of aspectTypes.

getAspectTypesList()

public abstract 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
Type Description
List<String>

A list containing the aspectTypes.

getEntryGroups(int index)

public abstract String getEntryGroups(int index)

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.

repeated string entry_groups = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The entryGroups at the given index.

getEntryGroupsBytes(int index)

public abstract ByteString getEntryGroupsBytes(int index)

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.

repeated string entry_groups = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the entryGroups at the given index.

getEntryGroupsCount()

public abstract int getEntryGroupsCount()

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.

repeated string entry_groups = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of entryGroups.

getEntryGroupsList()

public abstract List<String> getEntryGroupsList()

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.

repeated string entry_groups = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
List<String>

A list containing the entryGroups.

getEntryLinkTypes(int index)

public abstract 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];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The entryLinkTypes at the given index.

getEntryLinkTypesBytes(int index)

public abstract 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];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the entryLinkTypes at the given index.

getEntryLinkTypesCount()

public abstract 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
Type Description
int

The count of entryLinkTypes.

getEntryLinkTypesList()

public abstract 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
Type Description
List<String>

A list containing the entryLinkTypes.

getEntryTypes(int index)

public abstract 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) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The entryTypes at the given index.

getEntryTypesBytes(int index)

public abstract 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) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the entryTypes at the given index.

getEntryTypesCount()

public abstract 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
Type Description
int

The count of entryTypes.

getEntryTypesList()

public abstract 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
Type Description
List<String>

A list containing the entryTypes.

getGlossaries(int index)

public abstract 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) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The glossaries at the given index.

getGlossariesBytes(int index)

public abstract 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) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the glossaries at the given index.

getGlossariesCount()

public abstract 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
Type Description
int

The count of glossaries.

getGlossariesList()

public abstract 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
Type Description
List<String>

A list containing the glossaries.

getReferencedEntryScopes(int index)

public abstract 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];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The referencedEntryScopes at the given index.

getReferencedEntryScopesBytes(int index)

public abstract 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];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the referencedEntryScopes at the given index.

getReferencedEntryScopesCount()

public abstract 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
Type Description
int

The count of referencedEntryScopes.

getReferencedEntryScopesList()

public abstract 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
Type Description
List<String>

A list containing the referencedEntryScopes.