Package org.gitlab4j.api

Class RepositorySubmodulesApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.RepositorySubmodulesApi

All Implemented Interfaces:

Constants

public class RepositorySubmodulesApi
extends AbstractApi

This class provides an entry point to all the GitLab API repository submodules calls. For more information on the repository APIs see:

See Also:

• Repository Submodules 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
RepositorySubmodulesApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
Commit	updateExistingSubmoduleReference(Object projectIdOrPath, String submodule, String branch, String commitSha, String commitMessage)	Update existing submodule reference in repository.

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

RepositorySubmodulesApi

public RepositorySubmodulesApi(GitLabApi gitLabApi)

Method Details

updateExistingSubmoduleReference

public Commit updateExistingSubmoduleReference(Object projectIdOrPath,
 String submodule,
 String branch,
 String commitSha,
 String commitMessage)
                                        throws GitLabApiException

Update existing submodule reference in repository.

GitLab Endpoint: PUT /projects/:id/repository/submodules/:submodule

Parameters:

projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance

submodule - full path to the submodule

branch - name of the branch to commit into

commitSha - full commit SHA to update the submodule to

commitMessage - commit message (optional). If no message is provided, a default is set

Returns:

the created commit

Throws:

GitLabApiException - if any exception occurs