@PublicApi
public interface VariableDefinitionAccessor
Modifier and Type | Method and Description |
---|---|
@NotNull Long |
countAllProjectsVariables()
Count all project variables.
|
int |
countDeploymentEnvironmentVariables(long environmentId)
Count list of environment variables associated with a given deployment environment
|
@NotNull List<Long> |
findAllProjectsIdsUsingProjectVariables()
Get list of all project variables
|
@Nullable VariableDefinition |
findVariableDefinition(long id)
Find variable definition of specified id
|
@NotNull List<VariableDefinition> |
getDeploymentEnvironmentVariables(long environmentId)
Get list of environment variables associated with a given deployment environment
|
@NotNull List<VariableDefinition> |
getDeploymentVersionVariables(long deploymentVersionId)
Get list of environment variables associated with a given deployment version
|
@NotNull List<VariableDefinition> |
getGlobalNotOverriddenEnvironmentVariables(long environmentId) |
@NotNull List<VariableDefinition> |
getGlobalNotOverriddenVariables(@NotNull long projectId)
Get list of all global variables that are not overridden by project variables for a given project
|
@NotNull List<VariableDefinition> |
getGlobalNotOverriddenVariables(@NotNull PlanIdentifier plan)
Deprecated.
since 7.1 use
getInheritedNotOverriddenVariables(PlanIdentifier) instead |
@Nullable VariableDefinition |
getGlobalVariableByKey(String key)
Retrieves a specific global variable by key.
|
@NotNull List<VariableDefinition> |
getGlobalVariables()
Get list of all global variables
|
@NotNull List<VariableDefinition> |
getInheritedNotOverriddenVariables(@NotNull PlanIdentifier plan)
Get list of all variables that are inherited by plan, that is all global, project and (in case of branches) default plan variables that are not overridden by a plan or plan branch.
|
@NotNull List<VariableDefinition> |
getInheritedVariables(@NotNull PlanIdentifier plan)
Get list of all variables that are inherited by plan, that is all global, project and (in case of branches) default plan variables.
|
@Nullable VariableDefinition |
getPlanVariableByKey(@NotNull PlanIdentifier plan,
@NotNull String key)
Retrieves a specific variable for the plan with the given key
|
@NotNull List<VariableDefinition> |
getPlanVariables(@NotNull PlanIdentifier plan)
Get list of plan variables associated with a given plan
|
@NotNull List<VariableDefinition> |
getProjectVariables(long projectId)
Get list of environment variables associated with a given project
|
@NotNull Map<String,String> |
getSimpleVariableMapByType(@NotNull VariableContext variableContext,
@NotNull VariableType variableType)
Filter variable context by variable type and return as simple key/value map
|
@Nullable @Nullable VariableDefinition findVariableDefinition(long id)
id
- id of variable definition@NotNull @NotNull List<VariableDefinition> getGlobalVariables()
@NotNull @NotNull List<Long> findAllProjectsIdsUsingProjectVariables()
@NotNull @NotNull Long countAllProjectsVariables()
@Nullable @Nullable VariableDefinition getGlobalVariableByKey(String key)
key
- of the variable@Nullable @Nullable VariableDefinition getPlanVariableByKey(@NotNull @NotNull PlanIdentifier plan, @NotNull @NotNull String key)
plan
- variable belongs tokey
- of variable@NotNull @NotNull List<VariableDefinition> getPlanVariables(@NotNull @NotNull PlanIdentifier plan)
plan
- Plan whose associated variables should be returnedint countDeploymentEnvironmentVariables(long environmentId)
environmentId
- id of Deployment environment@NotNull @NotNull List<VariableDefinition> getDeploymentEnvironmentVariables(long environmentId)
environmentId
- id of Deployment environment@NotNull @NotNull List<VariableDefinition> getDeploymentVersionVariables(long deploymentVersionId)
deploymentVersionId
- id of Deployment environment@Deprecated @NotNull @NotNull List<VariableDefinition> getGlobalNotOverriddenVariables(@NotNull @NotNull PlanIdentifier plan)
getInheritedNotOverriddenVariables(PlanIdentifier)
insteadplan
- Plan whose associated variables should be used@NotNull @NotNull List<VariableDefinition> getInheritedVariables(@NotNull @NotNull PlanIdentifier plan)
@NotNull @NotNull List<VariableDefinition> getInheritedNotOverriddenVariables(@NotNull @NotNull PlanIdentifier plan)
@NotNull @NotNull List<VariableDefinition> getGlobalNotOverriddenVariables(@NotNull @NotNull long projectId)
projectId
- id of a project@NotNull @NotNull List<VariableDefinition> getGlobalNotOverriddenEnvironmentVariables(long environmentId)
@NotNull @NotNull Map<String,String> getSimpleVariableMapByType(@NotNull @NotNull VariableContext variableContext, @NotNull @NotNull VariableType variableType)
variableContext
- variableType
- @NotNull @NotNull List<VariableDefinition> getProjectVariables(long projectId)
projectId
- id of a ProjectCopyright © 2022 Atlassian Software Systems Pty Ltd. All rights reserved.