Package io.jenkins.blueocean.rest.model

Class BlueOrganization

java.lang.Object

io.jenkins.blueocean.rest.model.Resource

io.jenkins.blueocean.rest.model.BlueOrganization

All Implemented Interfaces:

Reachable, Routable

Direct Known Subclasses:

AbstractOrganization

public abstract class BlueOrganization
extends Resource
implements Routable

API endpoint for an organization that houses all the pipelines.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
static String	DISPLAY_NAME
static String	NAME
static String	PIPELINES

Constructor Summary

Constructors

Constructor	Description
BlueOrganization()

Method Summary

Modifier and Type	Method	Description
abstract String	getDisplayName()
abstract String	getName()
abstract BluePipelineContainer	getPipelines()
String	getUrlName()	Follows the same convention as Action.getUrlName()
abstract BlueUser	getUser()	Gives currently authenticated user
abstract BlueUserContainer	getUsers()	A set of users who belong to this organization.

Methods inherited from class io.jenkins.blueocean.rest.model.Resource

getLinks, getState

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jenkins.blueocean.rest.Reachable

getLink

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

DISPLAY_NAME

public static final String DISPLAY_NAME

See Also:

Constant Field Values

PIPELINES

public static final String PIPELINES

See Also:

Constant Field Values

Constructor Detail

BlueOrganization

public BlueOrganization()

Method Detail

getUrlName

public String getUrlName()

Description copied from interface: Routable

Follows the same convention as Action.getUrlName()

Specified by:

getUrlName in interface Routable

getName

@Exported(name="name")
public abstract String getName()

getDisplayName

@Exported(name="displayName")
public abstract String getDisplayName()

getPipelines

@Navigable
public abstract BluePipelineContainer getPipelines()

getUsers

@Navigable
public abstract BlueUserContainer getUsers()

A set of users who belong to this organization.

Returns:

BlueUserContainer

getUser

@Navigable
public abstract BlueUser getUser()

Gives currently authenticated user

Returns:

BlueUser