Class MetadataJob.ImportJobSpec.ImportJobScope (1.74.0) 

public static final class MetadataJob.ImportJobSpec.ImportJobScope extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > MetadataJob.ImportJobSpec.ImportJobScope

Static Fields

ASPECT_TYPES_FIELD_NUMBER

public static final int ASPECT_TYPES_FIELD_NUMBER
Field Value
Type Description
int

ENTRY_GROUPS_FIELD_NUMBER

public static final int ENTRY_GROUPS_FIELD_NUMBER
Field Value
Type Description
int

ENTRY_LINK_TYPES_FIELD_NUMBER

public static final int ENTRY_LINK_TYPES_FIELD_NUMBER
Field Value
Type Description
int

ENTRY_TYPES_FIELD_NUMBER

public static final int ENTRY_TYPES_FIELD_NUMBER
Field Value
Type Description
int

GLOSSARIES_FIELD_NUMBER

public static final int GLOSSARIES_FIELD_NUMBER
Field Value
Type Description
int

REFERENCED_ENTRY_SCOPES_FIELD_NUMBER

public static final int REFERENCED_ENTRY_SCOPES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MetadataJob.ImportJobSpec.ImportJobScope getDefaultInstance()
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope

getDescriptor()

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

newBuilder()

public static MetadataJob.ImportJobSpec.ImportJobScope.Builder newBuilder()
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

newBuilder(MetadataJob.ImportJobSpec.ImportJobScope prototype)

public static MetadataJob.ImportJobSpec.ImportJobScope.Builder newBuilder(MetadataJob.ImportJobSpec.ImportJobScope prototype)
Parameter
Name Description
prototype MetadataJob.ImportJobSpec.ImportJobScope
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

parseDelimitedFrom(InputStream input)

public static MetadataJob.ImportJobSpec.ImportJobScope parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec.ImportJobScope parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MetadataJob.ImportJobSpec.ImportJobScope parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec.ImportJobScope parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MetadataJob.ImportJobSpec.ImportJobScope parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec.ImportJobScope parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MetadataJob.ImportJobSpec.ImportJobScope parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec.ImportJobScope parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MetadataJob.ImportJobSpec.ImportJobScope parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec.ImportJobScope parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MetadataJob.ImportJobSpec.ImportJobScope parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec.ImportJobScope parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MetadataJob.ImportJobSpec.ImportJobScope> parser()
Returns
Type Description
Parser<ImportJobScope>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

getParserForType()

public Parser<MetadataJob.ImportJobSpec.ImportJobScope> getParserForType()
Returns
Type Description
Parser<ImportJobScope>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MetadataJob.ImportJobSpec.ImportJobScope.Builder newBuilderForType()
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MetadataJob.ImportJobSpec.ImportJobScope.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MetadataJob.ImportJobSpec.ImportJobScope.Builder toBuilder()
Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException