Package org.azd.git.types

Class GitCommitsBatch

java.lang.Object
org.azd.abstractions.serializer.SerializableEntity
org.azd.git.types.GitCommitsBatch
public class GitCommitsBatch extends SerializableEntity
Represents a request body object for Get Commits Batch API.

  • Field Details

    • skip

      public Integer skip
      Number of entries to skip

    • top

      public Integer top
      Maximum number of entries to retrieve

    • author

      public String author
      Alias or display name of the author

    • compareVersion

      public GitVersionDescriptor compareVersion
      Only applicable when ItemVersion specified. If provided, start walking history starting at this commit.

    • 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 List<String> ids
      If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.

    • 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 GitVersionDescriptor itemVersion
      If provided, identifies the commit or branch to search

    • 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

    • GitCommitsBatch

      public GitCommitsBatch()