AddonQuery (Atlassian Marketplace Client 3.0.2 API)

java.lang.Object
- com.atlassian.marketplace.client.api.AddonQuery

All Implemented Interfaces:

QueryProperties.AccessToken, QueryProperties.ApplicationCriteria, QueryProperties.Bounds, QueryProperties.Cost, QueryProperties.IncludePrivate, QueryProperties.MultiHosting, QueryProperties.WithVersion
```
public final class AddonQuery
extends Object
implements QueryProperties.AccessToken, QueryProperties.ApplicationCriteria, QueryProperties.Bounds, QueryProperties.Cost, QueryProperties.MultiHosting, QueryProperties.IncludePrivate, QueryProperties.WithVersion
```
Encapsulates search parameters that can be passed to Addons to determine what subset of add-on listings you are interested in and/or what information should be included in the results.

Since:

2.0.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AddonQuery.Builder` Builder class for `AddonQuery`.
`static class`	`AddonQuery.IncludeHiddenType` Constants representing subsets of add-ons that are normally hidden but may still be queried.
`static class`	`AddonQuery.TreatPartlyFreeAs` Determines how paid-via-Atlassian add-ons with free tiers, such as those where the vendor has opted into the Cloud free-for-five tier, are treated in queries.
`static class`	`AddonQuery.View` Constants representing preset add-on list views, which may affect both the set of add-ons being queried and the sort order of the results.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AddonQuery`	`any()` Returns an `AddonQuery` with no criteria, which will match any available add-on.
`static AddonQuery.Builder`	`builder()` Returns a new `AddonQuery.Builder` for constructing an AddonQuery.
`static AddonQuery.Builder`	`builder(AddonQuery query)` Returns a new `AddonQuery.Builder` for constructing an `AddonQuery` based on an existing `AddonQuery`.
`boolean`	`equals(Object other)`
`QueryBounds`	`getBounds()` The offset/limit parameters attached to this query.
`Iterable<String>`	`getCategoryNames()` The list of add-on category names, if any, that the client has specified to restrict the query results.
`List<HostingType>`	`getHostings()` The hosting type that the client is using to restrict the query, if any.
`int`	`hashCode()`
`boolean`	`isForThisUserOnly()` True if the client is querying only add-ons that are associated with the current authenticated user's vendor(s).
`boolean`	`isIncludePrivate()` True if the client is querying private add-ons as well as public add-ons.
`boolean`	`isWithVersion()` True if the client is requesting version-level detail in the result set.
`Optional<String>`	`safeGetAccessToken()` The access token, if any, that the client is providing for the query (in order to allow access to a private listing).
`Optional<Integer>`	`safeGetAppBuildNumber()` The application build number, if any, that the client is using to restrict the query results.
`Optional<ApplicationKey>`	`safeGetApplication()` The key of the application, if any, that the client is using to restrict the query results.
`Optional<Cost>`	`safeGetCost()` The `Cost` filter, if any, that the client is using to restrict the query results.
`Optional<HostingType>`	`safeGetHosting()`
`Optional<AddonQuery.IncludeHiddenType>`	`safeGetIncludeHidden()` The subset of normally hidden add-ons, if any, that the client has specified to include in the query results.
`Optional<String>`	`safeGetLabel()` The marketing label string, if any, that the client has specified to restrict the query results.
`Optional<String>`	`safeGetSearchText()` The search text, if any, that the client has specified for the query.
`Optional<AddonQuery.TreatPartlyFreeAs>`	`safeGetTreatPartlyFreeAs()` The `AddonQuery.TreatPartlyFreeAs` value, if any, that the client has specified to determine how free-tier listings will be treated in the query.
`Optional<AddonQuery.View>`	`safeGetView()` The `AddonQuery.View` value, if any, that the client has specified as a filter and/or sort order for the query.
`String`	`toString()`

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

- Method Detail
  - builder
```
public static AddonQuery.Builder builder()
```
    Returns a new AddonQuery.Builder for constructing an AddonQuery.
  - any
```
public static AddonQuery any()
```
    Returns an AddonQuery with no criteria, which will match any available add-on.
  - builder
```
public static AddonQuery.Builder builder(AddonQuery query)
```
    Returns a new AddonQuery.Builder for constructing an AddonQuery based on an existing AddonQuery.
  - safeGetAccessToken
```
public Optional<String> safeGetAccessToken()
```
    Description copied from interface: QueryProperties.AccessToken
    
    The access token, if any, that the client is providing for the query (in order to allow access to a private listing).
    
    Specified by:
    
    safeGetAccessToken in interface QueryProperties.AccessToken
    
    See Also:
    
    QueryBuilderProperties.AccessToken.accessToken(Optional)
  - safeGetApplication
