Interface VitamResourceMetadata<T extends java.lang.Enum<T>>

  • Type Parameters:
    T - the VitamResourceMetadata
    All Superinterfaces:
    java.lang.Comparable<VitamResourceMetadata<T>>
    All Known Subinterfaces:
    VitamStorageMetadata

    public interface VitamResourceMetadata<T extends java.lang.Enum<T>>
    extends java.lang.Comparable<VitamResourceMetadata<T>>
    VitamResourceMetadata interface describing a resource metadata
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Location getLocation()
      Physical location of the resource, or null if n/a
      java.lang.String getName()
      Name of this resource.
      java.lang.String getProviderId()
      Unique identifier of this resource within its enclosing namespace.
      T getType()
      Whether this resource is a container, file, node, queue, etc.
      java.net.URI getUri()
      URI used to access this resource
      java.util.Map<java.lang.String,​java.lang.String> getUserMetadata()
      Any key-value pairs associated with the resource.
      • Methods inherited from interface java.lang.Comparable

        compareTo
    • Method Detail

      • getType

        T getType()
        Whether this resource is a container, file, node, queue, etc.
      • getProviderId

        java.lang.String getProviderId()
        Unique identifier of this resource within its enclosing namespace. In some scenarios, this id is not user assignable. For files, this may be an system generated key, or the full path to the resource. ex. /path/to/file.txt
      • getName

        java.lang.String getName()
        Name of this resource. Names are dictated by the user. For files, this may be the filename, ex. file.txt
      • getLocation

        Location getLocation()
        Physical location of the resource, or null if n/a

        ex. us-west-1

      • getUri

        java.net.URI getUri()
        URI used to access this resource
      • getUserMetadata

        java.util.Map<java.lang.String,​java.lang.String> getUserMetadata()
        Any key-value pairs associated with the resource.