Package org.elasticsearch.index.snapshots.blobstore

Class BlobStoreIndexShardSnapshot.FileInfo

java.lang.Object
org.elasticsearch.index.snapshots.blobstore.BlobStoreIndexShardSnapshot.FileInfo
Enclosing class:
BlobStoreIndexShardSnapshot
public static class BlobStoreIndexShardSnapshot.FileInfo
extends java.lang.Object
Information about snapshotted file

  • Constructor Summary

    Constructors
    Constructor Description
    FileInfo​(java.lang.String name, StoreFileMetadata metadata, ByteSizeValue partSize)
    Constructs a new instance of file info

  • Method Summary

    Modifier and Type Method Description
    static java.lang.String canonicalName​(java.lang.String blobName)
    Returns base file name from part name
    java.lang.String checksum()
    Returns file md5 checksum provided by Store
    static BlobStoreIndexShardSnapshot.FileInfo fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
    Parses JSON that represents file info
    boolean isSame​(BlobStoreIndexShardSnapshot.FileInfo fileInfo)
    Checks if a file in a store is the same file
    boolean isSame​(StoreFileMetadata md)
    Checks if a file in a store is the same file
    long length()
    File length
    StoreFileMetadata metadata()
    Returns the StoreFileMetadata for this file info.
    java.lang.String name()
    Returns the base file name
    int numberOfParts()
    Returns number of parts
    long partBytes​(int part)
    Returns the size (in bytes) of a given part
    java.lang.String partName​(int part)
    Returns part name if file is stored as multiple parts
    ByteSizeValue partSize()
    Returns part size
    java.lang.String physicalName()
    Returns original file name
    java.lang.String toString()  
    static void toXContent​(BlobStoreIndexShardSnapshot.FileInfo file, org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
    Serializes file info into JSON

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • FileInfo

      public FileInfo​(java.lang.String name, StoreFileMetadata metadata, ByteSizeValue partSize)
      Constructs a new instance of file info
      Parameters:
      name - file name as stored in the blob store
      metadata - the files meta data
      partSize - size of the single chunk

  • Method Details

    • name

      public java.lang.String name()
      Returns the base file name
      Returns:
      file name

    • partName

      public java.lang.String partName​(int part)
      Returns part name if file is stored as multiple parts
      Parameters:
      part - part number
      Returns:
      part name

    • canonicalName

      public static java.lang.String canonicalName​(java.lang.String blobName)
      Returns base file name from part name
      Parameters:
      blobName - part name
      Returns:
      base file name

    • physicalName

      public java.lang.String physicalName()
      Returns original file name
      Returns:
      original file name

    • length

      public long length()
      File length
      Returns:
      file length

    • partSize

      public ByteSizeValue partSize()
      Returns part size
      Returns:
      part size

    • partBytes

      public long partBytes​(int part)
      Returns the size (in bytes) of a given part
      Returns:
      the size (in bytes) of a given part

    • numberOfParts

      public int numberOfParts()
      Returns number of parts
      Returns:
      number of parts

    • checksum

      public java.lang.String checksum()
      Returns file md5 checksum provided by Store
      Returns:
      file checksum

    • metadata

      public StoreFileMetadata metadata()
      Returns the StoreFileMetadata for this file info.

    • isSame

      public boolean isSame​(StoreFileMetadata md)
      Checks if a file in a store is the same file
      Parameters:
      md - file in a store
      Returns:
      true if file in a store this this file have the same checksum and length

    • isSame

      public boolean isSame​(BlobStoreIndexShardSnapshot.FileInfo fileInfo)
      Checks if a file in a store is the same file
      Parameters:
      fileInfo - file in a store
      Returns:
      true if file in a store this this file have the same checksum and length

    • toXContent

      public static void toXContent​(BlobStoreIndexShardSnapshot.FileInfo file, org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Serializes file info into JSON
      Parameters:
      file - file info
      builder - XContent builder
      params - parameters
      Throws:
      java.io.IOException

    • fromXContent

      public static BlobStoreIndexShardSnapshot.FileInfo fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Parses JSON that represents file info
      Parameters:
      parser - parser
      Returns:
      file info
      Throws:
      java.io.IOException

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object