org.cloudbees.literate.api.v1

Class ProjectModelRequest

java.lang.Object

org.cloudbees.literate.api.v1.ProjectModelRequest

@Immutable
public class ProjectModelRequest
extends Object

A request for a ProjectModel

Author:

Stephen Connolly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProjectModelRequest.Builder A builder of ProjectModelRequest instances.

Method Summary

Methods

Modifier and Type	Method and Description
static ProjectModelRequest.Builder	builder(ProjectRepository repository) Instantiates a new ProjectModelRequest.Builder.
String	getBaseName() Gets the base name that the project model builder will use to detect the model.
String	getBuildId() Gets the id of the build instructions within the source model.
String	getEnvironmentsId() Gets the id of the environments within the source model.
ProjectRepository	getRepository() Returns the project repository to construct the project model from.
Set<String>	getTaskIds() Returns the task ids to additionally populate in the project model.

Methods inherited from class java.lang.Object

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

Method Detail

getBaseName

@NonNull
public String getBaseName()

Gets the base name that the project model builder will use to detect the model.

Returns:

the base name.

getBuildId

@NonNull
public String getBuildId()

Gets the id of the build instructions within the source model.

Returns:

the id of the build instructions within the source model.

getEnvironmentsId

@NonNull
public String getEnvironmentsId()

Gets the id of the environments within the source model.

Returns:

the id of the environments within the source model

getRepository

@NonNull
public ProjectRepository getRepository()

Returns the project repository to construct the project model from.

Returns:

the project repository to construct the project model from.

getTaskIds

@NonNull
public Set<String> getTaskIds()

Returns the task ids to additionally populate in the project model.

Returns:

the task ids to additionally populate in the project model.

builder

@NonNull
public static ProjectModelRequest.Builder builder(ProjectRepository repository)

Instantiates a new ProjectModelRequest.Builder.

Parameters:

repository - the repository to construct the project model from.

Returns:

the ProjectModelRequest.Builder.