java.lang.Object
- com.spotify.github.v3.clients.GitDataClient

public class GitDataClient
extends Object

Reference Api client

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`CompletableFuture<Tag>`	`createAnnotatedTag(String tag, String sha, String tagMessage, String taggerName, String taggerEmail)`	Create an annotated tag.
`CompletableFuture<Reference>`	`createBranchReference(String branch, String sha)`	Create a git branch reference.
`CompletableFuture<Reference>`	`createReference(String ref, String sha)`	Create a git reference.
`CompletableFuture<Reference>`	`createTagReference(String tag, String sha)`	Create a git tag reference.
`CompletableFuture<Void>`	`deleteBranch(String branch)`	Deletes a git branch.
`CompletableFuture<Void>`	`deleteReference(String ref)`	Deletes a git reference.
`CompletableFuture<Void>`	`deleteTag(String tag)`	Deletes a git tag.
`CompletableFuture<Reference>`	`getBranchReference(String branch)`	Get a git branch reference
`CompletableFuture<Tag>`	`getTag(String tag)`	Get a git annotated tag.
`CompletableFuture<Reference>`	`getTagReference(String tag)`	Get a git tag reference.
`CompletableFuture<List<Reference>>`	`listMatchingReferences(String ref)`	List matching references.
`CompletableFuture<List<Reference>>`	`listReferences()`	Deprecated.
`CompletableFuture<List<Reference>>`	`listReferences(String ref)`	Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

deleteReference
```
public CompletableFuture<Void> deleteReference(String ref)
```
Deletes a git reference.

Parameters:

ref - search parameters

deleteBranch
```
public CompletableFuture<Void> deleteBranch(String branch)
```
Deletes a git branch.

Parameters:

branch - search parameters

deleteTag

public CompletableFuture<Void> deleteTag(String tag)

Deletes a git tag.

Parameters:: tag - search parameters

getBranchReference

public CompletableFuture<Reference> getBranchReference(String branch)

Get a git branch reference

Parameters:: branch - branch name

getTagReference

public CompletableFuture<Reference> getTagReference(String tag)

Get a git tag reference.

Parameters:: tag - tag name

getTag

public CompletableFuture<Tag> getTag(String tag)

Get a git annotated tag.

Parameters:: tag - tag name

listMatchingReferences

public CompletableFuture<List<Reference>> listMatchingReferences(String ref)

List matching references.

Parameters:: ref - reference name

listReferences
```
@Deprecated
public CompletableFuture<List<Reference>> listReferences(String ref)
```
Deprecated.

List references. (Replaced by listMatchingReferences for github enterprise version > 2.18)

Parameters:

ref - reference name

listReferences
```
@Deprecated
public CompletableFuture<List<Reference>> listReferences()
```
Deprecated.

List references. (Replaced by listMatchingReferences for github enterprise version > 2.18)

createReference

public CompletableFuture<Reference> createReference(String ref,
                                                    String sha)

Create a git reference.

Parameters:: ref - reference name; sha - commit to branch from

createBranchReference

public CompletableFuture<Reference> createBranchReference(String branch,
                                                          String sha)

Create a git branch reference. It must not include the refs/heads.

Parameters:: branch - tag name; sha - commit to branch from

createTagReference

public CompletableFuture<Reference> createTagReference(String tag,
                                                       String sha)

Create a git tag reference. It must not include the refs/tags.

Parameters:: tag - tag name; sha - commit to tag

createAnnotatedTag

public CompletableFuture<Tag> createAnnotatedTag(String tag,
                                                 String sha,
                                                 String tagMessage,
                                                 String taggerName,
                                                 String taggerEmail)

Create an annotated tag. First it would create a tag reference and then create annotated tag

Parameters:: tag - tag name; sha - commit to tag; tagMessage - message; taggerName - name of the tagger; taggerEmail - email of the tagger

Class GitDataClient