Index (jib-build-plan 0.4.0 API)

A B C D E F G H I L M O P R S T U V

A

AbsoluteUnixPath - Class in com.google.cloud.tools.jib.api.buildplan: Represents a Unix-style path in absolute form (containing all path components relative to the file system root /).
addEntry(FileEntry) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Adds an entry to the layer.
addEntry(Path, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Adds an entry to the layer.
addEntry(Path, AbsoluteUnixPath, FilePermissions) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Adds an entry to the layer with the given permissions.
addEntry(Path, AbsoluteUnixPath, Instant) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Adds an entry to the layer with the given file modification time.
addEntry(Path, AbsoluteUnixPath, FilePermissions, Instant) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Adds an entry to the layer with the given permissions and file modification time.
addEntry(Path, AbsoluteUnixPath, FilePermissions, Instant, String) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Adds an entry to the layer with the given permissions and file modification time.
addEntryRecursive(Path, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Adds an entry to the layer.
addEntryRecursive(Path, AbsoluteUnixPath, FilePermissionsProvider) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Adds an entry to the layer.
addEntryRecursive(Path, AbsoluteUnixPath, FilePermissionsProvider, ModificationTimeProvider) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Adds an entry to the layer.
addEntryRecursive(Path, AbsoluteUnixPath, FilePermissionsProvider, ModificationTimeProvider, OwnershipProvider) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Adds an entry to the layer.
addEnvironmentVariable(String, String) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Adds a variable in the container environment.
addExposedPort(Port) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Adds a port to expose from the container.
addLabel(String, String) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets a label for the container.
addLayer(LayerObject) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder
addPlatform(String, String) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Adds a desired image platform (OS and architecture pair).
addVolume(AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Adds a directory that may hold an externally mounted volume.

B

build() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Returns the built ContainerBuildPlan.
build() - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Returns the built FileEntriesLayer.
builder() - Static method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
builder() - Static method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer: Gets a new FileEntriesLayer.Builder for FileEntriesLayer.

C

com.google.cloud.tools.jib.api.buildplan - package com.google.cloud.tools.jib.api.buildplan
com.google.cloud.tools.jib.buildplan - package com.google.cloud.tools.jib.buildplan
ContainerBuildPlan - Class in com.google.cloud.tools.jib.api.buildplan: Describes a plan to build a container.
ContainerBuildPlan.Builder - Class in com.google.cloud.tools.jib.api.buildplan: Builder for ContainerBuildPlan.

D

DEFAULT_FILE_PERMISSIONS - Static variable in class com.google.cloud.tools.jib.api.buildplan.FilePermissions: Default permissions for files added to the container.
DEFAULT_FILE_PERMISSIONS_PROVIDER - Static variable in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer: Provider that returns default file permissions (644 for files, 755 for directories).
DEFAULT_FOLDER_PERMISSIONS - Static variable in class com.google.cloud.tools.jib.api.buildplan.FilePermissions: Default permissions for folders added to the container.
DEFAULT_MODIFICATION_TIME - Static variable in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer: Default file modification time (EPOCH + 1 second).
DEFAULT_MODIFICATION_TIME_PROVIDER - Static variable in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer: Provider that returns default file modification time (EPOCH + 1 second).
DEFAULT_OWNERSHIP_PROVIDER - Static variable in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer: Provider that returns default file ownership (an empty string "" effectively representing "0:0").

E

equals(Object) - Method in class com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath
equals(Object) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntry
equals(Object) - Method in class com.google.cloud.tools.jib.api.buildplan.FilePermissions
equals(Object) - Method in class com.google.cloud.tools.jib.api.buildplan.Platform
equals(Object) - Method in class com.google.cloud.tools.jib.api.buildplan.Port

F

FileEntriesLayer - Class in com.google.cloud.tools.jib.api.buildplan: Configures how to build a layer in the container image.
FileEntriesLayer.Builder - Class in com.google.cloud.tools.jib.api.buildplan: Builds a FileEntriesLayer.
FileEntry - Class in com.google.cloud.tools.jib.api.buildplan: Represents an entry in the layer.
FileEntry(Path, AbsoluteUnixPath, FilePermissions, Instant) - Constructor for class com.google.cloud.tools.jib.api.buildplan.FileEntry: Instantiates with a source file and the path to place the source file in the container file system.
FileEntry(Path, AbsoluteUnixPath, FilePermissions, Instant, String) - Constructor for class com.google.cloud.tools.jib.api.buildplan.FileEntry: Instantiates with a source file and the path to place the source file in the container file system.
FilePermissions - Class in com.google.cloud.tools.jib.api.buildplan: Represents read/write/execute file permissions for owner, group, and others.
FilePermissionsProvider - Interface in com.google.cloud.tools.jib.api.buildplan: Interface for providing rules to determine file permissions on a container.
fromOctalString(String) - Static method in class com.google.cloud.tools.jib.api.buildplan.FilePermissions: Creates a new FilePermissions from an octal string representation (e.g.
fromPath(Path) - Static method in class com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath: Gets a new AbsoluteUnixPath from a Path.
fromPosixFilePermissions(Set<PosixFilePermission>) - Static method in class com.google.cloud.tools.jib.api.buildplan.FilePermissions: Creates a new FilePermissions from a set of PosixFilePermission.

G

get(String) - Static method in class com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath: Gets a new AbsoluteUnixPath from a Unix-style path string.
get(Path, AbsoluteUnixPath) - Method in interface com.google.cloud.tools.jib.api.buildplan.FilePermissionsProvider: Returns the file permissions that should be set for a path, given the source path and destination path on a container.
get(Path, AbsoluteUnixPath) - Method in interface com.google.cloud.tools.jib.api.buildplan.ModificationTimeProvider: Returns the file modification time that should be set on a path, given the source path and destination path.
get(Path, AbsoluteUnixPath) - Method in interface com.google.cloud.tools.jib.api.buildplan.OwnershipProvider: Returns the file ownership that should be set for a path, given the source path and destination path on a container.
get(String) - Static method in class com.google.cloud.tools.jib.api.buildplan.RelativeUnixPath: Gets a new RelativeUnixPath from a Unix-style path in relative form.
getArchitecture() - Method in class com.google.cloud.tools.jib.api.buildplan.Platform
getBaseImage() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
getCmd() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
getCreationTime() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
getEntries() - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer: Gets the list of entries.
getEntrypoint() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
getEnvironment() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
getExposedPorts() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
getExtractionPath() - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntry: Gets the extraction path.
getFormat() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
getLabels() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
getLayers() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
getModificationTime() - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntry: Returns the modification time of the file in the entry.
getName() - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer: Gets the name.
getName() - Method in interface com.google.cloud.tools.jib.api.buildplan.LayerObject
getOs() - Method in class com.google.cloud.tools.jib.api.buildplan.Platform
getOwnership() - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntry: Gets the file ownership on the container.
getPermissionBits() - Method in class com.google.cloud.tools.jib.api.buildplan.FilePermissions: Gets the corresponding permissions bits specified by the FilePermissions.
getPermissions() - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntry: Gets the file permissions on the container.
getPlatforms() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan: Creates and returns a default platform if the user hasn't added or set any platforms ,else returns a list of user specified platforms .
getPort() - Method in class com.google.cloud.tools.jib.api.buildplan.Port: Gets the port number.
getProtocol() - Method in class com.google.cloud.tools.jib.api.buildplan.Port: Gets the protocol.
getSourceFile() - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntry: Gets the source file.
getType() - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer
getType() - Method in interface com.google.cloud.tools.jib.api.buildplan.LayerObject
getUser() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
getVolumes() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan
getWorkingDirectory() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan

H

hashCode() - Method in class com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath
hashCode() - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntry
hashCode() - Method in class com.google.cloud.tools.jib.api.buildplan.FilePermissions
hashCode() - Method in class com.google.cloud.tools.jib.api.buildplan.Platform
hashCode() - Method in class com.google.cloud.tools.jib.api.buildplan.Port

I

ImageFormat - Enum in com.google.cloud.tools.jib.api.buildplan: Indicates the format of the image.

L

LayerObject - Interface in com.google.cloud.tools.jib.api.buildplan: Serves as a base class for the "layers" property in the build plan specification.
LayerObject.Type - Enum in com.google.cloud.tools.jib.api.buildplan

M

ModificationTimeProvider - Interface in com.google.cloud.tools.jib.api.buildplan: Interface for providing the file modification time on a container.

O

OwnershipProvider - Interface in com.google.cloud.tools.jib.api.buildplan: Interface for providing the file ownership on a container.

P

parse(String) - Static method in class com.google.cloud.tools.jib.buildplan.UnixPathParser: Parses a Unix-style path into a list of path components.
parseProtocol(int, String) - Static method in class com.google.cloud.tools.jib.api.buildplan.Port: Gets a Port with protocol parsed from the string form protocolString.
Platform - Class in com.google.cloud.tools.jib.api.buildplan: Represents an image platform (for example, "amd64/linux").
Platform(String, String) - Constructor for class com.google.cloud.tools.jib.api.buildplan.Platform
Port - Class in com.google.cloud.tools.jib.api.buildplan: Represents a port number with a protocol (TCP or UDP).

R

RelativeUnixPath - Class in com.google.cloud.tools.jib.api.buildplan: Represents a Unix-style path in relative form (does not start at the file system root /).
resolve(RelativeUnixPath) - Method in class com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath: Resolves this path against another relative path.
resolve(Path) - Method in class com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath: Resolves this path against another relative path (by the name elements of relativePath).
resolve(String) - Method in class com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath: Resolves this path against another relative Unix path in string form.

S

setBaseImage(String) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Image reference to a base image.
setCmd(List<String>) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets the container entrypoint program arguments.
setCreationTime(Instant) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets the container image creation time.
setEntries(List<FileEntry>) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Sets entries for the layer.
setEntrypoint(List<String>) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets the container entrypoint.
setEnvironment(Map<String, String>) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets the container environment.
setExposedPorts(Set<Port>) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets the ports to expose from the container.
setFormat(ImageFormat) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets the format to build the container image as.
setLabels(Map<String, String>) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets the labels for the container.
setLayers(List<? extends LayerObject>) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder
setName(String) - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.Builder: Sets a name for this layer.
setPlatforms(Set<Platform>) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets a desired platform (properties including OS and architecture) list.
setUser(String) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets the user and group to run the container as.
setVolumes(Set<AbsoluteUnixPath>) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets the directories that may hold externally mounted volumes.
setWorkingDirectory(AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder: Sets the working directory in the container.

T

tcp(int) - Static method in class com.google.cloud.tools.jib.api.buildplan.Port: Create a new Port with TCP protocol.
toBuilder() - Method in class com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan: Creates a builder configured with the current values.
toBuilder() - Method in class com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer: Creates a builder configured with the current values.
toOctalString() - Method in class com.google.cloud.tools.jib.api.buildplan.FilePermissions: Gets the octal string representation of the permissions.
toString() - Method in class com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath: Returns the string form of the absolute Unix-style path.
toString() - Method in class com.google.cloud.tools.jib.api.buildplan.Port: Stringifies the port with protocol, in the form <port>/<protocol>.

U

udp(int) - Static method in class com.google.cloud.tools.jib.api.buildplan.Port: Create a new Port with UDP protocol.
UnixPathParser - Class in com.google.cloud.tools.jib.buildplan: Parses Unix-style paths.

V

valueOf(String) - Static method in enum com.google.cloud.tools.jib.api.buildplan.ImageFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.google.cloud.tools.jib.api.buildplan.LayerObject.Type: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.google.cloud.tools.jib.api.buildplan.ImageFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.google.cloud.tools.jib.api.buildplan.LayerObject.Type: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M O P R S T U V