Package org.kohsuke.github

Class GHDeploymentStatusBuilder

java.lang.Object

org.kohsuke.github.GHDeploymentStatusBuilder

public class GHDeploymentStatusBuilder
extends Object

Creates a new deployment status.

See Also:

GHDeployment#createStatus(GHDeploymentState)

Constructor Summary

Constructors

Constructor	Description
GHDeploymentStatusBuilder(GHRepository repo, int deploymentId, GHDeploymentState state)	Deprecated. Use GHDeployment.createStatus(GHDeploymentState)

Method Summary

Modifier and Type	Method	Description
GHDeploymentStatusBuilder	autoInactive(boolean autoInactive)	Deprecated. until preview feature has graduated to stable
GHDeploymentStatus	create()	Create gh deployment status.
GHDeploymentStatusBuilder	description(String description)	Description gh deployment status builder.
GHDeploymentStatusBuilder	environment(String environment)	Deprecated. until preview feature has graduated to stable
GHDeploymentStatusBuilder	environmentUrl(String environmentUrl)	Deprecated. until preview feature has graduated to stable
GHDeploymentStatusBuilder	logUrl(String logUrl)	Deprecated. until preview feature has graduated to stable
GHDeploymentStatusBuilder	targetUrl(String targetUrl)	Deprecated. Target url is deprecated in favor of logUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GHDeploymentStatusBuilder

@Deprecated
public GHDeploymentStatusBuilder(GHRepository repo,
                                 int deploymentId,
                                 GHDeploymentState state)

Deprecated.

Use GHDeployment.createStatus(GHDeploymentState)

Instantiates a new Gh deployment status builder.

Parameters:

repo - the repo

deploymentId - the deployment id

state - the state

Method Detail

autoInactive

@Preview({ANT_MAN,FLASH})
public GHDeploymentStatusBuilder autoInactive(boolean autoInactive)

Deprecated.

until preview feature has graduated to stable

Add an inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment.

Parameters:

autoInactive - Add inactive status flag

Returns:

the gh deployment status builder

description

public GHDeploymentStatusBuilder description(String description)

Description gh deployment status builder.

Parameters:

description - the description

Returns:

the gh deployment status builder

environment

@Preview(FLASH)
public GHDeploymentStatusBuilder environment(String environment)

Deprecated.

until preview feature has graduated to stable

Name for the target deployment environment, which can be changed when setting a deploy status.

Parameters:

environment - the environment name

Returns:

the gh deployment status builder

environmentUrl

@Preview(ANT_MAN)
public GHDeploymentStatusBuilder environmentUrl(String environmentUrl)

Deprecated.

until preview feature has graduated to stable

The URL for accessing the environment.

Parameters:

environmentUrl - the environment url

Returns:

the gh deployment status builder

logUrl

@Preview(ANT_MAN)
public GHDeploymentStatusBuilder logUrl(String logUrl)

Deprecated.

until preview feature has graduated to stable

The full URL of the deployment's output.

This method replaces targetUrl.

Parameters:

logUrl - the deployment output url

Returns:

the gh deployment status builder

targetUrl

@Deprecated
public GHDeploymentStatusBuilder targetUrl(String targetUrl)

Deprecated.

Target url is deprecated in favor of logUrl

Target url gh deployment status builder.

Parameters:

targetUrl - the target url

Returns:

the gh deployment status builder

create

public GHDeploymentStatus create()
                          throws IOException

Create gh deployment status.

Returns:

the gh deployment status

Throws:

IOException - the io exception