Deprecated API

Contents

• Deprecated Classes
• Deprecated Methods
• Deprecated Enum Constants

Deprecated Classes

Class and Description
org.gitlab4j.api.models.ProjectSharedGroup use SharedGroup instead

Deprecated Methods

Method and Description
org.gitlab4j.api.CommitsApi.addCommitStatus(Object, String, Constants.CommitBuildState, Long, CommitStatus) use CommitsApi.addCommitStatus(Object, String, org.gitlab4j.api.Constants.CommitBuildState, CommitStatus) and set the pipelineId value in the CommitStatus parameter
org.gitlab4j.api.GroupApi.addGroup(String, String, String, Boolean, Boolean, Visibility, Boolean, Boolean, Long, Integer) Will be removed in version 6.0, replaced by GroupApi.addGroup(String, String, String, Visibility, Boolean, Boolean, Long)
org.gitlab4j.api.AwardEmojiApi.addNoteAwardEmoji(Object, Long, Long, String) use AwardEmojiApi.addIssueNoteAwardEmoji(Object, Long, Long, String)
org.gitlab4j.api.JobApi.cancleJob(Object, Long) replaced by JobApi.cancelJob(Object, Long)
org.gitlab4j.api.RepositoryFileApi.createFile(RepositoryFile, Long, String, String) Will be removed in version 6.0, replaced by RepositoryFileApi.createFile(Object, RepositoryFile, String, String)
org.gitlab4j.api.LabelsApi.createLabel(Object, String, String) Replaced by the LabelsApi.createProjectLabel(Object, Label) method.
org.gitlab4j.api.LabelsApi.createLabel(Object, String, String, Integer) Replaced by the LabelsApi.createProjectLabel(Object, Label) method.
org.gitlab4j.api.LabelsApi.createLabel(Object, String, String, String) Replaced by the LabelsApi.createProjectLabel(Object, Label) method.
org.gitlab4j.api.LabelsApi.createLabel(Object, String, String, String, Integer) Replaced by the LabelsApi.createProjectLabel(Object, Label) method.
org.gitlab4j.api.ProjectApi.createProject(String, Long, String, Boolean, Boolean, Boolean, Boolean, Boolean, Integer, String) As of release 4.2.0, replaced by ProjectApi.createProject(String, Long, String, Boolean, Boolean, Boolean, Boolean, Visibility, Integer, String)
org.gitlab4j.api.UserApi.createUser(User, CharSequence, Integer) Will be removed in version 6.0, replaced by UserApi.createUser(User, CharSequence, boolean)
org.gitlab4j.api.RepositoryFileApi.deleteFile(String, Long, String, String) Will be removed in version 6.0, replaced by RepositoryFileApi.deleteFile(Object, String, String, String)
org.gitlab4j.api.ServicesApi.deleteGitLabCI(Object) No longer supported
org.gitlab4j.api.ServicesApi.deleteHipChat(Object) replaced with updateHipChat method
org.gitlab4j.api.ProjectApi.deleteIssue(Object, Long) Will be removed in version 6.0, replaced by IssuesApi.deleteIssue(Object, Long)
org.gitlab4j.api.LabelsApi.deleteLabel(Object, String) Replaced by the LabelsApi.deleteProjectLabel(Object, Object) method.
org.gitlab4j.api.AwardEmojiApi.deleteNoteAwardEmoji(Object, Long, Long, Long) use AwardEmojiApi.deleteIssueNoteAwardEmoji(Object, Long, Long, Long) instead
org.gitlab4j.api.GroupApi.getAllMembers(Object, int, int) Will be removed in version 6.0
org.gitlab4j.api.ProjectApi.getAllMembers(Object, int, int) Will be removed in version 6.0
org.gitlab4j.api.webhook.BuildEvent.getBuildFinished_at() Replaced by BuildEvent.getBuildFinishedAt()
org.gitlab4j.api.webhook.BuildEvent.getBuildStarted_at() Replaced by BuildEvent.getBuildStartedAt()
org.gitlab4j.api.models.PushData.getCommit_count()
org.gitlab4j.api.CommitsApi.getCommits(Object, int, int)
org.gitlab4j.api.CommitsApi.getCommits(Object, String, Date, Date, int, int)
org.gitlab4j.api.CommitsApi.getCommits(Object, String, Date, Date, String, int, int)
org.gitlab4j.api.models.Pipeline.getCommitted_at() Replaced by Pipeline.getCommittedAt()
org.gitlab4j.api.models.GpgKey.getCreated_at() Replaced by GpgKey.getCreatedAt()
org.gitlab4j.api.models.PackageFile.getCreated_at() Replaced by PackageFile.getCreatedAt()
org.gitlab4j.api.models.Link.getExternal() deprecated in GitLab 15.9, will be removed in GitLab 16.0.
org.gitlab4j.api.RepositoryFileApi.getFile(String, Long, String) Will be removed in version 6.0, replaced by RepositoryFileApi.getFile(Object, String, String)
org.gitlab4j.api.RepositoryFileApi.getFileV3(String, Long, String) Will be removed in version 6.0
org.gitlab4j.api.models.Pipeline.getFinished_at() Replaced by Pipeline.getFinishedAt()
org.gitlab4j.api.models.DeploymentFilter.getFinishedAfter() use DeploymentFilter.getUpdatedAfter()
org.gitlab4j.api.models.DeploymentFilter.getFinishedBefore() use DeploymentFilter.getUpdatedBefore()
org.gitlab4j.api.ProjectApi.getIssue(Object, Long) Will be removed in version 6.0, replaced by IssuesApi.getIssue(Object, Long)
org.gitlab4j.api.ProjectApi.getIssues(Object) Will be removed in version 6.0, replaced by IssuesApi.getIssues(Object)
org.gitlab4j.api.ProjectApi.getIssues(Object, int) Will be removed in version 6.0, replaced by IssuesApi.getIssues(Object, int)
org.gitlab4j.api.ProjectApi.getIssues(Object, int, int) Will be removed in version 6.0, replaced by IssuesApi.getIssues(Object, int, int)
org.gitlab4j.api.ProjectApi.getIssuesStream(Object) Will be removed in version 6.0, replaced by IssuesApi.getIssues(Object)
org.gitlab4j.api.webhook.JobEvent.getJobFinished_at() Replaced by JobEvent.getJobFinishedAt()
org.gitlab4j.api.webhook.JobEvent.getJobStarted_at() Replaced by JobEvent.getJobStartedAt()
org.gitlab4j.api.LabelsApi.getLabels(Object) Replaced by the LabelsApi.getProjectLabels(Object) method.
org.gitlab4j.api.LabelsApi.getLabels(Object, int) Replaced by the LabelsApi.getProjectLabels(Object, int) method.
org.gitlab4j.api.LabelsApi.getLabels(Object, int, int) Will be removed in the next major release (6.0.0)
org.gitlab4j.api.LabelsApi.getLabelsStream(Object) Replaced by the LabelsApi.getProjectLabelsStream(Object) method.
org.gitlab4j.api.webhook.EventMergeRequest.getLast_editedAt() used EventMergeRequest.getLastEditedAt()
org.gitlab4j.api.HealthCheckApi.getLiveness(String)
org.gitlab4j.api.models.MergeRequest.getMergedBy() since 14.7, use MergeRequest.getMergeUser() instead. see https://docs.gitlab.com/ee/update/deprecations.html#merged_by-api-field
org.gitlab4j.api.MergeRequestApi.getMergeRequestDiff(Object, Long, Long) use MergeRequestApi.getDiffVersion(Object, Long, Long) instead
org.gitlab4j.api.MergeRequestApi.getMergeRequestDiffs(Object, Long) use MergeRequestApi.getDiffVersions(Object, Long) instead
org.gitlab4j.api.MergeRequestApi.getMergeRequestDiffs(Object, Long, int) use MergeRequestApi.getDiffVersions(Object, Long, int) instead
org.gitlab4j.api.MergeRequestApi.getMergeRequestDiffsStream(Object, Long) use MergeRequestApi.getDiffVersionsStream(Object, Long) instead
org.gitlab4j.api.models.MergeRequest.getMergeStatus() since 15.6, use MergeRequest.getDetailedMergeStatus() instead.
org.gitlab4j.api.AwardEmojiApi.getNoteAwardEmoji(Object, Long, Long, Long) use AwardEmojiApi.getIssueNoteAwardEmoji(Object, Long, Long, Long) instead
org.gitlab4j.api.NotesApi.getNotes(Object, Long) As of release 4.7.0, replaced by NotesApi.getIssueNotes(Object, Long)
org.gitlab4j.api.NotesApi.getNotes(Object, Long, int) As of release 4.7.0, replaced by NotesApi.getIssueNotes(Object, Long, int)
org.gitlab4j.api.NotesApi.getNotes(Object, Long, int, int) As of release 4.7.0, replaced by NotesApi.getIssueNotes(Object, Long, int, int)
org.gitlab4j.api.services.SlackService.getNotifyOnlyDefaultBranch()
org.gitlab4j.api.MergeRequestApi.getOptionalMergeRequestDiff(Object, Long, Long) use MergeRequestApi.getOptionalDiffVersion(Object, Long, Long) instead
org.gitlab4j.api.WikisApi.getPages(Object, int, int) Will be removed in a future release, use WikisApi.getPages(Object, boolean, int)
org.gitlab4j.api.ProjectApi.getProjects(Boolean, Visibility, String, String, String, Boolean, Boolean, Boolean, Boolean, Boolean) Will be removed in version 6.0, replaced by ProjectApi.getProjects(Boolean, Visibility, Constants.ProjectOrderBy, Constants.SortOrder, String, Boolean, Boolean, Boolean, Boolean, Boolean)
org.gitlab4j.api.HealthCheckApi.getReadiness(String)
org.gitlab4j.api.RepositoryApi.getRepositoryArchive(Object, String) Use RepositoryApi.getRepositoryArchive(Object, RepositoryArchiveParams)
org.gitlab4j.api.RepositoryApi.getRepositoryArchive(Object, String, Constants.ArchiveFormat) User #getRepositoryArchive(Object, RepositoryArchiveParams, ArchiveFormat)
org.gitlab4j.api.RepositoryApi.getRepositoryArchive(Object, String, File) Use RepositoryApi.getRepositoryArchive(Object, RepositoryArchiveParams, File)
org.gitlab4j.api.RepositoryApi.getRepositoryArchive(Object, String, File, Constants.ArchiveFormat) Use #getRepositoryArchive(Object, RepositoryArchiveParams, File, ArchiveFormat)
org.gitlab4j.api.RepositoryApi.getRepositoryArchive(Object, String, File, String) Use RepositoryApi.getRepositoryArchive(Object, RepositoryArchiveParams, File, String)
org.gitlab4j.api.RepositoryApi.getRepositoryArchive(Object, String, String) Use RepositoryApi.getRepositoryArchive(Object, RepositoryArchiveParams, String)
org.gitlab4j.api.models.Pipeline.getStarted_at() Replaced by Pipeline.getStartedAt()
org.gitlab4j.api.models.Project.getTagList()
org.gitlab4j.api.models.Pipeline.getUpdated_at() Replaced by Pipeline.getUpdatedAt()
org.gitlab4j.api.models.ProjectFilter.minAccessLevel(AccessLevel) Replaced by getComponentAt
org.gitlab4j.api.UserApi.modifyUser(User, CharSequence, Integer) Will be removed in version 6.0, replaced by UserApi.updateUser(User, CharSequence)
org.gitlab4j.api.webhook.BuildEvent.setBuildFinished_at(Date) Replaced by BuildEvent.setBuildFinishedAt(Date)
org.gitlab4j.api.webhook.BuildEvent.setBuildStarted_at(Date) Replaced by BuildEvent.setBuildStartedAt(Date)
org.gitlab4j.api.models.PushData.setCommit_count(Integer)
org.gitlab4j.api.models.Pipeline.setCommitted_at(Date) Replaced by Pipeline.setCommittedAt(Date)
org.gitlab4j.api.models.GpgKey.setCreated_at(Date) Replaced by GpgKey.setCreatedAt(Date)
org.gitlab4j.api.models.PackageFile.setCreated_at(Date) Replaced by PackageFile.setCreatedAt(Date)
org.gitlab4j.api.models.Link.setExternal(Boolean) deprecated in GitLab 15.9, will be removed in GitLab 16.0.
org.gitlab4j.api.models.Pipeline.setFinished_at(Date) Replaced by Pipeline.setFinishedAt(Date)
org.gitlab4j.api.models.DeploymentFilter.setFinishedAfter(Date) use DeploymentFilter.setUpdatedAfter(Date)
org.gitlab4j.api.models.DeploymentFilter.setFinishedBefore(Date) use DeploymentFilter.setUpdatedBefore(Date)
org.gitlab4j.api.ServicesApi.setGitLabCI(Object, String, String) No longer supported
org.gitlab4j.api.ServicesApi.setHipChat(Object, String, String, String) replaced with updateHipChat method
org.gitlab4j.api.webhook.JobEvent.setJobFinished_at(Date) Replaced by JobEvent.setJobFinishedAt(Date)
org.gitlab4j.api.webhook.JobEvent.setJobStarted_at(Date) Replaced by JobEvent.setJobStartedAt(Date)
org.gitlab4j.api.webhook.EventMergeRequest.setLast_editedAt(Date) used EventMergeRequest.setLastEditedAt(Date)
org.gitlab4j.api.models.MergeRequest.setMergedBy(Participant) since 14.7, use MergeRequest.setMergeUser(Participant) instead. see https://docs.gitlab.com/ee/update/deprecations.html#merged_by-api-field
org.gitlab4j.api.models.MergeRequest.setMergeStatus(String) since 15.6, use MergeRequest.setDetailedMergeStatus(String) instead.
org.gitlab4j.api.services.SlackService.setNotifyOnlyDefaultBranch(Boolean) use SlackService#setBranchesToBeNotified(BranchesToBeNotified)
org.gitlab4j.api.models.Pipeline.setStarted_at(Date) Replaced by Pipeline.setStartedAt(Date)
org.gitlab4j.api.models.Project.setTagList(List<String>)
org.gitlab4j.api.models.Pipeline.setUpdated_at(Date) Replaced by Pipeline.setUpdatedAt(Date)
org.gitlab4j.api.LabelsApi.subscribeLabel(Object, Long) Replaced by the LabelsApi.subscribeProjectLabel(Object, Object) method.
org.gitlab4j.api.LabelsApi.unsubscribeLabel(Object, Long) Replaced by the LabelsApi.unsubscribeProjectLabel(Object, Object) method.
org.gitlab4j.api.RepositoryFileApi.updateFile(RepositoryFile, Long, String, String) Will be removed in version 6.0, replaced by RepositoryFileApi.updateFile(Object, RepositoryFile, String, String)
org.gitlab4j.api.GroupApi.updateGroup(Object, String, String, String, Boolean, Boolean, Visibility, Boolean, Boolean, Long, Integer) Will be removed in version 6.0, replaced by GroupApi.updateGroup(Object, String, String, String, Visibility, Boolean, Boolean, Long)
org.gitlab4j.api.LabelsApi.updateLabel(Object, String, String, String, String, Integer) @deprecated Replaced by the LabelsApi.updateProjectLabel(Object, Object, Label) method.
org.gitlab4j.api.LabelsApi.updateLabelColor(Object, String, String, String, Integer) @deprecated Replaced by the LabelsApi.updateProjectLabel(Object, Object, Label) method.
org.gitlab4j.api.LabelsApi.updateLabelName(Object, String, String, String, Integer) @deprecated Replaced by the LabelsApi.updateProjectLabel(Object, Object, Label) method.
org.gitlab4j.api.models.GroupFilter.withAllAvailabley(Boolean) this method contains a typo, use GroupFilter.withAllAvailable(Boolean) instead
org.gitlab4j.api.models.Branch.withDerged(Boolean) Use Branch.withMerged(Boolean) instead
org.gitlab4j.api.models.DeploymentFilter.withFinishedAfter(Date) use DeploymentFilter.withUpdatedAfter(Date)
org.gitlab4j.api.models.DeploymentFilter.withFinishedBefore(Date) use DeploymentFilter.withUpdatedBefore(Date)
org.gitlab4j.api.services.SlackService.withNotifyOnlyDefaultBranch(Boolean) use SlackService#withBranchesToBeNotified(BranchesToBeNotified)
org.gitlab4j.api.models.User.withProjectLimit(Integer) Replaced by User.withProjectsLimit(Integer)
org.gitlab4j.api.models.User.withSharedRunnersMinuteLimit(Integer) Replaced by User.withSharedRunnersMinutesLimit(Integer)
org.gitlab4j.api.models.Project.withTagList(List<String>)

Deprecated Enum Constants

Enum Constant and Description
org.gitlab4j.api.models.Setting.ALLOW_LOCAL_REQUESTS_FROM_HOOKS_AND_SERVICES Use allow_local_requests_from_web_hooks_and_services instead
org.gitlab4j.api.models.Setting.CLIENTSIDE_SENTRY_DSN Will be removed in a future version of gitlab4j-api
org.gitlab4j.api.models.Setting.CLIENTSIDE_SENTRY_ENABLED Will be removed in a future version of gitlab4j-api
org.gitlab4j.api.models.Setting.DOMAIN_BLACKLIST_RAW Use Setting.DOMAIN_BLACKLIST instead. Will be removed in API v5 see https://gitlab.com/gitlab-org/gitlab/commit/85776fa3ffba6f641cf981cb0107f0e4ba882f3e#40f8529fa8ed874d8e312edb04db18420bf06d31_185_185
org.gitlab4j.api.models.Setting.DOMAIN_WHITELIST_RAW Use Setting.DOMAIN_WHITELIST instead. Will be removed in API v5 see https://gitlab.com/gitlab-org/gitlab/commit/85776fa3ffba6f641cf981cb0107f0e4ba882f3e#40f8529fa8ed874d8e312edb04db18420bf06d31_185_185
org.gitlab4j.api.models.Setting.ELASTICSEARCH_EXPERIMENTAL_INDEXER removed in Gitlab 12.3. see https://gitlab.com/gitlab-org/gitlab/commit/82ba4a6a5c78501413012a9f2a918aa7353917a0?view=parallel#fbf64e6b8170f05f1b940fb05902d29f9eba3633_223_223
org.gitlab4j.api.models.AccessLevel.MASTER
org.gitlab4j.api.models.Setting.PASSWORD_AUTHENTICATION_ENABLED Use Setting.PASSWORD_AUTHENTICATION_ENABLED_FOR_WEB instead.
org.gitlab4j.api.models.Setting.PERFORMANCE_BAR_ALLOWED_GROUP_ID Use Setting.PERFORMANCE_BAR_ALLOWED_GROUP_PATH instead.
org.gitlab4j.api.models.Setting.PERFORMANCE_BAR_ENABLED Pass performance_bar_allowed_group_path: nil instead
org.gitlab4j.api.models.Setting.SIGNIN_ENABLED Use Setting.PASSWORD_AUTHENTICATION_ENABLED_FOR_WEB instead