com.atlassian.bitbucket.jenkins.internal.deployments

Interface DeploymentStep

All Known Implementing Classes:

DeploymentNotifier, DeploymentStepImpl

public interface DeploymentStep

Since:

3.1.0

Method Summary

Modifier and Type	Method and Description
BitbucketDeploymentEnvironment	getEnvironment(Run<?,?> run, TaskListener listener) Generates a BitbucketDeploymentEnvironment from the various components.
String	getEnvironmentKey() Used to populate the environmentKey field in the UI.
String	getEnvironmentName() Used to populate the environmentName field in the UI.
String	getEnvironmentType() Used to populate the environmentType field in the UI.
String	getEnvironmentUrl() Used to populate the environmentUrl field in the UI.

Method Detail

getEnvironment

BitbucketDeploymentEnvironment getEnvironment(Run<?,?> run,
                                              TaskListener listener)

Generates a BitbucketDeploymentEnvironment from the various components.

Parameters:

run - the run that is performing the deployments

listener - the TaskListener

Returns:

the configured BitbucketDeploymentEnvironment

getEnvironmentKey

String getEnvironmentKey()

Used to populate the environmentKey field in the UI.

Returns:

the configured or generated environment key

getEnvironmentName

@CheckForNull
String getEnvironmentName()

Used to populate the environmentName field in the UI.

Returns:

the configured environment name or null if not configured

getEnvironmentType

@CheckForNull
String getEnvironmentType()

Used to populate the environmentType field in the UI.

Returns:

the configured Enum.name() or null if not configured

getEnvironmentUrl

@CheckForNull
String getEnvironmentUrl()

Used to populate the environmentUrl field in the UI.

Returns:

the configured environment url or null if not configured