Package org.openstack4j.model.compute.builder

Interface ServerCreateBuilder

All Superinterfaces:

Buildable.Builder<ServerCreateBuilder,ServerCreate>

All Known Implementing Classes:

NovaServerCreate.ServerCreateConcreteBuilder

public interface ServerCreateBuilder
extends Buildable.Builder<ServerCreateBuilder,ServerCreate>

Builds a Server used for a Create Action

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method	Description
ServerCreateBuilder	addAdminPass(String adminPass)	Add admin password for launching the server.
ServerCreateBuilder	addMetadata(Map<String,String> metadata)	Replaces and add the specified metadata
ServerCreateBuilder	addMetadataItem(String key, String value)	Adds a new metadata item to the Server
ServerCreateBuilder	addNetworkPort(String portId)	Adds a network port
ServerCreateBuilder	addPersonality(String path, String contents)	Adds a Personality to the Server.
ServerCreateBuilder	addSchedulerHint(String key, String value)	Adds a scheduler hint used for boot up
ServerCreateBuilder	addSchedulerHint(String key, List<String> value)	Adds a scheduler hint (array based) used for boot up
ServerCreateBuilder	addSchedulerHints(Map<String,Object> schedulerHints)	Adds/Replaces scheduler hints used for bootup
ServerCreateBuilder	addSecurityGroup(String name)	Adds the security group.
ServerCreateBuilder	availabilityZone(String availabilityZone)	The availability zone in which to launch the server.
ServerCreateBuilder	blockDevice(BlockDeviceMappingCreate blockDevice)
ServerCreateBuilder	configDrive(boolean configDrive)	Sets the config drive parameter.
ServerCreateBuilder	flavor(String flavorId)
ServerCreateBuilder	flavor(Flavor flavor)
ServerCreateBuilder	host(String host)	The name of the compute service host on which the server is to be created.
ServerCreateBuilder	hypervisorHostName(String hypervisorHostName)	The hostname of the hypervisor on which the server is to be created.
ServerCreateBuilder	image(String imageId)
ServerCreateBuilder	image(Image image)
ServerCreateBuilder	keypairName(String name)	Associates this Server with a public keypair name
ServerCreateBuilder	name(String name)
ServerCreateBuilder	networks(List<String> networks)	Adds list of networks (by id) to server
ServerCreateBuilder	userData(String userData)	Cloud-init userdata

Methods inherited from interface org.openstack4j.common.Buildable.Builder

build, from

Method Detail

name

ServerCreateBuilder name(String name)

See Also:

Server.getName()

flavor

ServerCreateBuilder flavor(String flavorId)

See Also:

Server.getFlavor()

flavor

ServerCreateBuilder flavor(Flavor flavor)

See Also:

Server.getFlavor()

image

ServerCreateBuilder image(String imageId)

See Also:

Server.getImage()

image

ServerCreateBuilder image(Image image)

See Also:

Server.getImage()

networks

ServerCreateBuilder networks(List<String> networks)

Adds list of networks (by id) to server

Parameters:

networks - list of network ids

Returns:

this builder

addNetworkPort

ServerCreateBuilder addNetworkPort(String portId)

Adds a network port

Parameters:

portId - id of port

Returns:

this builder

addPersonality

ServerCreateBuilder addPersonality(String path,
                                   String contents)

Adds a Personality to the Server. A personality is a path to a file and the contents to be replaced on the new VM.

Parameters:

path - the path (max is 255 bytes)

contents - the contents of the file path

Returns:

this builder

addSecurityGroup

ServerCreateBuilder addSecurityGroup(String name)

Adds the security group.

Parameters:

name - the name

Returns:

this builder

addMetadataItem

ServerCreateBuilder addMetadataItem(String key,
                                    String value)

Adds a new metadata item to the Server

Parameters:

key - the metadata key

value - the metadata value

Returns:

ServerCreateBuilder

addMetadata

ServerCreateBuilder addMetadata(Map<String,String> metadata)

Replaces and add the specified metadata

Parameters:

metadata - the metadata for this server

Returns:

this builder

addSchedulerHint

ServerCreateBuilder addSchedulerHint(String key,
                                     String value)

Adds a scheduler hint used for boot up

Parameters:

key - the scheduler hint key

value - the scheduler hint value

Returns:

this builder

addSchedulerHint

ServerCreateBuilder addSchedulerHint(String key,
                                     List<String> value)

Adds a scheduler hint (array based) used for boot up

Parameters:

key - the scheduler hint key

value - the scheduler hint value

Returns:

this builder

addSchedulerHints

ServerCreateBuilder addSchedulerHints(Map<String,Object> schedulerHints)

Adds/Replaces scheduler hints used for bootup

Parameters:

schedulerHints - map of key and value scheduler hints

Returns:

this builder

keypairName

ServerCreateBuilder keypairName(String name)

Associates this Server with a public keypair name

Parameters:

name - the name of the public keypair

Returns:

this builder

blockDevice

ServerCreateBuilder blockDevice(BlockDeviceMappingCreate blockDevice)

availabilityZone

ServerCreateBuilder availabilityZone(String availabilityZone)

The availability zone in which to launch the server.

Parameters:

availabilityZone - the availability zone

Returns:

this builder

host

ServerCreateBuilder host(String host)

The name of the compute service host on which the server is to be created.

Parameters:

host - The name of the compute service host

Returns:

this builder

hypervisorHostName

ServerCreateBuilder hypervisorHostName(String hypervisorHostName)

The hostname of the hypervisor on which the server is to be created.

Parameters:

hypervisorHostName - The hostname of the hypervisor

Returns:

this builder

userData

ServerCreateBuilder userData(String userData)

Cloud-init userdata

Parameters:

userData - a base64 encoded string containing the userdata

Returns:

this userdata

addAdminPass

ServerCreateBuilder addAdminPass(String adminPass)

Add admin password for launching the server.

Parameters:

adminPass - the password

Returns:

this builder

configDrive

ServerCreateBuilder configDrive(boolean configDrive)

Sets the config drive parameter.

Parameters:

configDrive - the configDrive value

Returns:

this builder