Package io.github.cdklabs.projen.gitlab

Interface Release

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Release.Jsii$Proxy

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

(experimental) Indicates that the job creates a Release.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static Release.Builder	builder()
default Assets	getAssets()
String	getDescription()	(experimental) Specifies the longer description of the Release.
default List<String>	getMilestones()	(experimental) The title of each milestone the release is associated with.
default String	getName()	(experimental) The Release name.
default String	getRef()	(experimental) If the release: tag_name doesn’t exist yet, the release is created from ref.
default String	getReleasedAt()	(experimental) The date and time when the release is ready.
String	getTagName()	(experimental) The tag_name must be specified.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

@Stability(Experimental)
@NotNull
String getDescription()

(experimental) Specifies the longer description of the Release.

getTagName

@Stability(Experimental)
@NotNull
String getTagName()

(experimental) The tag_name must be specified.

It can refer to an existing Git tag or can be specified by the user.

getAssets

@Stability(Experimental)
@Nullable
default Assets getAssets()

getMilestones

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

(experimental) The title of each milestone the release is associated with.

getName

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

(experimental) The Release name.

If omitted, it is populated with the value of release: tag_name.

getRef

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

(experimental) If the release: tag_name doesn’t exist yet, the release is created from ref.

ref can be a commit SHA, another tag name, or a branch name.

getReleasedAt

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

(experimental) The date and time when the release is ready.

Defaults to the current date and time if not defined. Should be enclosed in quotes and expressed in ISO 8601 format.

builder

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

Returns:

a Release.Builder of Release