Class MetadataJob.ExportJobSpec.ExportJobScope (1.62.0)

public static final class MetadataJob.ExportJobSpec.ExportJobScope extends GeneratedMessageV3 implements MetadataJob.ExportJobSpec.ExportJobScopeOrBuilder

The scope of the export job.

Protobuf type google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > MetadataJob.ExportJobSpec.ExportJobScope

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_TYPES_FIELD_NUMBER

public static final int ENTRY_TYPES_FIELD_NUMBER
Field Value
Type Description
int

ORGANIZATION_LEVEL_FIELD_NUMBER

public static final int ORGANIZATION_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

PROJECTS_FIELD_NUMBER

public static final int PROJECTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MetadataJob.ExportJobSpec.ExportJobScope getDefaultInstance()
Returns
Type Description
MetadataJob.ExportJobSpec.ExportJobScope

getDescriptor()

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

newBuilder()

public static MetadataJob.ExportJobSpec.ExportJobScope.Builder newBuilder()
Returns
Type Description
MetadataJob.ExportJobSpec.ExportJobScope.Builder

newBuilder(MetadataJob.ExportJobSpec.ExportJobScope prototype)

public static MetadataJob.ExportJobSpec.ExportJobScope.Builder newBuilder(MetadataJob.ExportJobSpec.ExportJobScope prototype)
Parameter
Name Description
prototype MetadataJob.ExportJobSpec.ExportJobScope
Returns
Type Description
MetadataJob.ExportJobSpec.ExportJobScope.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<MetadataJob.ExportJobSpec.ExportJobScope> parser()
Returns
Type Description
Parser<ExportJobScope>

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)

The aspect types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}. Only aspects that belong to the specified aspect types are affected by the job.

repeated string aspect_types = 5 [(.google.api.resource_reference) = { ... }

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)

The aspect types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}. Only aspects that belong to the specified aspect types are affected by the job.

repeated string aspect_types = 5 [(.google.api.resource_reference) = { ... }

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()

The aspect types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}. Only aspects that belong to the specified aspect types are affected by the job.

repeated string aspect_types = 5 [(.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of aspectTypes.

getAspectTypesList()

public ProtocolStringList getAspectTypesList()

The aspect types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}. Only aspects that belong to the specified aspect types are affected by the job.

repeated string aspect_types = 5 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the aspectTypes.

getDefaultInstanceForType()

public MetadataJob.ExportJobSpec.ExportJobScope getDefaultInstanceForType()
Returns
Type Description
MetadataJob.ExportJobSpec.ExportJobScope

getEntryGroups(int index)

public String getEntryGroups(int index)

The entry groups whose metadata you want to export, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. Only the entries in the specified entry groups are exported.

The entry groups must be in the same location and the same VPC Service Controls perimeter as the job.

If you set the job scope to be a list of entry groups, then set the organization-level export flag to false and don't provide a list of projects.

repeated string entry_groups = 3 [(.google.api.resource_reference) = { ... }

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)

The entry groups whose metadata you want to export, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. Only the entries in the specified entry groups are exported.

The entry groups must be in the same location and the same VPC Service Controls perimeter as the job.

If you set the job scope to be a list of entry groups, then set the organization-level export flag to false and don't provide a list of projects.

repeated string entry_groups = 3 [(.google.api.resource_reference) = { ... }

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()

The entry groups whose metadata you want to export, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. Only the entries in the specified entry groups are exported.

The entry groups must be in the same location and the same VPC Service Controls perimeter as the job.

If you set the job scope to be a list of entry groups, then set the organization-level export flag to false and don't provide a list of projects.

repeated string entry_groups = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of entryGroups.

getEntryGroupsList()

public ProtocolStringList getEntryGroupsList()

The entry groups whose metadata you want to export, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. Only the entries in the specified entry groups are exported.

The entry groups must be in the same location and the same VPC Service Controls perimeter as the job.

If you set the job scope to be a list of entry groups, then set the organization-level export flag to false and don't provide a list of projects.

repeated string entry_groups = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the entryGroups.

getEntryTypes(int index)

public String getEntryTypes(int index)

The entry types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}. Only entries that belong to the specified entry types are affected by the job.

repeated string entry_types = 4 [(.google.api.resource_reference) = { ... }

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)

The entry types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}. Only entries that belong to the specified entry types are affected by the job.

repeated string entry_types = 4 [(.google.api.resource_reference) = { ... }

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()

The entry types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}. Only entries that belong to the specified entry types are affected by the job.

repeated string entry_types = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of entryTypes.

getEntryTypesList()

public ProtocolStringList getEntryTypesList()

The entry types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}. Only entries that belong to the specified entry types are affected by the job.

repeated string entry_types = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the entryTypes.

getOrganizationLevel()

public boolean getOrganizationLevel()

Whether the metadata export job is an organization-level export job.

  • If true, the job exports the entries from the same organization and VPC Service Controls perimeter as the job. The project that the job belongs to determines the VPC Service Controls perimeter. If you set the job scope to be at the organization level, then don't provide a list of projects or entry groups.
  • If false, you must specify a list of projects or a list of entry groups whose entries you want to export.

    The default is false.

bool organization_level = 1;

Returns
Type Description
boolean

The organizationLevel.

getParserForType()

public Parser<MetadataJob.ExportJobSpec.ExportJobScope> getParserForType()
Returns
Type Description
Parser<ExportJobScope>
Overrides

getProjects(int index)

public String getProjects(int index)

The projects whose metadata you want to export, in the format projects/{project_id_or_number}. Only the entries from the specified projects are exported.

The projects must be in the same organization and VPC Service Controls perimeter as the job.

If you set the job scope to be a list of projects, then set the organization-level export flag to false and don't provide a list of entry groups.

repeated string projects = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The projects at the given index.

getProjectsBytes(int index)

public ByteString getProjectsBytes(int index)

The projects whose metadata you want to export, in the format projects/{project_id_or_number}. Only the entries from the specified projects are exported.

The projects must be in the same organization and VPC Service Controls perimeter as the job.

If you set the job scope to be a list of projects, then set the organization-level export flag to false and don't provide a list of entry groups.

repeated string projects = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the projects at the given index.

getProjectsCount()

public int getProjectsCount()

The projects whose metadata you want to export, in the format projects/{project_id_or_number}. Only the entries from the specified projects are exported.

The projects must be in the same organization and VPC Service Controls perimeter as the job.

If you set the job scope to be a list of projects, then set the organization-level export flag to false and don't provide a list of entry groups.

repeated string projects = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of projects.

getProjectsList()

public ProtocolStringList getProjectsList()

The projects whose metadata you want to export, in the format projects/{project_id_or_number}. Only the entries from the specified projects are exported.

The projects must be in the same organization and VPC Service Controls perimeter as the job.

If you set the job scope to be a list of projects, then set the organization-level export flag to false and don't provide a list of entry groups.

repeated string projects = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the projects.

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.ExportJobSpec.ExportJobScope.Builder newBuilderForType()
Returns
Type Description
MetadataJob.ExportJobSpec.ExportJobScope.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MetadataJob.ExportJobSpec.ExportJobScope.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MetadataJob.ExportJobSpec.ExportJobScope.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.ExportJobSpec.ExportJobScope.Builder toBuilder()
Returns
Type Description
MetadataJob.ExportJobSpec.ExportJobScope.Builder

writeTo(CodedOutputStream output)

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