Packages > pkg.pkl-lang.org/pkl-pantry/com.circleci.v2 > com.circleci.v2.Config

DockerImage1.4.0

Properties
Methods

class DockerImage

Known subtypes:
Known usages:
All versions:

Properties

link

image: String Source

The name of a custom docker image to use.

The first image listed under a job defines the job’s own primary container image where all steps will run.
link

name: String?Source

name defines the the hostname for the container (the default is localhost), which is used for reaching secondary (service) containers.

By default, all services are exposed directly on localhost. This field is useful if you would rather have a different hostname instead of localhost, for example, if you are starting multiple versions of the same service.
link

entrypoint: (Listing<String>|String)?Source

The command used as executable when launching the container.

entrypoint overrides the image’s ENTRYPOINT
link

command: (Listing<String>|String)?Source

The command used as pid 1 (or args for entrypoint) when launching the container.

command overrides the image’s COMMAND. It will be used as arguments to the image ENTRYPOINT if it has one, or as the executable if the image has no ENTRYPOINT.
link

user: String?Source

Which user to run commands as within the Docker container
link

environment: Mapping<String, String>?Source

environment variable names and values.

The environment settings apply to the entrypoint/command run by the docker container, not the job steps
link

auth: Mapping<String, String>?Source

Authentication for registries using standard docker login credentials
link

aws_auth: Mapping<String, String>?Source

Authentication for AWS Elastic Container Registry (ECR)

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.