public static final class MetadataJob.ExportJobSpec.ExportJobScope extends GeneratedMessageV3 implements MetadataJob.ExportJobSpec.ExportJobScopeOrBuilder
Scope of the export job.
Protobuf type google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
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 |
|
public static final int ORGANIZATION_LEVEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PROJECTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static MetadataJob.ExportJobSpec.ExportJobScope getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static MetadataJob.ExportJobSpec.ExportJobScope.Builder newBuilder()
public static MetadataJob.ExportJobSpec.ExportJobScope.Builder newBuilder(MetadataJob.ExportJobSpec.ExportJobScope prototype)
public static MetadataJob.ExportJobSpec.ExportJobScope parseDelimitedFrom(InputStream input)
public static MetadataJob.ExportJobSpec.ExportJobScope parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static MetadataJob.ExportJobSpec.ExportJobScope parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static MetadataJob.ExportJobSpec.ExportJobScope parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MetadataJob.ExportJobSpec.ExportJobScope parseFrom(ByteString data)
public static MetadataJob.ExportJobSpec.ExportJobScope parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MetadataJob.ExportJobSpec.ExportJobScope parseFrom(CodedInputStream input)
public static MetadataJob.ExportJobSpec.ExportJobScope parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static MetadataJob.ExportJobSpec.ExportJobScope parseFrom(InputStream input)
public static MetadataJob.ExportJobSpec.ExportJobScope parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static MetadataJob.ExportJobSpec.ExportJobScope parseFrom(ByteBuffer data)
public static MetadataJob.ExportJobSpec.ExportJobScope parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<MetadataJob.ExportJobSpec.ExportJobScope> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public String getAspectTypes(int index)
The aspect types that are in scope for the export job.
Optional. If specified, only aspects of the specified types will be
affected by the job.
Must follow the format:
"projects/<project_id_or_number>/locations/<location>/aspectTypes/<aspect_type_id>"
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.
|
public ByteString getAspectTypesBytes(int index)
The aspect types that are in scope for the export job.
Optional. If specified, only aspects of the specified types will be
affected by the job.
Must follow the format:
"projects/<project_id_or_number>/locations/<location>/aspectTypes/<aspect_type_id>"
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.
|
public int getAspectTypesCount()
The aspect types that are in scope for the export job.
Optional. If specified, only aspects of the specified types will be
affected by the job.
Must follow the format:
"projects/<project_id_or_number>/locations/<location>/aspectTypes/<aspect_type_id>"
repeated string aspect_types = 5 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
int |
The count of aspectTypes.
|
public ProtocolStringList getAspectTypesList()
The aspect types that are in scope for the export job.
Optional. If specified, only aspects of the specified types will be
affected by the job.
Must follow the format:
"projects/<project_id_or_number>/locations/<location>/aspectTypes/<aspect_type_id>"
repeated string aspect_types = 5 [(.google.api.resource_reference) = { ... }
public MetadataJob.ExportJobSpec.ExportJobScope getDefaultInstanceForType()
getEntryGroups(int index)
public String getEntryGroups(int index)
The entry groups that are in scope for the export job. Optional. If
specified, only entries in the specified entry groups will be exported
by the job. Must be in the VPC-SC perimeter of the job. The location of
the entry groups must be the same as the job. Either projects or
entry_groups can be specified when organization_level_export is set to
false. Must follow the format:
"projects/<project_id_or_number>/locations/<location>/entryGroups/<entry_group_id>"
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 that are in scope for the export job. Optional. If
specified, only entries in the specified entry groups will be exported
by the job. Must be in the VPC-SC perimeter of the job. The location of
the entry groups must be the same as the job. Either projects or
entry_groups can be specified when organization_level_export is set to
false. Must follow the format:
"projects/<project_id_or_number>/locations/<location>/entryGroups/<entry_group_id>"
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 that are in scope for the export job. Optional. If
specified, only entries in the specified entry groups will be exported
by the job. Must be in the VPC-SC perimeter of the job. The location of
the entry groups must be the same as the job. Either projects or
entry_groups can be specified when organization_level_export is set to
false. Must follow the format:
"projects/<project_id_or_number>/locations/<location>/entryGroups/<entry_group_id>"
repeated string entry_groups = 3 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
int |
The count of entryGroups.
|
getEntryGroupsList()
public ProtocolStringList getEntryGroupsList()
The entry groups that are in scope for the export job. Optional. If
specified, only entries in the specified entry groups will be exported
by the job. Must be in the VPC-SC perimeter of the job. The location of
the entry groups must be the same as the job. Either projects or
entry_groups can be specified when organization_level_export is set to
false. Must follow the format:
"projects/<project_id_or_number>/locations/<location>/entryGroups/<entry_group_id>"
repeated string entry_groups = 3 [(.google.api.resource_reference) = { ... }
getEntryTypes(int index)
public String getEntryTypes(int index)
If specified, only entries of the specified types will be
affected by the job.
Must follow the format:
"projects/<project_id_or_number>/locations/<location>/entryTypes/<entry_type_id>"
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)
If specified, only entries of the specified types will be
affected by the job.
Must follow the format:
"projects/<project_id_or_number>/locations/<location>/entryTypes/<entry_type_id>"
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()
If specified, only entries of the specified types will be
affected by the job.
Must follow the format:
"projects/<project_id_or_number>/locations/<location>/entryTypes/<entry_type_id>"
repeated string entry_types = 4 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
int |
The count of entryTypes.
|
getEntryTypesList()
public ProtocolStringList getEntryTypesList()
If specified, only entries of the specified types will be
affected by the job.
Must follow the format:
"projects/<project_id_or_number>/locations/<location>/entryTypes/<entry_type_id>"
repeated string entry_types = 4 [(.google.api.resource_reference) = { ... }
public boolean getOrganizationLevel()
Indicating if it is an organization level export job.
- When set to true, exports all entries from entry groups and projects
sharing the same organization id of the Metadata Job. Only projects and
entry groups in the VPC-SC perimeter will be exported. The projects and
entry groups are ignored.
- When set to false, one of the projects or entry groups must be
specified.
- Default to false.
bool organization_level = 1;
| Returns |
| Type |
Description |
boolean |
The organizationLevel.
|
public Parser<MetadataJob.ExportJobSpec.ExportJobScope> getParserForType()
Overrides
public String getProjects(int index)
The projects that are in the scope of the export job. Can either be
project numbers or project IDs. If specified, only the entries from the
specified projects will be exported. The projects must be in the same
organization and in the VPC-SC perimeter. Either projects or
entry_groups can be specified when organization_level_export is set to
false.
Must follow the format: "projects/<project_id_or_number>"
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.
|
public ByteString getProjectsBytes(int index)
The projects that are in the scope of the export job. Can either be
project numbers or project IDs. If specified, only the entries from the
specified projects will be exported. The projects must be in the same
organization and in the VPC-SC perimeter. Either projects or
entry_groups can be specified when organization_level_export is set to
false.
Must follow the format: "projects/<project_id_or_number>"
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.
|
public int getProjectsCount()
The projects that are in the scope of the export job. Can either be
project numbers or project IDs. If specified, only the entries from the
specified projects will be exported. The projects must be in the same
organization and in the VPC-SC perimeter. Either projects or
entry_groups can be specified when organization_level_export is set to
false.
Must follow the format: "projects/<project_id_or_number>"
repeated string projects = 2 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
int |
The count of projects.
|
public ProtocolStringList getProjectsList()
The projects that are in the scope of the export job. Can either be
project numbers or project IDs. If specified, only the entries from the
specified projects will be exported. The projects must be in the same
organization and in the VPC-SC perimeter. Either projects or
entry_groups can be specified when organization_level_export is set to
false.
Must follow the format: "projects/<project_id_or_number>"
repeated string projects = 2 [(.google.api.resource_reference) = { ... }
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public MetadataJob.ExportJobSpec.ExportJobScope.Builder newBuilderForType()
protected MetadataJob.ExportJobSpec.ExportJobScope.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public MetadataJob.ExportJobSpec.ExportJobScope.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
