Interface MetadataJob.ExportJobSpec.ExportJobScopeOrBuilder (1.60.0)

public static interface MetadataJob.ExportJobSpec.ExportJobScopeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAspectTypes(int index)

public abstract 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.

getAspectTypesBytes(int index)

public abstract 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.

getAspectTypesCount()

public abstract 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.

getAspectTypesList()

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

Returns
Type Description
List<String>

A list containing the aspectTypes.

getEntryGroups(int index)

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

Returns
Type Description
List<String>

A list containing the entryGroups.

getEntryTypes(int index)

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

Returns
Type Description
List<String>

A list containing the entryTypes.

getOrganizationLevel()

public abstract 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.

getProjects(int index)

public abstract 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.

getProjectsBytes(int index)

public abstract 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.

getProjectsCount()

public abstract 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.

getProjectsList()

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

Returns
Type Description
List<String>

A list containing the projects.