Package org.opensearch.repositories

Class RepositoryData

java.lang.Object
org.opensearch.repositories.RepositoryData
public final class RepositoryData extends Object
A class that represents the data in a repository, as captured in the repository's index blob.
Opensearch.internal:

  • Field Details

    • EMPTY_REPO_GEN

      public static final long EMPTY_REPO_GEN
      The generation value indicating the repository has no index generational files.
      See Also:

    • UNKNOWN_REPO_GEN

      public static final long UNKNOWN_REPO_GEN
      The generation value indicating that the repository generation is unknown.
      See Also:

    • CORRUPTED_REPO_GEN

      public static final long CORRUPTED_REPO_GEN
      The generation value indicating that the repository generation could not be determined.
      See Also:

    • EMPTY

      public static final RepositoryData EMPTY
      An instance initialized for an empty repository.

  • Constructor Details

  • Method Details

    • copy

      protected RepositoryData copy()

    • withVersions

      public RepositoryData withVersions(Map<SnapshotId,Version> versions)
      Creates a copy of this instance that contains updated version data.
      Parameters:
      versions - map of snapshot versions
      Returns:
      copy with updated version data

    • shardGenerations

      public ShardGenerations shardGenerations()

    • getGenId

      public long getGenId()
      Gets the generational index file id from which this instance was read.

    • getSnapshotIds

      public Collection<SnapshotId> getSnapshotIds()
      Returns an unmodifiable collection of the snapshot ids.

    • getSnapshotState

      @Nullable public SnapshotState getSnapshotState(SnapshotId snapshotId)
      Returns the SnapshotState for the given snapshot. Returns null if there is no state for the snapshot.

    • getVersion

      @Nullable public Version getVersion(SnapshotId snapshotId)
      Returns the Version for the given snapshot or null if unknown.

    • getIndices

      public Map<String,IndexId> getIndices()
      Returns an unmodifiable map of the index names to IndexId in the repository.

    • indicesToUpdateAfterRemovingSnapshot

      public List<IndexId> indicesToUpdateAfterRemovingSnapshot(Collection<SnapshotId> snapshotIds)
      Returns the list of IndexId that have their snapshots updated but not removed (because they are still referenced by other snapshots) after removing the given snapshot from the repository.
      Parameters:
      snapshotIds - SnapshotId to remove
      Returns:
      List of indices that are changed but not removed

    • indexMetaDataToRemoveAfterRemovingSnapshots

      public Map<IndexId,Collection<String>> indexMetaDataToRemoveAfterRemovingSnapshots(Collection<SnapshotId> snapshotIds)
      Returns a map of IndexId to a collection of String containing all the IndexId and the IndexMetadata blob name in it that can be removed after removing the given snapshot from the repository. NOTE: Does not return a mapping for IndexId values that will be removed completely from the repository.
      Parameters:
      snapshotIds - SnapshotIds to remove
      Returns:
      map of index to index metadata blob id to delete

    • addSnapshot

      public RepositoryData addSnapshot(SnapshotId snapshotId, SnapshotState snapshotState, Version version, ShardGenerations shardGenerations, @Nullable Map<IndexId,String> indexMetaBlobs, @Nullable Map<String,String> newIdentifiers)
      Add a snapshot and its indices to the repository; returns a new instance. If the snapshot already exists in the repository data, this method throws an IllegalArgumentException.
      Parameters:
      snapshotId - Id of the new snapshot
      snapshotState - State of the new snapshot
      shardGenerations - Updated shard generations in the new snapshot. For each index contained in the snapshot an array of new generations indexed by the shard id they correspond to must be supplied.
      indexMetaBlobs - Map of index metadata blob uuids
      newIdentifiers - Map of new index metadata blob uuids keyed by the identifiers of the IndexMetadata in them

    • withGenId

      public RepositoryData withGenId(long newGeneration)
      Create a new instance with the given generation and all other fields equal to this instance.
      Parameters:
      newGeneration - New Generation
      Returns:
      New instance

    • removeSnapshots

      public RepositoryData removeSnapshots(Collection<SnapshotId> snapshots, ShardGenerations updatedShardGenerations)
      Remove snapshots and remove any indices that no longer exist in the repository due to the deletion of the snapshots.
      Parameters:
      snapshots - Snapshot ids to remove
      updatedShardGenerations - Shard generations that changed as a result of removing the snapshot. The String[] passed for each IndexId contains the new shard generation id for each changed shard indexed by its shardId

    • getSnapshots

      public List<SnapshotId> getSnapshots(IndexId indexId)
      Returns an immutable collection of the snapshot ids for the snapshots that contain the given index.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • resolveIndexId

      public IndexId resolveIndexId(String indexName)
      Resolve the index name to the index id specific to the repository, throwing an exception if the index could not be resolved.

    • resolveIndices

      public List<IndexId> resolveIndices(List<String> indices)
      Resolve the given index names to index ids.

    • resolveNewIndices

      public List<IndexId> resolveNewIndices(List<String> indicesToResolve, Map<String,IndexId> inFlightIds)
      Resolve the given index names to index ids, creating new index ids for new indices in the repository.
      Parameters:
      indicesToResolve - names of indices to resolve
      inFlightIds - name to index mapping for currently in-flight snapshots not yet in the repository data to fall back to

    • snapshotsToXContent

      public org.opensearch.common.xcontent.XContentBuilder snapshotsToXContent(org.opensearch.common.xcontent.XContentBuilder builder, Version repoMetaVersion) throws IOException
      Writes the snapshots metadata and the related indices metadata to x-content.
      Throws:
      IOException

    • indexMetaDataGenerations

      public IndexMetaDataGenerations indexMetaDataGenerations()

    • snapshotsFromXContent

      public static RepositoryData snapshotsFromXContent(org.opensearch.common.xcontent.XContentParser parser, long genId, boolean fixBrokenShardGens) throws IOException
      Reads an instance of RepositoryData from x-content, loading the snapshots and indices metadata.
      Parameters:
      fixBrokenShardGens - set to true to filter out broken shard generations read from the parser via ShardGenerations.fixShardGeneration(java.lang.String). Used to disable fixing broken generations when reading from cached bytes that we trust to not contain broken generations.
      Throws:
      IOException