Package io.github.cdklabs.projen.gitlab

Interface Service

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Service.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.135Z")
@Stability(Experimental)
public interface Service
extends software.amazon.jsii.JsiiSerializable

(experimental) Used to specify an additional Docker image to run scripts in.

The service image is linked to the image specified in the

See Also:

https://docs.gitlab.com/ee/ci/yaml/#services

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Service.Builder	A builder for Service
static class	Service.Jsii$Proxy	An implementation for Service

Method Summary

Modifier and Type	Method	Description
static Service.Builder	builder()
default String	getAlias()	(experimental) Additional alias that can be used to access the service from the job's container.
default List<String>	getCommand()	(experimental) Command or script that should be used as the container's command.
default List<String>	getEntrypoint()	(experimental) Command or script that should be executed as the container's entrypoint.
String	getName()	(experimental) Full name of the image that should be used.
default List<PullPolicy>	getPullPolicy()	(experimental) The pull policy that the runner uses to fetch the Docker image.
default Map<String,String>	getVariables()	(experimental) Additional environment variables that are passed exclusively to the service..

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) Full name of the image that should be used.

It should contain the Registry part if needed.

getAlias

@Stability(Experimental)
@Nullable
default String getAlias()

(experimental) Additional alias that can be used to access the service from the job's container.

Read Accessing the services for more information.

getCommand

@Stability(Experimental)
@Nullable
default List<String> getCommand()

(experimental) Command or script that should be used as the container's command.

It will be translated to arguments passed to Docker after the image's name. The syntax is similar to Dockerfile's CMD directive, where each shell token is a separate string in the array.

getEntrypoint

@Stability(Experimental)
@Nullable
default List<String> getEntrypoint()

(experimental) Command or script that should be executed as the container's entrypoint.

It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array.

getPullPolicy

@Stability(Experimental)
@Nullable
default List<PullPolicy> getPullPolicy()

(experimental) The pull policy that the runner uses to fetch the Docker image.

getVariables

@Stability(Experimental)
@Nullable
default Map<String,String> getVariables()

(experimental) Additional environment variables that are passed exclusively to the service..

builder

@Stability(Experimental)
static Service.Builder builder()

Returns:

a Service.Builder of Service