Package com.atlassian.marketplace.client.model

Entities that can be returned by the Atlassian Marketplace API.

See: Description

Interface Summary

Interface	Description
Entity	Common properties defined for resource entities in the Marketplace API.
ModelBuilders.SafeBuilder<T>	Common interface for builders that will always succeed in building an object; any required properties that you do not set will be given default values.
ModelBuilders.UnsafeBuilder<T>	Common interface for builders that do not provide any default values for required properties, and will throw an exception if you try to call build() before you have set all the required properties.

Class Summary

Class	Description
Addon	Information about an add-on.
AddonBase	Properties that exist in both Addon and AddonSummary.
AddonCategorySummary	Describes a category that add-ons can be listed in.
AddonDistributionSummary	Information about the download/install counts for an add-on.
AddonPricing	Information about the pricing of a paid-via-Atlassian add-on.
AddonPricing.RoleInfo	Additional information describing the pricing role for a role-based plugin.
AddonPricingItem	An individual pricing tier within AddonPricing.
AddonReference	Minimal data about an add-on listing, even less detailed than AddonSummary.
AddonReviewsSummary	Summary information about user reviews for an add-on.
AddonSummary	A more concise representation of an Addon when it is embedded in another response.
AddonVersion	Information about a specific version of an Addon.
AddonVersionBase	Properties that exist in both AddonVersion and AddonVersionSummary.
AddonVersionSummary	A more concise representation of an AddonVersion when it is embedded in another response.
Address	Standard postal address properties.
Application	Information about an Atlassian application/platform, such as JIRA.
ApplicationVersion	Information about a specific version of an Application.
ArtifactInfo	Information about an installable file hosted by Marketplace.
ConnectScope	Information about an Atlassian Connect scope that is used by an AddonVersion.
ErrorDetail	Details of an error returned by the server.
Highlight	One of the "highlight" image/text sections that can be part of AddonVersion details.
HtmlString	Simple value wrapper for a string that can contain HTML markup.
ImageInfo	Represents an image hosted by Marketplace, such as an add-on logo.
LicenseType	Information about a type of software license.
Link	A resource/web hyperlink in the HAL-JSON format used by the Marketplace version 2 API.
Links	A links map in the HAL-JSON format used by the Marketplace version 2 API.
ModelBuilders	Classes for constructing model objects for the 2.0 API.
ModelBuilders.AddonBuilder
ModelBuilders.AddonVersionBuilder
ModelBuilders.AddressBuilder
ModelBuilders.ApplicationVersionBuilder
ModelBuilders.BuilderWithLinks<T extends ModelBuilders.BuilderWithLinks<T>>
ModelBuilders.HighlightBuilder
ModelBuilders.LinksBuilder
ModelBuilders.ScreenshotBuilder
ModelBuilders.UnsafeBuilderWithLinks<A,T extends ModelBuilders.UnsafeBuilderWithLinks<A,T>>
ModelBuilders.VendorBuilder
Product	Information about an Atlassian software package, such as JIRA Service Desk.
ProductVersion	Information about a specific version of a Product.
Screenshot	One of the additional screenshots that can be part of AddonVersion details.
TestModelBuilders	Classes for constructing model objects for the 2.0 API that normally are only ever returned by the server, so that the only reason for constructing them yourself is to provide fake data for testing your own code.
TestModelBuilders.AddonBuilder
TestModelBuilders.AddonCategorySummaryBuilder
TestModelBuilders.AddonDistributionSummaryBuilder
TestModelBuilders.AddonPricingBuilder
TestModelBuilders.AddonPricingItemBuilder
TestModelBuilders.AddonReferenceBuilder
TestModelBuilders.AddonSummaryBuilder
TestModelBuilders.AddonVersionBuilder
TestModelBuilders.AddonVersionSummaryBuilder
TestModelBuilders.ApplicationBuilder
TestModelBuilders.ApplicationVersionBuilder
TestModelBuilders.ImageInfoBuilder
TestModelBuilders.ProductBuilder
TestModelBuilders.ProductVersionBuilder
TestModelBuilders.VendorBuilder
TestModelBuilders.VendorSummaryBuilder
Vendor	Details about a vendor.
VendorBase	Properties that exist in both Vendor and VendorSummary.
VendorSummary	A concise representation of a Vendor when it is embedded in another response.
VersionCompatibility	A range of application versions compatible with an add-on version or product version.

Enum Summary

Enum	Description
AddonStatus	Indicates whether an Addon is publicly visible, private, or pending approval.
AddonVersionStatus	Indicates whether an AddonVersion is publicly visible, private, or pending approval.
Application.CompatibilityUpdateMode	Indicates how Marketplace will update add-on compatibilities when a new application version is released.
ApplicationStatus	Indicates whether an Application is publicly visible or not.
ApplicationVersionStatus	Indicates whether an ApplicationVersion is publicly visible or not.
ImageInfo.Resolution	Image resolution constants for use with ImageInfo.getImageUri(Size, Resolution)).
ImageInfo.Size	Image size constants for use with ImageInfo.getImageUri(Size, Resolution)).
LicenseEditionType	Describes the type of license edition for an AddonPricingItem.
PaymentModel	Indicates which payment system, if any, is used for buying licenses for an add-on.

Exception Summary

Exception	Description
ModelBuilders.InvalidModelException	ModelBuilders methods that declare this checked exception will throw it if you attempt to construct a model object that does not conform to the Marketplace API schema, for instance by omitting a required property.

Annotation Types Summary

Annotation Type	Description
ReadOnly	This annotation is used internally to denote model properties that should not be serialized.
RequiredLink	This annotation is used internally to denote required link relations in model classes.

Package com.atlassian.marketplace.client.model Description

Entities that can be returned by the Atlassian Marketplace API.

Characteristics of these classes:

• They are all immutable.
• No property getter method will ever return null. Optional properties use the Option type to represent either a value or "none".
• Any string properties that support HTML markup will use the HtmlString class; if you want to display any string property in a browser that does not use HtmlString, you should HTML-escape it first.
• All DateTime values are UTC. Date properties that are not associated with a time or time zone use LocalDate instead.
• Many entities have a getLinks() method that returns an object containing REST API links. Links with special meanings can be accessed through convenience methods on the model objects; avoid using the links map directly.
• Constructors are package-private and are not meant to be used directly. Use ModelBuilders if you need to construct instances of these classes.

Classes that encapsulate parameters to be passed to an API, rather than objects returned from the server, are in the com.atlassian.marketplace.client.api package.