Package org.azd.git.commits

Class CommitsRequestBuilder.GetCommitsQueryParameters

java.lang.Object

org.azd.git.commits.CommitsRequestBuilder.GetCommitsQueryParameters

Enclosing class:

CommitsRequestBuilder

public static class CommitsRequestBuilder.GetCommitsQueryParameters
extends Object

Represents the query parameters.

Field Summary

Fields

Modifier and Type	Field	Description
String	author	Alias or display name of the author
String	compareVersion	Version String identifier (name of tag/branch, SHA1 of commit)
GitVersionOptions	compareVersionOptions	Version options - Specify additional modifiers to version (e.g Previous)
GitVersionType	compareVersionType	Version type (branch, tag, or commit).
Boolean	excludeDeletes	Only applies when an itemPath is specified.
String	fromCommitId	If provided, a lower bound for filtering commits alphabetically
String	fromDate	If provided, only include history entries created after this date (String)
GitHistoryMode	historyMode	What Git history mode should be used.
String	ids	If provided, specifies the exact commit ids of the commits to fetch.
Boolean	includeLinks	Whether to include the _links field on the shallow references
Boolean	includePushData	Whether to include the push information
Boolean	includeUserImageUrl	Whether to include the image Url for committers and authors
Boolean	includeWorkItems	Whether to include linked work items
String	itemPath	Path of item to search under
String	itemVersion	Version String identifier (name of tag/branch, SHA1 of commit)
GitVersionOptions	itemVersionOptions	Version options - Specify additional modifiers to version (e.g Previous)
GitVersionType	itemVersionType	Version type (branch, tag, or commit).
Boolean	showOldestCommitsFirst	If enabled, this option will ignore the itemVersion and compareVersion parameters
Integer	skip	Number of entries to skip
String	toCommitId	If provided, an upper bound for filtering commits alphabetically
String	toDate	If provided, only include history entries created before this date (String)
Integer	top	Maximum number of entries to retrieve.
String	user	Alias or display name of the committer

Constructor Summary

Constructors

Constructor	Description
GetCommitsQueryParameters()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

top

public Integer top

Maximum number of entries to retrieve.

skip

public Integer skip

Number of entries to skip

author

public String author

Alias or display name of the author

compareVersion

public String compareVersion

Version String identifier (name of tag/branch, SHA1 of commit)

compareVersionOptions

public GitVersionOptions compareVersionOptions

Version options - Specify additional modifiers to version (e.g Previous)

compareVersionType

public GitVersionType compareVersionType

Version type (branch, tag, or commit). Determines how Id is interpreted

excludeDeletes

public Boolean excludeDeletes

Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.

fromCommitId

public String fromCommitId

If provided, a lower bound for filtering commits alphabetically

fromDate

public String fromDate

If provided, only include history entries created after this date (String)

historyMode

public GitHistoryMode historyMode

What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.

ids

public String ids

If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.

includeLinks

public Boolean includeLinks

Whether to include the _links field on the shallow references

includePushData

public Boolean includePushData

Whether to include the push information

includeUserImageUrl

public Boolean includeUserImageUrl

Whether to include the image Url for committers and authors

includeWorkItems

public Boolean includeWorkItems

Whether to include linked work items

itemPath

public String itemPath

Path of item to search under

itemVersion

public String itemVersion

Version String identifier (name of tag/branch, SHA1 of commit)

itemVersionOptions

public GitVersionOptions itemVersionOptions

Version options - Specify additional modifiers to version (e.g Previous)

itemVersionType

public GitVersionType itemVersionType

Version type (branch, tag, or commit). Determines how Id is interpreted

showOldestCommitsFirst

public Boolean showOldestCommitsFirst

If enabled, this option will ignore the itemVersion and compareVersion parameters

toCommitId

public String toCommitId

If provided, an upper bound for filtering commits alphabetically

toDate

public String toDate

If provided, only include history entries created before this date (String)

user

public String user

Alias or display name of the committer

Constructor Details

GetCommitsQueryParameters

public GetCommitsQueryParameters()