Package com.pulumi.automation

Class ProjectSettings

java.lang.Object

com.pulumi.automation.ProjectSettings

public class ProjectSettings
extends java.lang.Object

A Pulumi project manifest. It describes metadata applying to all sub-stacks created from the project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjectSettings.Builder	Builder for ProjectSettings.

Method Summary

Modifier and Type	Method	Description
java.lang.String	author()	The author of the project.
ProjectBackend	backend()	The backend of the project.
static ProjectSettings.Builder	builder(java.lang.String name, ProjectRuntime runtime)	Returns a new builder for ProjectSettings.
static ProjectSettings.Builder	builder(java.lang.String name, ProjectRuntimeName runtime)	Returns a new builder for ProjectSettings.
java.util.Map<java.lang.String,ProjectConfigType>	config()	The config of the project.
java.lang.String	description()	The description of the project.
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	license()	The license of the project.
java.lang.String	main()	An optional override for the program's main entry-point location.
java.lang.String	name()	The name of the project.
ProjectOptions	options()	An optional set of project options.
ProjectPlugins	plugins()	An optional set of plugins of the project.
ProjectRuntime	runtime()	The runtime of the project.
java.lang.String	stackConfigDir()	Indicates where to store the Pulumi.<stack-name>.yaml files, combined with the folder Pulumi.yaml is in.
ProjectTemplate	template()	The template of the project.
ProjectSettings.Builder	toBuilder()	Creates a new ProjectSettings.Builder initialized with the values from this instance.
java.lang.String	website()	The website of the project.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ProjectSettings.Builder builder(java.lang.String name,
                                              ProjectRuntimeName runtime)

Returns a new builder for ProjectSettings.

Parameters:

name - the name of the project

runtime - the runtime name of the project

Returns:

the builder

builder

public static ProjectSettings.Builder builder(java.lang.String name,
                                              ProjectRuntime runtime)

Returns a new builder for ProjectSettings.

Parameters:

name - the name of the project

runtime - the runtime of the project

Returns:

the builder

name

public java.lang.String name()

The name of the project.

Returns:

the name of the project

runtime

public ProjectRuntime runtime()

The runtime of the project.

Returns:

the runtime of the project

main

@Nullable
public java.lang.String main()

An optional override for the program's main entry-point location.

Returns:

the main entry point of the program

description

@Nullable
public java.lang.String description()

The description of the project.

Returns:

the description of the project

author

@Nullable
public java.lang.String author()

The author of the project.

Returns:

the author of the project

website

@Nullable
public java.lang.String website()

The website of the project.

Returns:

the website of the project

license

@Nullable
public java.lang.String license()

The license of the project.

Returns:

the license of the project

config

public java.util.Map<java.lang.String,ProjectConfigType> config()

The config of the project.

Returns:

the config of the project

stackConfigDir

@Nullable
public java.lang.String stackConfigDir()

Indicates where to store the Pulumi.<stack-name>.yaml files, combined with the folder Pulumi.yaml is in.

Returns:

where to store the Pulumi.<stack-name>.yaml files

template

@Nullable
public ProjectTemplate template()

The template of the project.

Returns:

the template of the project

backend

@Nullable
public ProjectBackend backend()

The backend of the project.

Returns:

the backend of the project

options

@Nullable
public ProjectOptions options()

An optional set of project options.

Returns:

the options of the project

plugins

@Nullable
public ProjectPlugins plugins()

An optional set of plugins of the project.

Returns:

the plugins of the project

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toBuilder

public ProjectSettings.Builder toBuilder()

Creates a new ProjectSettings.Builder initialized with the values from this instance.

Returns:

a new ProjectSettings.Builder with values copied from this instance