com.google.cloud.tools.jib.api

Class LayerConfiguration.Builder

java.lang.Object

com.google.cloud.tools.jib.api.LayerConfiguration.Builder

Enclosing class:

LayerConfiguration

public static class LayerConfiguration.Builder
extends Object

Builds a LayerConfiguration.

Method Summary

Modifier and Type	Method and Description
LayerConfiguration.Builder	addEntry(LayerEntry entry) Adds an entry to the layer.
LayerConfiguration.Builder	addEntry(Path sourceFile, AbsoluteUnixPath pathInContainer) Adds an entry to the layer.
LayerConfiguration.Builder	addEntry(Path sourceFile, AbsoluteUnixPath pathInContainer, FilePermissions permissions) Adds an entry to the layer with the given permissions.
LayerConfiguration.Builder	addEntry(Path sourceFile, AbsoluteUnixPath pathInContainer, FilePermissions permissions, Instant modificationTime) Adds an entry to the layer with the given permissions and file modification time.
LayerConfiguration.Builder	addEntry(Path sourceFile, AbsoluteUnixPath pathInContainer, Instant modificationTime) Adds an entry to the layer with the given file modification time.
LayerConfiguration.Builder	addEntryRecursive(Path sourceFile, AbsoluteUnixPath pathInContainer) Adds an entry to the layer.
LayerConfiguration.Builder	addEntryRecursive(Path sourceFile, AbsoluteUnixPath pathInContainer, BiFunction<Path,AbsoluteUnixPath,FilePermissions> filePermissionProvider) Adds an entry to the layer.
LayerConfiguration.Builder	addEntryRecursive(Path sourceFile, AbsoluteUnixPath pathInContainer, BiFunction<Path,AbsoluteUnixPath,FilePermissions> filePermissionProvider, BiFunction<Path,AbsoluteUnixPath,Instant> modificationTimeProvider) Adds an entry to the layer.
LayerConfiguration	build() Returns the built LayerConfiguration.
LayerConfiguration.Builder	setName(String name) Sets a name for this layer.

Methods inherited from class java.lang.Object

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

Method Detail

setName

public LayerConfiguration.Builder setName(String name)

Sets a name for this layer. This name does not affect the contents of the layer.

Parameters:

name - the name

Returns:

this

addEntry

public LayerConfiguration.Builder addEntry(LayerEntry entry)

Adds an entry to the layer.

Parameters:

entry - the layer entry to add

Returns:

this

addEntry

public LayerConfiguration.Builder addEntry(Path sourceFile,
                                           AbsoluteUnixPath pathInContainer)

Adds an entry to the layer. Only adds the single source file to the exact path in the container file system.

For example, addEntry(Paths.get("myfile"), AbsoluteUnixPath.get("/path/in/container")) adds a file myfile to the container file system at /path/in/container.

For example, addEntry(Paths.get("mydirectory"), AbsoluteUnixPath.get("/path/in/container")) adds a directory mydirectory/ to the container file system at /path/in/container/. This does not add the contents of mydirectory.

Parameters:

sourceFile - the source file to add to the layer

pathInContainer - the path in the container file system corresponding to the sourceFile

Returns:

this

addEntry

public LayerConfiguration.Builder addEntry(Path sourceFile,
                                           AbsoluteUnixPath pathInContainer,
                                           FilePermissions permissions)

Adds an entry to the layer with the given permissions. Only adds the single source file to the exact path in the container file system. See addEntry(Path, AbsoluteUnixPath) for more information.

Parameters:

sourceFile - the source file to add to the layer

pathInContainer - the path in the container file system corresponding to the sourceFile

permissions - the file permissions on the container

Returns:

this

See Also:

addEntry(Path, AbsoluteUnixPath), FilePermissions.DEFAULT_FILE_PERMISSIONS, FilePermissions.DEFAULT_FOLDER_PERMISSIONS

addEntry

public LayerConfiguration.Builder addEntry(Path sourceFile,
                                           AbsoluteUnixPath pathInContainer,
                                           Instant modificationTime)

Adds an entry to the layer with the given file modification time. Only adds the single source file to the exact path in the container file system. See addEntry(Path, AbsoluteUnixPath) for more information.

Parameters:

sourceFile - the source file to add to the layer

pathInContainer - the path in the container file system corresponding to the sourceFile

modificationTime - the file modification time

Returns:

this

See Also:

addEntry(Path, AbsoluteUnixPath)

addEntry

public LayerConfiguration.Builder addEntry(Path sourceFile,
                                           AbsoluteUnixPath pathInContainer,
                                           FilePermissions permissions,
                                           Instant modificationTime)

Adds an entry to the layer with the given permissions and file modification time. Only adds the single source file to the exact path in the container file system. See addEntry(Path, AbsoluteUnixPath) for more information.

Parameters:

sourceFile - the source file to add to the layer

pathInContainer - the path in the container file system corresponding to the sourceFile

permissions - the file permissions on the container

modificationTime - the file modification time

Returns:

this

See Also:

addEntry(Path, AbsoluteUnixPath), FilePermissions.DEFAULT_FILE_PERMISSIONS, FilePermissions.DEFAULT_FOLDER_PERMISSIONS

addEntryRecursive

public LayerConfiguration.Builder addEntryRecursive(Path sourceFile,
                                                    AbsoluteUnixPath pathInContainer)
                                             throws IOException

Adds an entry to the layer. If the source file is a directory, the directory and its contents will be added recursively.

For example, addEntryRecursive(Paths.get("mydirectory", AbsoluteUnixPath.get("/path/in/container")) adds mydirectory to the container file system at /path/in/container such that mydirectory/subfile is found at /path/in/container/subfile.

Parameters:

sourceFile - the source file to add to the layer recursively

pathInContainer - the path in the container file system corresponding to the sourceFile

Returns:

this

Throws:

IOException - if an exception occurred when recursively listing the directory

addEntryRecursive

public LayerConfiguration.Builder addEntryRecursive(Path sourceFile,
                                                    AbsoluteUnixPath pathInContainer,
                                                    BiFunction<Path,AbsoluteUnixPath,FilePermissions> filePermissionProvider)
                                             throws IOException

Adds an entry to the layer. If the source file is a directory, the directory and its contents will be added recursively.

Parameters:

sourceFile - the source file to add to the layer recursively

pathInContainer - the path in the container file system corresponding to the sourceFile

filePermissionProvider - a provider that takes a source path and destination path on the container and returns the file permissions that should be set for that path

Returns:

this

Throws:

IOException - if an exception occurred when recursively listing the directory

addEntryRecursive

public LayerConfiguration.Builder addEntryRecursive(Path sourceFile,
                                                    AbsoluteUnixPath pathInContainer,
                                                    BiFunction<Path,AbsoluteUnixPath,FilePermissions> filePermissionProvider,
                                                    BiFunction<Path,AbsoluteUnixPath,Instant> modificationTimeProvider)
                                             throws IOException

Adds an entry to the layer. If the source file is a directory, the directory and its contents will be added recursively.

Parameters:

sourceFile - the source file to add to the layer recursively

pathInContainer - the path in the container file system corresponding to the sourceFile

filePermissionProvider - a provider that takes a source path and destination path on the container and returns the file permissions that should be set for that path

modificationTimeProvider - a provider that takes a source path and destination path on the container and returns the file modification time that should be set for that path

Returns:

this

Throws:

IOException - if an exception occurred when recursively listing the directory

build

public LayerConfiguration build()

Returns the built LayerConfiguration.

Returns:

the built LayerConfiguration