org.kohsuke.github

Class GHDeploymentBuilder

java.lang.Object

org.kohsuke.github.GHDeploymentBuilder

public class GHDeploymentBuilder
extends Object

The type GHDeploymentBuilder.

Constructor Summary

Constructors

Constructor and Description
GHDeploymentBuilder(GHRepository repo) Instantiates a new Gh deployment builder.
GHDeploymentBuilder(GHRepository repo, String ref) Instantiates a new Gh deployment builder.

Method Summary

Modifier and Type	Method and Description
GHDeploymentBuilder	autoMerge(boolean autoMerge) Auto merge gh deployment builder.
GHDeployment	create() Create gh deployment.
GHDeploymentBuilder	description(String description) Description gh deployment builder.
GHDeploymentBuilder	environment(String environment) Environment gh deployment builder.
GHDeploymentBuilder	payload(String payload) Payload gh deployment builder.
GHDeploymentBuilder	ref(String branch) Ref gh deployment builder.
GHDeploymentBuilder	requiredContexts(List<String> requiredContexts) Required contexts gh deployment builder.
GHDeploymentBuilder	task(String task) Task gh deployment builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

GHDeploymentBuilder

public GHDeploymentBuilder(GHRepository repo)

Instantiates a new Gh deployment builder.

Parameters:

repo - the repo

GHDeploymentBuilder

public GHDeploymentBuilder(GHRepository repo,
                           String ref)

Instantiates a new Gh deployment builder.

Parameters:

repo - the repo

ref - the ref

Method Detail

ref

public GHDeploymentBuilder ref(String branch)

Ref gh deployment builder.

Parameters:

branch - the branch

Returns:

the gh deployment builder

task

public GHDeploymentBuilder task(String task)

Task gh deployment builder.

Parameters:

task - the task

Returns:

the gh deployment builder

autoMerge

public GHDeploymentBuilder autoMerge(boolean autoMerge)

Auto merge gh deployment builder.

Parameters:

autoMerge - the auto merge

Returns:

the gh deployment builder

requiredContexts

public GHDeploymentBuilder requiredContexts(List<String> requiredContexts)

Required contexts gh deployment builder.

Parameters:

requiredContexts - the required contexts

Returns:

the gh deployment builder

payload

public GHDeploymentBuilder payload(String payload)

Payload gh deployment builder.

Parameters:

payload - the payload

Returns:

the gh deployment builder

environment

public GHDeploymentBuilder environment(String environment)

Environment gh deployment builder.

Parameters:

environment - the environment

Returns:

the gh deployment builder

description

public GHDeploymentBuilder description(String description)

Description gh deployment builder.

Parameters:

description - the description

Returns:

the gh deployment builder

create

public GHDeployment create()
                    throws IOException

Create gh deployment.

Returns:

the gh deployment

Throws:

IOException - the io exception