Package io.kestra.core.storages

Interface StorageInterface

@Introspected
public interface StorageInterface

Method Summary

Modifier and Type	Method	Description
default String	cachePrefix(String namespace, String flowId, String taskId, String value)
URI	createDirectory(String tenantId, URI uri)
boolean	delete(String tenantId, URI uri)
List<URI>	deleteByPrefix(String tenantId, URI storagePrefix)
default String	executionPrefix(Execution execution)
default String	executionPrefix(TaskRun taskRun)
default String	executionPrefix(Flow flow, Execution execution)
default boolean	exists(String tenantId, URI uri)	Whether the uri points to a file/object that exist in the internal storage.
default Optional<String>	extractExecutionId(URI path)
default URI	from(Flow flow, Execution execution, Input<?> input, File file)
default URI	from(Flow flow, Execution execution, String input, File file)
InputStream	get(String tenantId, URI uri)
FileAttributes	getAttributes(String tenantId, URI uri)
Long	lastModifiedTime(String tenantId, URI uri)	Deprecated. Use getAttributes(String, URI) instead of individual call for every attribute
List<FileAttributes>	list(String tenantId, URI uri)
URI	move(String tenantId, URI from, URI to)
default String	namespaceFilePrefix(String namespace)
default URI	outputPrefix(Flow flow)
default URI	outputPrefix(Flow flow, Task task, Execution execution, TaskRun taskRun)
default URI	outputPrefix(TriggerContext triggerContext, AbstractTrigger trigger, String triggerExecutionId)
URI	put(String tenantId, URI uri, InputStream data)
Long	size(String tenantId, URI uri)	Deprecated. Use getAttributes(String, URI)} instead of individual call for every attribute
default String	statePrefix(String namespace, String flowId, String name, String value)
default URI	uri(Flow flow, Execution execution, String inputName, String file)

Method Details

get

@Retryable(includes=java.io.IOException.class,
           excludes=java.io.FileNotFoundException.class)
InputStream get(String tenantId,
 URI uri)
         throws IOException

Throws:

IOException

list

@Retryable(includes=java.io.IOException.class,
           excludes=java.io.FileNotFoundException.class)
List<FileAttributes> list(String tenantId,
 URI uri)
                   throws IOException

Throws:

IOException

exists

default boolean exists(String tenantId,
 URI uri)

Whether the uri points to a file/object that exist in the internal storage.

Parameters:

uri - the URI of the file/object in the internal storage.

tenantId - the tenant identifier.

Returns:

true if the uri points to a file/object that exist in the internal storage.

size

@Deprecated
@Retryable(includes=java.io.IOException.class,
           excludes=java.io.FileNotFoundException.class)
Long size(String tenantId,
 URI uri)
   throws IOException

Deprecated.

Use getAttributes(String, URI)} instead of individual call for every attribute

Throws:

IOException

lastModifiedTime

@Deprecated
@Retryable(includes=java.io.IOException.class,
           excludes=java.io.FileNotFoundException.class)
Long lastModifiedTime(String tenantId,
 URI uri)
               throws IOException

Deprecated.

Use getAttributes(String, URI) instead of individual call for every attribute

Throws:

IOException

getAttributes

@Retryable(includes=java.io.IOException.class,
           excludes=java.io.FileNotFoundException.class)
FileAttributes getAttributes(String tenantId,
 URI uri)
                      throws IOException

Throws:

IOException

put

@Retryable(includes=java.io.IOException.class)
URI put(String tenantId,
 URI uri,
 InputStream data)
 throws IOException

Throws:

IOException

delete

@Retryable(includes=java.io.IOException.class)
boolean delete(String tenantId,
 URI uri)
        throws IOException

Throws:

IOException

createDirectory

@Retryable(includes=java.io.IOException.class)
URI createDirectory(String tenantId,
 URI uri)
             throws IOException

Throws:

IOException

move

@Retryable(includes=java.io.IOException.class,
           excludes=java.io.FileNotFoundException.class)
URI move(String tenantId,
 URI from,
 URI to)
  throws IOException

Throws:

IOException

deleteByPrefix

@Retryable(includes=java.io.IOException.class)
List<URI> deleteByPrefix(String tenantId,
 URI storagePrefix)
                  throws IOException

Throws:

IOException

executionPrefix

default String executionPrefix(Flow flow,
 Execution execution)

executionPrefix

default String executionPrefix(Execution execution)

executionPrefix

default String executionPrefix(TaskRun taskRun)

statePrefix

default String statePrefix(String namespace,
 @Nullable
 String flowId,
 @Nullable
 String name,
 @Nullable
 String value)

cachePrefix

default String cachePrefix(String namespace,
 String flowId,
 String taskId,
 @Nullable
 String value)

namespaceFilePrefix

default String namespaceFilePrefix(String namespace)

extractExecutionId

default Optional<String> extractExecutionId(URI path)

uri

default URI uri(Flow flow,
 Execution execution,
 String inputName,
 String file)
         throws URISyntaxException

Throws:

URISyntaxException

from

@Retryable(includes=java.io.IOException.class)
default URI from(Flow flow,
 Execution execution,
 String input,
 File file)
          throws IOException

Throws:

IOException

from

@Retryable(includes=java.io.IOException.class)
default URI from(Flow flow,
 Execution execution,
 Input<?> input,
 File file)
          throws IOException

Throws:

IOException

outputPrefix

default URI outputPrefix(Flow flow)

outputPrefix

default URI outputPrefix(Flow flow,
 Task task,
 Execution execution,
 TaskRun taskRun)

outputPrefix

default URI outputPrefix(TriggerContext triggerContext,
 AbstractTrigger trigger,
 String triggerExecutionId)