com.google.cloud.tools.jib.api.buildplan

Class FileEntriesLayer.Builder

java.lang.Object

com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder

Enclosing class:

FileEntriesLayer

public static class FileEntriesLayer.Builder
extends java.lang.Object

Builds a FileEntriesLayer.

Method Summary

Modifier and Type	Method and Description
FileEntriesLayer.Builder	addEntry(FileEntry entry) Adds an entry to the layer.
FileEntriesLayer.Builder	addEntry(java.nio.file.Path sourceFile, AbsoluteUnixPath pathInContainer) Adds an entry to the layer.
FileEntriesLayer.Builder	addEntry(java.nio.file.Path sourceFile, AbsoluteUnixPath pathInContainer, FilePermissions permissions) Adds an entry to the layer with the given permissions.
FileEntriesLayer.Builder	addEntry(java.nio.file.Path sourceFile, AbsoluteUnixPath pathInContainer, FilePermissions permissions, java.time.Instant modificationTime) Adds an entry to the layer with the given permissions and file modification time.
FileEntriesLayer.Builder	addEntry(java.nio.file.Path sourceFile, AbsoluteUnixPath pathInContainer, FilePermissions permissions, java.time.Instant modificationTime, java.lang.String ownership) Adds an entry to the layer with the given permissions and file modification time.
FileEntriesLayer.Builder	addEntry(java.nio.file.Path sourceFile, AbsoluteUnixPath pathInContainer, java.time.Instant modificationTime) Adds an entry to the layer with the given file modification time.
FileEntriesLayer.Builder	addEntryRecursive(java.nio.file.Path sourceFile, AbsoluteUnixPath pathInContainer) Adds an entry to the layer.
FileEntriesLayer.Builder	addEntryRecursive(java.nio.file.Path sourceFile, AbsoluteUnixPath pathInContainer, FilePermissionsProvider filePermissionProvider) Adds an entry to the layer.
FileEntriesLayer.Builder	addEntryRecursive(java.nio.file.Path sourceFile, AbsoluteUnixPath pathInContainer, FilePermissionsProvider filePermissionProvider, ModificationTimeProvider modificationTimeProvider) Adds an entry to the layer.
FileEntriesLayer.Builder	addEntryRecursive(java.nio.file.Path sourceFile, AbsoluteUnixPath pathInContainer, FilePermissionsProvider filePermissionProvider, ModificationTimeProvider modificationTimeProvider, OwnershipProvider ownershipProvider) Adds an entry to the layer.
FileEntriesLayer	build() Returns the built FileEntriesLayer.
FileEntriesLayer.Builder	setEntries(java.util.List<FileEntry> entries) Sets entries for the layer.
FileEntriesLayer.Builder	setName(java.lang.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 FileEntriesLayer.Builder setName(java.lang.String name)

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

Parameters:

name - the name

Returns:

this

setEntries

public FileEntriesLayer.Builder setEntries(java.util.List<FileEntry> entries)

Sets entries for the layer.

Parameters:

entries - file entries in the layer

Returns:

this

addEntry

public FileEntriesLayer.Builder addEntry(FileEntry entry)

Adds an entry to the layer.

Parameters:

entry - the layer entry to add

Returns:

this

addEntry

public FileEntriesLayer.Builder addEntry(java.nio.file.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 FileEntriesLayer.Builder addEntry(java.nio.file.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 FileEntriesLayer.Builder addEntry(java.nio.file.Path sourceFile,
                                         AbsoluteUnixPath pathInContainer,
                                         java.time.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 FileEntriesLayer.Builder addEntry(java.nio.file.Path sourceFile,
                                         AbsoluteUnixPath pathInContainer,
                                         FilePermissions permissions,
                                         java.time.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

addEntry

public FileEntriesLayer.Builder addEntry(java.nio.file.Path sourceFile,
                                         AbsoluteUnixPath pathInContainer,
                                         FilePermissions permissions,
                                         java.time.Instant modificationTime,
                                         java.lang.String ownership)

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

ownership - file ownership. For example, "1234", "user", ":5678", ":group", "1234:5678", and "user:group". Note that "" (empty string), ":" (single colon), "0:", ":0" are allowed and representative of "0:0" or "root:root", but prefer an empty string for "0:0".

Returns:

this

See Also:

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

addEntryRecursive

public FileEntriesLayer.Builder addEntryRecursive(java.nio.file.Path sourceFile,
                                                  AbsoluteUnixPath pathInContainer)
                                           throws java.io.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:

java.io.IOException - if an exception occurred when recursively listing the directory

addEntryRecursive

public FileEntriesLayer.Builder addEntryRecursive(java.nio.file.Path sourceFile,
                                                  AbsoluteUnixPath pathInContainer,
                                                  FilePermissionsProvider filePermissionProvider)
                                           throws java.io.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:

java.io.IOException - if an exception occurred when recursively listing the directory

addEntryRecursive

public FileEntriesLayer.Builder addEntryRecursive(java.nio.file.Path sourceFile,
                                                  AbsoluteUnixPath pathInContainer,
                                                  FilePermissionsProvider filePermissionProvider,
                                                  ModificationTimeProvider modificationTimeProvider)
                                           throws java.io.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:

java.io.IOException - if an exception occurred when recursively listing the directory

addEntryRecursive

public FileEntriesLayer.Builder addEntryRecursive(java.nio.file.Path sourceFile,
                                                  AbsoluteUnixPath pathInContainer,
                                                  FilePermissionsProvider filePermissionProvider,
                                                  ModificationTimeProvider modificationTimeProvider,
                                                  OwnershipProvider ownershipProvider)
                                           throws java.io.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

ownershipProvider - a provider that takes a source path and destination path on the container and returns the ownership that should be set for that path

Returns:

this

Throws:

java.io.IOException - if an exception occurred when recursively listing the directory

build

public FileEntriesLayer build()

Returns the built FileEntriesLayer.

Returns:

the built FileEntriesLayer