```
public Optional<ApplicationKey> safeGetApplication()
```
    Description copied from interface: QueryProperties.ApplicationCriteria
    
    The key of the application, if any, that the client is using to restrict the query results.
    
    Specified by:
    
    safeGetApplication in interface QueryProperties.ApplicationCriteria
    
    See Also:
    
    QueryBuilderProperties.ApplicationCriteria.application(Optional)
  - safeGetAppBuildNumber
```
public Optional<Integer> safeGetAppBuildNumber()
```
    Description copied from interface: QueryProperties.ApplicationCriteria
    
    The application build number, if any, that the client is using to restrict the query results.
    
    Specified by:
    
    safeGetAppBuildNumber in interface QueryProperties.ApplicationCriteria
    
    See Also:
    
    QueryBuilderProperties.ApplicationCriteria.appBuildNumber(Optional)
  - getCategoryNames
```
public Iterable<String> getCategoryNames()
```
    The list of add-on category names, if any, that the client has specified to restrict the query results.
    
    See Also:
    
    AddonQuery.Builder.categoryNames(Iterable)
  - safeGetCost
```
public Optional<Cost> safeGetCost()
```
    Description copied from interface: QueryProperties.Cost
    
    The Cost filter, if any, that the client is using to restrict the query results.
    
    Specified by:
    
    safeGetCost in interface QueryProperties.Cost
    
    See Also:
    
    QueryBuilderProperties.Cost.cost(Optional)
  - isForThisUserOnly
```
public boolean isForThisUserOnly()
```
    True if the client is querying only add-ons that are associated with the current authenticated user's vendor(s).
    
    See Also:
    
    AddonQuery.Builder.forThisUserOnly(boolean)
  - safeGetIncludeHidden
```
public Optional<AddonQuery.IncludeHiddenType> safeGetIncludeHidden()
```
    The subset of normally hidden add-ons, if any, that the client has specified to include in the query results.
    
    See Also:
    
    AddonQuery.Builder.includeHidden(Optional)
  - isIncludePrivate
```
public boolean isIncludePrivate()
```
    True if the client is querying private add-ons as well as public add-ons.
    
    Specified by:
    
    isIncludePrivate in interface QueryProperties.IncludePrivate
    
    See Also:
    
    AddonQuery.Builder.includePrivate(boolean)
  - safeGetHosting
```
public Optional<HostingType> safeGetHosting()
```
  - getHostings
```
public List<HostingType> getHostings()
```
    Description copied from interface: QueryProperties.MultiHosting
    
    The hosting type that the client is using to restrict the query, if any.
    
    Specified by:
    
    getHostings in interface QueryProperties.MultiHosting
    
    Since:
    
    2.1.0
    
    See Also:
    
    QueryBuilderProperties.MultiHosting.hosting(List)
  - safeGetLabel
```
public Optional<String> safeGetLabel()
```
    The marketing label string, if any, that the client has specified to restrict the query results.
    
    See Also:
    
    AddonQuery.Builder.label(Optional)
  - safeGetTreatPartlyFreeAs
```
public Optional<AddonQuery.TreatPartlyFreeAs> safeGetTreatPartlyFreeAs()
```
    The AddonQuery.TreatPartlyFreeAs value, if any, that the client has specified to determine how free-tier listings will be treated in the query.
    
    See Also:
    
    AddonQuery.Builder.treatPartlyFreeAs(Optional)
  - safeGetSearchText
```
public Optional<String> safeGetSearchText()
```
    The search text, if any, that the client has specified for the query.
    
    See Also:
    
    AddonQuery.Builder.searchText(Optional)
  - safeGetView
```
public Optional<AddonQuery.View> safeGetView()
```
    The AddonQuery.View value, if any, that the client has specified as a filter and/or sort order for the query.
    
    See Also:
    
    AddonQuery.Builder.view(Optional)
  - isWithVersion
```
public boolean isWithVersion()
```
    Description copied from interface: QueryProperties.WithVersion
    
    True if the client is requesting version-level detail in the result set.
    
    Specified by:
    
    isWithVersion in interface QueryProperties.WithVersion
    
    See Also:
    
    QueryBuilderProperties.WithVersion.withVersion(boolean)
  - getBounds
```
public QueryBounds getBounds()
```
    Description copied from interface: QueryProperties.Bounds
    
    The offset/limit parameters attached to this query.
    
    Specified by:
    
    getBounds in interface QueryProperties.Bounds
    
    See Also:
    
    QueryBuilderProperties.Bounds.bounds(QueryBounds)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AddonQuery

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

any

builder

safeGetAccessToken

safeGetApplication

safeGetAppBuildNumber

getCategoryNames

safeGetCost

isForThisUserOnly

safeGetIncludeHidden

isIncludePrivate

safeGetHosting

getHostings

safeGetLabel

safeGetTreatPartlyFreeAs

safeGetSearchText

safeGetView

isWithVersion

getBounds

toString

equals

hashCode