Interface MetadataJob.ExportJobSpec.ExportJobScopeOrBuilder (1.61.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, 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the aspectTypes.

getEntryGroups(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the entryGroups.

getEntryTypes(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the entryTypes.

getOrganizationLevel()

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

getProjects(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the projects.