io.github.cdklabs.projen.github

Class DependabotRegistry.Builder

java.lang.Object

io.github.cdklabs.projen.github.DependabotRegistry.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DependabotRegistry>

Enclosing interface:

DependabotRegistry

@Stability(value=Experimental)
public static final class DependabotRegistry.Builder
extends Object
implements software.amazon.jsii.Builder<DependabotRegistry>

A builder for DependabotRegistry

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DependabotRegistry	build() Builds the configured instance.
DependabotRegistry.Builder	key(String key) Sets the value of DependabotRegistry.getKey()
DependabotRegistry.Builder	organization(String organization) Sets the value of DependabotRegistry.getOrganization()
DependabotRegistry.Builder	password(String password) Sets the value of DependabotRegistry.getPassword()
DependabotRegistry.Builder	replacesBase(Boolean replacesBase) Sets the value of DependabotRegistry.getReplacesBase()
DependabotRegistry.Builder	token(String token) Sets the value of DependabotRegistry.getToken()
DependabotRegistry.Builder	type(DependabotRegistryType type) Sets the value of DependabotRegistry.getType()
DependabotRegistry.Builder	url(String url) Sets the value of DependabotRegistry.getUrl()
DependabotRegistry.Builder	username(String username) Sets the value of DependabotRegistry.getUsername()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

type

@Stability(value=Experimental)
public DependabotRegistry.Builder type(DependabotRegistryType type)

Sets the value of DependabotRegistry.getType()

Parameters:

type - Registry type e.g. 'npm-registry' or 'docker-registry'. This parameter is required.

Returns:

this

url

@Stability(value=Experimental)
public DependabotRegistry.Builder url(String url)

Sets the value of DependabotRegistry.getUrl()

Parameters:

url - Url for the registry e.g. 'https://npm.pkg.github.com' or 'registry.hub.docker.com'. This parameter is required.

Returns:

this

key

@Stability(value=Experimental)
public DependabotRegistry.Builder key(String key)

Sets the value of DependabotRegistry.getKey()

Parameters:

key - A reference to a Dependabot secret containing an access key for this registry.

Returns:

this

organization

@Stability(value=Experimental)
public DependabotRegistry.Builder organization(String organization)

Sets the value of DependabotRegistry.getOrganization()

Parameters:

organization - Used with the hex-organization registry type.

Returns:

this

password

@Stability(value=Experimental)
public DependabotRegistry.Builder password(String password)

Sets the value of DependabotRegistry.getPassword()

Parameters:

password - A reference to a Dependabot secret containing the password for the specified user.

Returns:

this

replacesBase

@Stability(value=Experimental)
public DependabotRegistry.Builder replacesBase(Boolean replacesBase)

Sets the value of DependabotRegistry.getReplacesBase()

Parameters:

replacesBase - For registries with type: python-index, if the boolean value is true, pip esolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default https://pypi.org/simple).

Returns:

this

token

@Stability(value=Experimental)
public DependabotRegistry.Builder token(String token)

Sets the value of DependabotRegistry.getToken()

Parameters:

token - Secret token for dependabot access e.g. '${{ secrets.DEPENDABOT_PACKAGE_TOKEN }}'.

Returns:

this

username

@Stability(value=Experimental)
public DependabotRegistry.Builder username(String username)

Sets the value of DependabotRegistry.getUsername()

Parameters:

username - The username that Dependabot uses to access the registry.

Returns:

this

build

@Stability(value=Experimental)
public DependabotRegistry build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<DependabotRegistry>

Returns:

a new instance of DependabotRegistry

Throws:

NullPointerException - if any required attribute was not provided