Package org.kohsuke.github

Class GHRepositoryVariable

java.lang.Object

org.kohsuke.github.GHRepositoryVariable

public class GHRepositoryVariable
extends Object

The type Gh repository variable.

Author:

garridobarrera

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHRepositoryVariable.Creator	A GHRepositoryVariableBuilder that creates a new GHRepositoryVariable
static class	GHRepositoryVariable.Setter	A GHRepositoryVariableBuilder that updates a single property per request

Constructor Summary

Constructors

Constructor	Description
GHRepositoryVariable()

Method Summary

Modifier and Type	Method	Description
void	delete()	Delete this variable from the repository.
String	getName()	Gets name.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
String	getUrl()	Gets url.
String	getValue()	Gets value.
GHRepositoryVariable.Setter	set()	Begins a single property update.
void	setName(String name)	Sets name.
void	setValue(String value)	Sets value.

Methods inherited from class java.lang.Object

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

Constructor Details

GHRepositoryVariable

public GHRepositoryVariable()

Method Details

getUrl

@Nonnull
public String getUrl()

Gets url.

Returns:

the url

getName

public String getName()

Gets name.

Returns:

the name

setName

public void setName(String name)

Sets name.

Parameters:

name - the name

getValue

public String getValue()

Gets value.

Returns:

the value

setValue

public void setValue(String value)

Sets value.

Parameters:

value - the value

delete

public void delete()
            throws IOException

Delete this variable from the repository.

Throws:

IOException - the io exception

set

@BetaApi
public GHRepositoryVariable.Setter set()

Begins a single property update.

Returns:

a GHRepositoryVariable.Setter

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