Package org.azd.git.refs

Class RefsRequestBuilder.GetQueryParameters

java.lang.Object

org.azd.git.refs.RefsRequestBuilder.GetQueryParameters

Enclosing class:

RefsRequestBuilder

public static class RefsRequestBuilder.GetQueryParameters
extends Object

Represents the query parameters.

Field Summary

Fields

Modifier and Type	Field	Description
String	continuationToken	The continuation token used for pagination.
String	filter	A filter to apply to the refs (starts with).
String	filterContains	A filter to apply to the refs (contains).
Boolean	includeLinks	Specifies if referenceLinks should be included in the result.
Boolean	includeMyBranches	Includes only branches that the user owns, the branches the user favorites, and the default branch.
Boolean	includeStatuses	Includes up to the first 1000 commit statuses for each ref.
Boolean	latestStatusesOnly	True to include only the tip commit status for each ref.
Boolean	peelTags	Annotated tags will populate the PeeledObjectId property.
Integer	top	Maximum number of refs to return.

Constructor Summary

Constructors

Constructor	Description
GetQueryParameters()

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 refs to return. It cannot be bigger than 1000. If it is not provided but continuationToken is, top will default to 100.

continuationToken

public String continuationToken

The continuation token used for pagination.

filter

public String filter

A filter to apply to the refs (starts with).

filterContains

public String filterContains

A filter to apply to the refs (contains).

includeLinks

public Boolean includeLinks

Specifies if referenceLinks should be included in the result. default is false.

includeMyBranches

public Boolean includeMyBranches

Includes only branches that the user owns, the branches the user favorites, and the default branch. The default value is false. Cannot be combined with the filter parameter.

includeStatuses

public Boolean includeStatuses

Includes up to the first 1000 commit statuses for each ref. The default value is false.

latestStatusesOnly

public Boolean latestStatusesOnly

True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.

peelTags

public Boolean peelTags

Annotated tags will populate the PeeledObjectId property. default is false.

Constructor Details

GetQueryParameters

public GetQueryParameters()