Class MetadataJob.ImportJobSpec.ImportJobScope.Builder (1.73.0) 

public static final class MetadataJob.ImportJobSpec.ImportJobScope.Builder extends GeneratedMessageV3.Builder<MetadataJob.ImportJobSpec.ImportJobScope.Builder> implements MetadataJob.ImportJobSpec.ImportJobScopeOrBuilder

A boundary on the scope of impact that the metadata import job can have.

Protobuf type google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.ImportJobScope

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > MetadataJob.ImportJobSpec.ImportJobScope.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAspectTypes(Iterable<String> values)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addAllAspectTypes(Iterable<String> values)

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
values Iterable<String>

The aspectTypes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addAllEntryGroups(Iterable<String> values)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addAllEntryGroups(Iterable<String> values)

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
values Iterable<String>

The entryGroups to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addAllEntryLinkTypes(Iterable<String> values)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addAllEntryLinkTypes(Iterable<String> values)

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
values Iterable<String>

The entryLinkTypes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addAllEntryTypes(Iterable<String> values)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addAllEntryTypes(Iterable<String> values)

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
values Iterable<String>

The entryTypes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addAllGlossaries(Iterable<String> values)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addAllGlossaries(Iterable<String> values)

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
values Iterable<String>

The glossaries to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addAllReferencedEntryScopes(Iterable<String> values)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addAllReferencedEntryScopes(Iterable<String> values)

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
values Iterable<String>

The referencedEntryScopes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addAspectTypes(String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addAspectTypes(String value)

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
value String

The aspectTypes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addAspectTypesBytes(ByteString value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addAspectTypesBytes(ByteString value)

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
value ByteString

The bytes of the aspectTypes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addEntryGroups(String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addEntryGroups(String value)

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
value String

The entryGroups to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addEntryGroupsBytes(ByteString value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addEntryGroupsBytes(ByteString value)

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
value ByteString

The bytes of the entryGroups to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addEntryLinkTypes(String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addEntryLinkTypes(String value)

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
value String

The entryLinkTypes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addEntryLinkTypesBytes(ByteString value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addEntryLinkTypesBytes(ByteString value)

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
value ByteString

The bytes of the entryLinkTypes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addEntryTypes(String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addEntryTypes(String value)

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
value String

The entryTypes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addEntryTypesBytes(ByteString value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addEntryTypesBytes(ByteString value)

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
value ByteString

The bytes of the entryTypes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addGlossaries(String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addGlossaries(String value)

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
value String

The glossaries to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addGlossariesBytes(ByteString value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addGlossariesBytes(ByteString value)

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
value ByteString

The bytes of the glossaries to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addReferencedEntryScopes(String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addReferencedEntryScopes(String value)

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
value String

The referencedEntryScopes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addReferencedEntryScopesBytes(ByteString value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addReferencedEntryScopesBytes(ByteString value)

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
value ByteString

The bytes of the referencedEntryScopes to add.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides

build()

public MetadataJob.ImportJobSpec.ImportJobScope build()
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope

buildPartial()

public MetadataJob.ImportJobSpec.ImportJobScope buildPartial()
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope

clear()

public MetadataJob.ImportJobSpec.ImportJobScope.Builder clear()
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides

clearAspectTypes()

public MetadataJob.ImportJobSpec.ImportJobScope.Builder clearAspectTypes()

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
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

clearEntryGroups()

public MetadataJob.ImportJobSpec.ImportJobScope.Builder clearEntryGroups()

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
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

clearEntryLinkTypes()

public MetadataJob.ImportJobSpec.ImportJobScope.Builder clearEntryLinkTypes()

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
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

clearEntryTypes()

public MetadataJob.ImportJobSpec.ImportJobScope.Builder clearEntryTypes()

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
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides

clearGlossaries()

public MetadataJob.ImportJobSpec.ImportJobScope.Builder clearGlossaries()

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
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides

clearReferencedEntryScopes()

public MetadataJob.ImportJobSpec.ImportJobScope.Builder clearReferencedEntryScopes()

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
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

clone()

public MetadataJob.ImportJobSpec.ImportJobScope.Builder clone()
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides

getAspectTypes(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the aspectTypes.

getDefaultInstanceForType()

public MetadataJob.ImportJobSpec.ImportJobScope getDefaultInstanceForType()
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEntryGroups(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the entryGroups.

getEntryLinkTypes(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the entryLinkTypes.

getEntryTypes(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the entryTypes.

getGlossaries(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the glossaries.

getReferencedEntryScopes(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the referencedEntryScopes.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(MetadataJob.ImportJobSpec.ImportJobScope other)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder mergeFrom(MetadataJob.ImportJobSpec.ImportJobScope other)
Parameter
Name Description
other MetadataJob.ImportJobSpec.ImportJobScope
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MetadataJob.ImportJobSpec.ImportJobScope.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides

setAspectTypes(int index, String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder setAspectTypes(int index, String value)

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
Name Description
index int

The index to set the value at.
value String

The aspectTypes to set.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

setEntryGroups(int index, String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder setEntryGroups(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.
value String

The entryGroups to set.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

setEntryLinkTypes(int index, String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder setEntryLinkTypes(int index, String value)

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
Name Description
index int

The index to set the value at.
value String

The entryLinkTypes to set.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

setEntryTypes(int index, String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder setEntryTypes(int index, String value)

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
Name Description
index int

The index to set the value at.
value String

The entryTypes to set.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides

setGlossaries(int index, String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder setGlossaries(int index, String value)

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
Name Description
index int

The index to set the value at.
value String

The glossaries to set.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

setReferencedEntryScopes(int index, String value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder setReferencedEntryScopes(int index, String value)

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
Name Description
index int

The index to set the value at.
value String

The referencedEntryScopes to set.
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public MetadataJob.ImportJobSpec.ImportJobScope.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final MetadataJob.ImportJobSpec.ImportJobScope.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides