Skip to content

feat: Add Pull mirror API (#1227) #1271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions gitlab4j-api/src/main/java/org/gitlab4j/api/ProjectApi.java
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
import org.gitlab4j.api.models.ProjectGroupsFilter;
import org.gitlab4j.api.models.ProjectHook;
import org.gitlab4j.api.models.ProjectUser;
import org.gitlab4j.api.models.PullMirror;
import org.gitlab4j.api.models.PushRules;
import org.gitlab4j.api.models.RemoteMirror;
import org.gitlab4j.api.models.Snippet;
Expand Down Expand Up @@ -4428,6 +4429,41 @@ public void deleteCustomAttribute(final Object projectIdOrPath, final String key
delete(Response.Status.OK, null, "projects", getProjectIdOrPath(projectIdOrPath), "custom_attributes", key);
}

/**
* Get all pull mirrors for the specified project.
*
* <pre><code>GitLab Endpoint: GET /projects/:id/mirror/pull</code></pre>
*
* @param projectIdOrPath the project in the form of a Long(ID), String(path), or Project instance
* @return a list of project's pull mirrors
* @throws GitLabApiException if any exception occurs
*/
public List<PullMirror> getPullMirrors(final Object projectIdOrPath) throws GitLabApiException {
return (getPullMirrors(projectIdOrPath, getDefaultPerPage()).all());
}

/**
* Get a Pager of pull mirrors for the specified project.
*
* <pre><code>GitLab Endpoint: GET /projects/:id/mirror/pull</code></pre>
*
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
* @param itemsPerPage the number of items per page
* @return a Pager of project's pull mirrors
* @throws GitLabApiException if any exception occurs
*/
public Pager<PullMirror> getPullMirrors(final Object projectIdOrPath, int itemsPerPage) throws GitLabApiException {
return new Pager<PullMirror>(
this,
PullMirror.class,
itemsPerPage,
null,
"projects",
getProjectIdOrPath(projectIdOrPath),
"mirror",
"pull");
}

/**
* Get all remote mirrors and their statuses for the specified project.
*
Expand Down
124 changes: 124 additions & 0 deletions gitlab4j-models/src/main/java/org/gitlab4j/api/models/PullMirror.java
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please add a JSON example (often I take the one from the documentation) in gitlab4j-models/src/test/resources/org/gitlab4j/models/ and a test case in TestGitLabApiBeans?

If you need more information feel free to continue this discussion.

Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
package org.gitlab4j.api.models;

import java.io.Serializable;
import java.util.Date;

import org.gitlab4j.models.utils.JacksonJson;

public class PullMirror implements Serializable {
private static final long serialVersionUID = 1L;

private Long id;
private String lastError;
private Date lastSuccessfulUpdateAt;
private Date lastUpdateAt;
private Date lastUpdateStartedAt;
private String updatedStatus;
private String url;
private Boolean enabled;
private Boolean mirrorTriggerBuilds;
private Boolean onlyMirrorProtectedBranches;
private Boolean mirrorOverwritesDivergedBranches;
private String mirrorBranchRegex;

public Long getId() {
return id;
}

public void setId(Long id) {
this.id = id;
}

public String getLastError() {
return lastError;
}

public void setLastError(String lastError) {
this.lastError = lastError;
}

public Date getLastSuccessfulUpdateAt() {
return lastSuccessfulUpdateAt;
}

public void setLastSuccessfulUpdateAt(Date lastSuccessfulUpdateAt) {
this.lastSuccessfulUpdateAt = lastSuccessfulUpdateAt;
}

public Date getLastUpdateAt() {
return lastUpdateAt;
}

public void setLastUpdateAt(Date lastUpdateAt) {
this.lastUpdateAt = lastUpdateAt;
}

public Date getLastUpdateStartedAt() {
return lastUpdateStartedAt;
}

public void setLastUpdateStartedAt(Date lastUpdateStartedAt) {
this.lastUpdateStartedAt = lastUpdateStartedAt;
}

public String getUpdatedStatus() {
return updatedStatus;
}

public void setUpdatedStatus(String updatedStatus) {
this.updatedStatus = updatedStatus;
}

public String getUrl() {
return url;
}

public void setUrl(String url) {
this.url = url;
}

public Boolean getEnabled() {
return enabled;
}

public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}

public Boolean getMirrorTriggerBuilds() {
return mirrorTriggerBuilds;
}

public void setMirrorTriggerBuilds(Boolean mirrorTriggerBuilds) {
this.mirrorTriggerBuilds = mirrorTriggerBuilds;
}

public Boolean getOnlyMirrorProtectedBranches() {
return onlyMirrorProtectedBranches;
}

public void setOnlyMirrorProtectedBranches(Boolean onlyMirrorProtectedBranches) {
this.onlyMirrorProtectedBranches = onlyMirrorProtectedBranches;
}

public Boolean getMirrorOverwritesDivergedBranches() {
return mirrorOverwritesDivergedBranches;
}

public void setMirrorOverwritesDivergedBranches(Boolean mirrorOverwritesDivergedBranches) {
this.mirrorOverwritesDivergedBranches = mirrorOverwritesDivergedBranches;
}

public String getMirrorBranchRegex() {
return mirrorBranchRegex;
}

public void setMirrorBranchRegex(String mirrorBranchRegex) {
this.mirrorBranchRegex = mirrorBranchRegex;
}

@Override
public String toString() {
return JacksonJson.toJsonString(this);
}
}