Package org.azd.release.definitions

Class DefinitionsRequestBuilder.ListQueryParameters

java.lang.Object
org.azd.release.definitions.DefinitionsRequestBuilder.ListQueryParameters
Enclosing class:
DefinitionsRequestBuilder
public static class DefinitionsRequestBuilder.ListQueryParameters extends Object
Represents the query parameters.

  • Field Details

    • expand

      public ReleaseDefinitionExpands expand
      The properties that should be expanded in the list of Release definitions.

    • top

      public Integer top
      Number of release definitions to get.

    • artifactSourceId

      public String artifactSourceId
      Release definitions with given artifactSourceId will be returned.

      e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId},

      for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}.

      For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at Extensions.

    • artifactType

      public String artifactType
      Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

    • continuationToken

      public String continuationToken
      Gets the release definitions after the continuation token provided.

    • definitionIdFilter

      public String definitionIdFilter
      A comma-delimited list of release definitions to retrieve.

    • isDeleted

      public Boolean isDeleted
      'true' to get release definitions that has been deleted. Default is 'false'

    • isExactNameMatch

      public Boolean isExactNameMatch
      'true' to gets the release definitions with exact match as specified in searchText. Default is 'false'.

    • path

      public String path
      Gets the release definitions under the specified path.

    • propertyFilters

      public String propertyFilters
      A comma-delimited list of extended properties to be retrieved. If set, the returned Release Definitions will contain values for the specified property Ids (if they exist). If not set, properties will not be included. Note that this will not filter out any Release Definition from results irrespective of whether it has property set or not.

    • queryOrder

      public ReleaseDefinitionQueryOrder queryOrder
      Gets the results in the defined order. Default is 'IdAscending'.

    • searchText

      public String searchText
      Get release definitions with names containing searchText.

    • searchTextContainsFolderName

      public Boolean searchTextContainsFolderName
      'true' to get the release definitions under the folder with name as specified in searchText. Default is 'false'.

    • tagFilter

      public String tagFilter
      A comma-delimited list of tags. Only release definitions with these tags will be returned.

  • Constructor Details

    • ListQueryParameters

      public ListQueryParameters()