Package org.gitlab4j.api

Class EnvironmentsApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.EnvironmentsApi

All Implemented Interfaces:

Constants

public class EnvironmentsApi
extends AbstractApi

This class provides an entry point to all the GitLab API Environments API calls.

See Also:

• Environments API

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.EventScope, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PackageOrderBy, Constants.PackageStatus, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

gitLabApi

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor	Description
EnvironmentsApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
Environment	createEnvironment(Object projectIdOrPath, Long environmentId)	Stop an environment.
Environment	createEnvironment(Object projectIdOrPath, String name, String externalUrl)	Create a new environment with the given name and external_url.
void	deleteEnvironment(Object projectIdOrPath, Long environmentId)	Delete an environment.
Environment	getEnvironment(Object projectIdOrPath, Long environmentId)	Get a specific environment.
List<Environment>	getEnvironments(Object projectIdOrPath)	Get all environments for a given project.
Pager<Environment>	getEnvironments(Object projectIdOrPath, int itemsPerPage)	Get a Pager of all environments for a given project.
Stream<Environment>	getEnvironmentsStream(Object projectIdOrPath)	Get a Stream of all environments for a given project.
Optional<Environment>	getOptionalEnvironment(Object projectIdOrPath, Long environmentId)	Get a specific environment. as an Optional instance.
Environment	stopEnvironment(Object projectIdOrPath, Long environmentId)	Stop an environment.
Environment	updateEnvironment(Object projectIdOrPath, Long environmentId, String name, String externalUrl)	Update an existing environment.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

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

Constructor Details

EnvironmentsApi

public EnvironmentsApi(GitLabApi gitLabApi)

Method Details

getEnvironments

public List<Environment> getEnvironments(Object projectIdOrPath)
                                  throws GitLabApiException

Get all environments for a given project.

GitLab Endpoint: GET /projects/:id/environments

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

Returns:

a List of Environment instances

Throws:

GitLabApiException - if any exception occurs

getEnvironmentsStream

public Stream<Environment> getEnvironmentsStream(Object projectIdOrPath)
                                          throws GitLabApiException

Get a Stream of all environments for a given project.

GitLab Endpoint: GET /projects/:id/environments

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

Returns:

a Stream of Environment instances

Throws:

GitLabApiException - if any exception occurs

getEnvironments

public Pager<Environment> getEnvironments(Object projectIdOrPath,
 int itemsPerPage)
                                   throws GitLabApiException

Get a Pager of all environments for a given project.

GitLab Endpoint: GET /projects/:id/environments

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

itemsPerPage - the number of Environment instances that will be fetched per page

Returns:

a Pager of Environment instances

Throws:

GitLabApiException - if any exception occurs

getEnvironment

public Environment getEnvironment(Object projectIdOrPath,
 Long environmentId)
                           throws GitLabApiException

Get a specific environment.

GitLab Endpoint: GET /projects/:id/environments/:environment_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

environmentId - the ID of the environment to get

Returns:

an Environment instance

Throws:

GitLabApiException - if any exception occurs

getOptionalEnvironment

public Optional<Environment> getOptionalEnvironment(Object projectIdOrPath,
 Long environmentId)

Get a specific environment. as an Optional instance.

GitLab Endpoint: GET /projects/:id/environments/:environment_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

environmentId - the ID of the environment to get

Returns:

the Environment as an Optional instance

createEnvironment

public Environment createEnvironment(Object projectIdOrPath,
 String name,
 String externalUrl)
                              throws GitLabApiException

Create a new environment with the given name and external_url.

GitLab Endpoint:POST /projects/:id/environments

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

name - the name of the environment

externalUrl - the place to link to for this environment

Returns:

the created Environment instance

Throws:

GitLabApiException - if any exception occurs

updateEnvironment

public Environment updateEnvironment(Object projectIdOrPath,
 Long environmentId,
 String name,
 String externalUrl)
                              throws GitLabApiException

Update an existing environment.

GitLab Endpoint:POST /projects/:id/environments

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

environmentId - the ID of the environment to update

name - the name of the environment

externalUrl - the place to link to for this environment

Returns:

the created Environment instance

Throws:

GitLabApiException - if any exception occurs

stopEnvironment

public Environment stopEnvironment(Object projectIdOrPath,
 Long environmentId)
                            throws GitLabApiException

Stop an environment.

GitLab Endpoint: POST /projects/:id/environments/:environment_id/stop

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

environmentId - the ID of the environment to stop

Returns:

the stopped Environment instance

Throws:

GitLabApiException - if any exception occurs

deleteEnvironment

public void deleteEnvironment(Object projectIdOrPath,
 Long environmentId)
                       throws GitLabApiException

Delete an environment.

GitLab Endpoint: DELETE /projects/:id/environments/:environment_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

environmentId - the ID of the environment to delete

Throws:

GitLabApiException - if any exception occurs

createEnvironment

public Environment createEnvironment(Object projectIdOrPath,
 Long environmentId)
                              throws GitLabApiException

Stop an environment.

GitLab Endpoint:POST /projects/:id/environments/:environment_id/stop

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

environmentId - the ID of the environment to stop

Returns:

the Environment instance of the stopped environment

Throws:

GitLabApiException - if any exception occurs