Package io.micronaut.objectstorage.local

Class LocalStorageConfiguration

java.lang.Object
io.micronaut.objectstorage.configuration.AbstractObjectStorageModuleConfiguration
io.micronaut.objectstorage.configuration.AbstractObjectStorageConfiguration
io.micronaut.objectstorage.local.LocalStorageConfiguration
All Implemented Interfaces:
io.micronaut.core.naming.Named, io.micronaut.core.util.Toggleable, io.micronaut.objectstorage.configuration.ObjectStorageConfiguration, io.micronaut.objectstorage.configuration.ObjectStorageModuleConfiguration
@EachProperty("micronaut.object-storage.local") public class LocalStorageConfiguration extends io.micronaut.objectstorage.configuration.AbstractObjectStorageConfiguration
Configuration class for local storage.
Since:
2.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
     
    static final String
    PREFIX
     

    Fields inherited from class io.micronaut.objectstorage.configuration.AbstractObjectStorageConfiguration

    name

    Fields inherited from class io.micronaut.objectstorage.configuration.AbstractObjectStorageModuleConfiguration

    enabled

    Fields inherited from interface io.micronaut.objectstorage.configuration.ObjectStorageModuleConfiguration

    DEFAULT_ENABLED

  • Constructor Summary

    Constructors
    Constructor
    Description
    LocalStorageConfiguration(String name)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull Path
    getPath()
    The path of the local storage.
    boolean
    isEnabled()
    Whether to enable or disable this object storage.
    void
    setPath(@NonNull Path path)
     

    Methods inherited from class io.micronaut.objectstorage.configuration.AbstractObjectStorageConfiguration

    getName

    Methods inherited from class io.micronaut.objectstorage.configuration.AbstractObjectStorageModuleConfiguration

    setEnabled

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • LocalStorageConfiguration

      public LocalStorageConfiguration(@Parameter String name)

  • Method Details

    • getPath

      @NonNull public @NonNull Path getPath()
      The path of the local storage.
      Returns:
      The path of the local storage.

    • setPath

      public void setPath(@NonNull @NonNull Path path)
      Parameters:
      path - The path of the local storage.

    • isEnabled

      public boolean isEnabled()
      Whether to enable or disable this object storage.
      Since:
      2.0.2