Skip navigation links

Atlassian Bamboo Plan Specs 9.0.0 API

Packages 
Package Description
com.atlassian.bamboo.specs.api
Contains base @BambooSpec annotation used to mark classes containing configuration as code.
com.atlassian.bamboo.specs.api.annotations
Helper annotations.
com.atlassian.bamboo.specs.api.builders
The 'builders.*' packages contain classes you can use to define your Bamboo configuration as code, see also com.atlassian.bamboo.specs.builders.
com.atlassian.bamboo.specs.api.builders.applink
Application Links (for instance to integrate with JIRA or Bitbucket Server).
com.atlassian.bamboo.specs.api.builders.condition
Task conditions.
com.atlassian.bamboo.specs.api.builders.credentials
Shared credentials for authenticating repositories or AWS access.
com.atlassian.bamboo.specs.api.builders.deployment
Deployment project and environments.
com.atlassian.bamboo.specs.api.builders.deployment.configuration
Items stored in environment custom plugins configuration.
com.atlassian.bamboo.specs.api.builders.docker
Builder classes for Docker configuration.
com.atlassian.bamboo.specs.api.builders.label
Bamboo labels support.
com.atlassian.bamboo.specs.api.builders.notification
Bamboo notifications support.
com.atlassian.bamboo.specs.api.builders.permission
Permissions like plan permissions, deployment permissions etc.
com.atlassian.bamboo.specs.api.builders.plan
Plan, plan branches, stages and jobs.
com.atlassian.bamboo.specs.api.builders.plan.artifact
Artifact definitions and artifact subscriptions.
com.atlassian.bamboo.specs.api.builders.plan.branches
Automatic branch creation, integration and cleanup.
com.atlassian.bamboo.specs.api.builders.plan.configuration
Items stored in plan configuration, including (but not limited to) items from 'Miscellaneous' page.
com.atlassian.bamboo.specs.api.builders.plan.dependencies
Plan dependencies (so that build of one plan may trigger builds of another plans).
com.atlassian.bamboo.specs.api.builders.project
Bamboo project (which is a container for plans).
com.atlassian.bamboo.specs.api.builders.repository
Generic plan-local and linked source code repositories as well as change detection settings, see also com.atlassian.bamboo.specs.builders.repository for specific repository types.
com.atlassian.bamboo.specs.api.builders.repository.viewer
Generic repository viewers, see also com.atlassian.bamboo.specs.builders.repository.viewer for specific viewers.
com.atlassian.bamboo.specs.api.builders.requirement
Custom requirements for a job.
com.atlassian.bamboo.specs.api.builders.task
Generic classes, such as the AnyTask class for handling tasks unsupported by Bamboo Specs.
com.atlassian.bamboo.specs.api.builders.trigger
Build triggers.
com.atlassian.bamboo.specs.api.codegen
Conversion of EntityProperties model into Java.
com.atlassian.bamboo.specs.api.codegen.annotations
Annotations used for conversion of EntityProperties model into Java.
com.atlassian.bamboo.specs.api.context
Runtime context for RSS.
com.atlassian.bamboo.specs.api.exceptions
Exceptions thrown by Bamboo Specs library.
com.atlassian.bamboo.specs.api.model
The 'model.*' packages contain internal data representation of various Bamboo entities, you usually won't use them directly.
com.atlassian.bamboo.specs.api.model.applink
Application Links (for instance to integrate with JIRA or Bitbucket Server).
com.atlassian.bamboo.specs.api.model.credentials
Shared credentials for authenticating repositories or AWS access.
com.atlassian.bamboo.specs.api.model.deployment
Deployment project and environments.
com.atlassian.bamboo.specs.api.model.deployment.configuration
Items stored in environment custom plugins configuration.
com.atlassian.bamboo.specs.api.model.docker
Properties classes for Docker configuration.
com.atlassian.bamboo.specs.api.model.label
Bamboo labels support.
com.atlassian.bamboo.specs.api.model.notification
Bamboo notifications support.
com.atlassian.bamboo.specs.api.model.permission
Immutable permissions like plan permissions properties, deployment permissions properties etc.
com.atlassian.bamboo.specs.api.model.plan
Plan, plan branches, stages and jobs.
com.atlassian.bamboo.specs.api.model.plan.artifact
Artifact definitions and artifact subscriptions.
com.atlassian.bamboo.specs.api.model.plan.branches
Automatic branch creation, integration and cleanup.
com.atlassian.bamboo.specs.api.model.plan.condition
Task conditions.
com.atlassian.bamboo.specs.api.model.plan.configuration
Items stored in plan configuration, including (but not limited to) items from 'Miscellaneous' page.
com.atlassian.bamboo.specs.api.model.plan.dependencies
Plan dependencies (so that build of one plan may trigger builds of another plans).
com.atlassian.bamboo.specs.api.model.plan.requirement
Custom requirements for a job.
com.atlassian.bamboo.specs.api.model.project
Bamboo project (which is a container for plans).
com.atlassian.bamboo.specs.api.model.repository
Generic plan-local and linked source code repositories as well as change detection settings.
com.atlassian.bamboo.specs.api.model.repository.viewer
Generic repository viewers.
com.atlassian.bamboo.specs.api.model.task
The AnyTask class for handling tasks unsupported by Bamboo Specs.
com.atlassian.bamboo.specs.api.model.trigger
Build triggers.
com.atlassian.bamboo.specs.api.rsbs
Contains classes used for interaction with Runners.
com.atlassian.bamboo.specs.api.util
Utility classes, such as: creating cron expressions.
com.atlassian.bamboo.specs.api.validators
The 'validators.*' packages contain data validators, you usually won't call them directly, unless writing own builders.
com.atlassian.bamboo.specs.api.validators.common
Common validators for strings, numbers, database constraints etc.
com.atlassian.bamboo.specs.api.validators.permission
Validate permissions.
com.atlassian.bamboo.specs.api.validators.plan
Validate plan and stage settings.
com.atlassian.bamboo.specs.api.validators.plan.branch
Validate configuration of plan branches.
com.atlassian.bamboo.specs.api.validators.project
Validate project settings.
com.atlassian.bamboo.specs.api.validators.repository
Validate generic VCS settings.
com.atlassian.bamboo.specs.builders
The 'builders.*' packages contain classes you can use to define your Bamboo configuration as code.
com.atlassian.bamboo.specs.builders.credentials
Shared credentials for user-password and SSH authentication.
com.atlassian.bamboo.specs.builders.notification
Bamboo notifications support.
com.atlassian.bamboo.specs.builders.plugin
Bamboo miscellaneous plugins support.
com.atlassian.bamboo.specs.builders.repository
Various types of source code repositories.
com.atlassian.bamboo.specs.builders.repository.bitbucket.cloud
Bitbucket Cloud repository type.
com.atlassian.bamboo.specs.builders.repository.bitbucket.server
Bitbucket Server repository type.
com.atlassian.bamboo.specs.builders.repository.git
Git repository type.
com.atlassian.bamboo.specs.builders.repository.github
GitHub repository type.
com.atlassian.bamboo.specs.builders.repository.viewer
Repository viewers, such as: Fisheye, Bitbucket Server and Cloud or 'hg serve' service.
com.atlassian.bamboo.specs.builders.task
Tasks you can execute in a job, such as: source code checkout, Maven build or a shell script.
com.atlassian.bamboo.specs.builders.trigger
Build triggers.
com.atlassian.bamboo.specs.codegen
Conversion of EntityProperties model into Java.
com.atlassian.bamboo.specs.codegen.emitters
Various implementations of CodeEmitter which are used for converting EntityProperties model into Java.
com.atlassian.bamboo.specs.codegen.emitters.credentials
Various implementations of CodeEmitter which are used for converting EntityProperties model into Java.
com.atlassian.bamboo.specs.codegen.emitters.docker
Emitters for Bamboo Docker configuration.
com.atlassian.bamboo.specs.codegen.emitters.fragment
Various implementations of CodeEmitter which are used for converting EntityProperties model into Java.
com.atlassian.bamboo.specs.codegen.emitters.notification
Various implementations of CodeEmitter which are used for converting EntityProperties model into Java.
com.atlassian.bamboo.specs.codegen.emitters.permission
Various implementations of CodeEmitter which are used for converting permission related EntityProperties model into Java.
com.atlassian.bamboo.specs.codegen.emitters.plan
Various implementations of CodeEmitter which are used for converting Plan-related settings model into Java.
com.atlassian.bamboo.specs.codegen.emitters.plan.branches
Various implementations of CodeEmitter which are used for converting PlanBranchManagement-related settings model into Java.
com.atlassian.bamboo.specs.codegen.emitters.plugin
Emitters for Bamboo miscellaneous plugins.
com.atlassian.bamboo.specs.codegen.emitters.repository
Various implementations of CodeEmitter which are used for converting VcsRepositoryProperties model into Java.
com.atlassian.bamboo.specs.codegen.emitters.repository.viewer
Various implementations of CodeEmitter which are used for converting VcsRepositoryViewerProperties model into Java.
com.atlassian.bamboo.specs.codegen.emitters.task
Various implementations of CodeEmitter which are used for converting TaskProperties model into Java.
com.atlassian.bamboo.specs.codegen.emitters.trigger
Various implementations of CodeEmitter which are used for converting TriggerProperties model into Java.
com.atlassian.bamboo.specs.codegen.emitters.value
Various implementations of CodeEmitter which are used for converting EntityProperties model into Java.
com.atlassian.bamboo.specs.exceptions
Various exceptions thrown by Bamboo Specs.
com.atlassian.bamboo.specs.maven
Contains classes that allow Bamboo specs to be run with maven.
com.atlassian.bamboo.specs.maven.sandbox
Contains classes to allow running Bamboo specs in secure way.
com.atlassian.bamboo.specs.model
The 'model.*' packages contain internal data representation of various Bamboo entities, you usually won't use them directly.
com.atlassian.bamboo.specs.model.credentials
Shared credentials for user-password and SSH authentication.
com.atlassian.bamboo.specs.model.notification
Bamboo notifications support.
com.atlassian.bamboo.specs.model.plugin
Bamboo miscellaneous plugins support.
com.atlassian.bamboo.specs.model.repository.bitbucket.cloud
Bitbucket Cloud repository type.
com.atlassian.bamboo.specs.model.repository.bitbucket.server
Bitbucket Server repository type.
com.atlassian.bamboo.specs.model.repository.git
Git repository type.
com.atlassian.bamboo.specs.model.repository.github
GitHub repository type.
com.atlassian.bamboo.specs.model.repository.viewer
Repository viewers.
com.atlassian.bamboo.specs.model.task
Tasks you can execute in a job.
com.atlassian.bamboo.specs.model.task.docker
Properties classes related to Docker CLI task.
com.atlassian.bamboo.specs.model.trigger
Build triggers.
com.atlassian.bamboo.specs.util
Utility classes, such as the BambooServer which publishes a plan on Bamboo.
com.atlassian.bamboo.specs.validators.common
Common validators, such as: IP addresses.
Skip navigation links

Copyright © 2022 Atlassian Software Systems Pty Ltd. All rights reserved.