Package org.kohsuke.github

Class GHTeamBuilder

java.lang.Object

org.kohsuke.github.GHTeamBuilder

public class GHTeamBuilder
extends Object

Creates a team. https://developer.github.com/v3/teams/#create-team

Field Summary

Fields

Modifier and Type	Field	Description
protected org.kohsuke.github.Requester	builder	The builder.

Constructor Summary

Constructors

Constructor	Description
GHTeamBuilder(GitHub root, String orgName, String name)	Instantiates a new GH team builder.

Method Summary

Modifier and Type	Method	Description
GHTeam	create()	Creates a team with all the parameters.
GHTeamBuilder	description(String description)	Description for this team.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
GHTeamBuilder	maintainers(String... maintainers)	Maintainers for this team.
GHTeamBuilder	parentTeamId(long parentTeamId)	Parent team id for this team.
GHTeamBuilder	privacy(GHTeam.Privacy privacy)	Description for this team.
GHTeamBuilder	repositories(String... repoNames)	Repository names to add this team to.

Methods inherited from class java.lang.Object

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

Field Detail

builder

protected final org.kohsuke.github.Requester builder

The builder.

Constructor Detail

GHTeamBuilder

public GHTeamBuilder(GitHub root,
                     String orgName,
                     String name)

Instantiates a new GH team builder.

Parameters:

root - the root

orgName - the org name

name - the name

Method Detail

description

public GHTeamBuilder description(String description)

Description for this team.

Parameters:

description - description of team

Returns:

a builder to continue with building

maintainers

public GHTeamBuilder maintainers(String... maintainers)

Maintainers for this team.

Parameters:

maintainers - maintainers of team

Returns:

a builder to continue with building

repositories

public GHTeamBuilder repositories(String... repoNames)

Repository names to add this team to.

Parameters:

repoNames - repoNames to add team to

Returns:

a builder to continue with building

privacy

public GHTeamBuilder privacy(GHTeam.Privacy privacy)

Description for this team.

Parameters:

privacy - privacy of team

Returns:

a builder to continue with building

parentTeamId

public GHTeamBuilder parentTeamId(long parentTeamId)

Parent team id for this team.

Parameters:

parentTeamId - parentTeamId of team

Returns:

a builder to continue with building

create

public GHTeam create()
              throws IOException

Creates a team with all the parameters.

Returns:

the gh team

Throws:

IOException - if team cannot be created

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance