Package io.github.cdklabs.projen.github.workflows

Class ContainerOptions.Builder

java.lang.Object

io.github.cdklabs.projen.github.workflows.ContainerOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ContainerOptions>

Enclosing interface:

ContainerOptions

@Stability(Experimental)
public static final class ContainerOptions.Builder
extends Object
implements software.amazon.jsii.Builder<ContainerOptions>

A builder for ContainerOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ContainerOptions	build()	Builds the configured instance.
ContainerOptions.Builder	credentials(ContainerCredentials credentials)	Sets the value of ContainerOptions.getCredentials()
ContainerOptions.Builder	env(Map<String,String> env)	Sets the value of ContainerOptions.getEnv()
ContainerOptions.Builder	image(String image)	Sets the value of ContainerOptions.getImage()
ContainerOptions.Builder	options(List<String> options)	Sets the value of ContainerOptions.getOptions()
ContainerOptions.Builder	ports(List<? extends Number> ports)	Sets the value of ContainerOptions.getPorts()
ContainerOptions.Builder	volumes(List<String> volumes)	Sets the value of ContainerOptions.getVolumes()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

image

@Stability(Experimental)
public ContainerOptions.Builder image(String image)

Sets the value of ContainerOptions.getImage()

Parameters:

image - The Docker image to use as the container to run the action. This parameter is required. The value can be the Docker Hub image name or a registry name.

Returns:

this

credentials

@Stability(Experimental)
public ContainerOptions.Builder credentials(ContainerCredentials credentials)

Sets the value of ContainerOptions.getCredentials()

Parameters:

credentials - f the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the docker login command.

Returns:

this

env

@Stability(Experimental)
public ContainerOptions.Builder env(Map<String,String> env)

Sets the value of ContainerOptions.getEnv()

Parameters:

env - Sets a map of environment variables in the container.

Returns:

this

options

@Stability(Experimental)
public ContainerOptions.Builder options(List<String> options)

Sets the value of ContainerOptions.getOptions()

Parameters:

options - Additional Docker container resource options.

Returns:

this

ports

@Stability(Experimental)
public ContainerOptions.Builder ports(List<? extends Number> ports)

Sets the value of ContainerOptions.getPorts()

Parameters:

ports - Sets an array of ports to expose on the container.

Returns:

this

volumes

@Stability(Experimental)
public ContainerOptions.Builder volumes(List<String> volumes)

Sets the value of ContainerOptions.getVolumes()

Parameters:

volumes - Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host.

To specify a volume, you specify the source and destination path: <source>:<destinationPath>.

Returns:

this

build

@Stability(Experimental)
public ContainerOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ContainerOptions>

Returns:

a new instance of ContainerOptions

Throws:

NullPointerException - if any required attribute was not provided