Package org.opensearch.common.remote

Class RemoteWriteableBlobEntity<T>

java.lang.Object
org.opensearch.common.remote.RemoteWriteableBlobEntity<T>
Type Parameters:
T - the entity to be written
All Implemented Interfaces:
RemoteWriteableEntity<T>
Direct Known Subclasses:
AbstractClusterMetadataWriteableBlobEntity
public abstract class RemoteWriteableBlobEntity<T> extends Object implements RemoteWriteableEntity<T>
The abstract class which represents a RemoteWriteableEntity that can be written to a store

  • Field Details

    • blobFileName

      protected String blobFileName

    • blobName

      protected String blobName

  • Constructor Details

    • RemoteWriteableBlobEntity

      public RemoteWriteableBlobEntity(String clusterUUID, org.opensearch.core.compress.Compressor compressor)

  • Method Details

    • getBlobPathParameters

      public abstract BlobPathParameters getBlobPathParameters()

    • getType

      public abstract String getType()

    • getFullBlobName

      public String getFullBlobName()

    • getBlobFileName

      public String getBlobFileName()

    • getBlobPathTokens

      public String[] getBlobPathTokens()

    • generateBlobFileName

      public abstract String generateBlobFileName()

    • getPrefixedPath

      public BlobPath getPrefixedPath(BlobPath blobPath)
      Generate the blob path for the remote entity by adding a custom prefix. This custom prefix may be generated by any of the strategies defined in RemoteStoreEnums The default implementation returns the same path as passed in the argument.
      Parameters:
      blobPath - The remote path on which the remote entity is to be uploaded
      Returns:
      The modified remote path after adding a custom prefix at which the remote entity will be uploaded.

    • clusterUUID

      public String clusterUUID()

    • setFullBlobName

      public void setFullBlobName(BlobPath blobPath)

    • getCompressor

      protected org.opensearch.core.compress.Compressor getCompressor()