ReusableMachineTemplate (Apache Brooklyn)

java.lang.Object
- brooklyn.location.jclouds.templates.AbstractPortableTemplateBuilder<T>
- - brooklyn.location.jclouds.templates.PortableTemplateBuilder<ReusableMachineTemplate>
  - - brooklyn.location.jclouds.pool.ReusableMachineTemplate

All Implemented Interfaces:

org.jclouds.compute.domain.TemplateBuilder
```
public class ReusableMachineTemplate
extends PortableTemplateBuilder<ReusableMachineTemplate>
```
A facility for having a template we can declare without knowing the provider, then find matching instances, create instances, and generally manipulate them.
NB: to be sure of matching a specific template, you should provide a unique id in the constructor. (this will force 'strict' mode.)

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DESCRIPTION_METADATA_KEY`
`static java.lang.String`	`HASH_METADATA_KEY`
`static java.lang.String`	`NAME_METADATA_KEY`
`static java.lang.String`	`PREFIX`
`static java.lang.String`	`TEMPLATE_OWNER_METADATA_KEY`

Constructor Summary

Constructors
Constructor and Description

ReusableMachineTemplate()

ReusableMachineTemplate(java.lang.String name)

Constructors
Constructor and Description
`ReusableMachineTemplate()`
`ReusableMachineTemplate(java.lang.String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`ReusableMachineTemplate`	`description(java.lang.String description)` see #getDescription()
`java.util.List<org.jclouds.compute.options.TemplateOptions>`	`getAdditionalOptionalOptions()`
`java.util.List<org.jclouds.compute.options.TemplateOptions>`	`getAdditionalOptions()`
`java.lang.String`	`getDescription()` a description for this template; this is set on created machines but _not_ used to filter them (so you can change description freely).
`java.lang.String`	`getName()` human-friendly name for this template.
`java.lang.String`	`getOwner()`
`java.util.Set<java.lang.String>`	`getTags(boolean includeOptional)` computes the tags that this template will set (argument true) or require to match (argument false)
`java.util.Map<java.lang.String,java.lang.String>`	`getUserMetadata(boolean includeOptional)` computes the user metadata that this template will set (argument true) or required to match (argument false)
`boolean`	`isStrict()`
`ReusableMachineTemplate`	`metadata(java.util.Map<java.lang.String,java.lang.String> m)`
`ReusableMachineTemplate`	`metadata(java.lang.String key, java.lang.String value)`
`ReusableMachineTemplate`	`metadataOptional(java.util.Map<java.lang.String,java.lang.String> m)`
`ReusableMachineTemplate`	`metadataOptional(java.lang.String key, java.lang.String value)`
`ReusableMachineTemplate`	`name(java.lang.String name)` see #getName()
`ReusableMachineTemplate`	`strict(boolean strict)` whether this template only matches machines instances created from this template; defaults true if a name is set, otherwise false.
`ReusableMachineTemplate`	`tag(java.lang.String tag)`
`ReusableMachineTemplate`	`tagOptional(java.lang.String tag)`
`ReusableMachineTemplate`	`tags(java.lang.String... tags)`
`ReusableMachineTemplate`	`tagsOptional(java.lang.String... tags)`
`ReusableMachineTemplate`	`templateOwnedByMe()` adds user.name as owner of this template
`ReusableMachineTemplate`	`templateOwner(java.lang.String owner)` adds an owner tag to this template
`ReusableMachineTemplate`	`templateUnowned()` no owner, means anyone can pick this up (default)
`java.lang.String`	`toString()`

Methods inherited from class brooklyn.location.jclouds.templates.PortableTemplateBuilder
addOptionalOptions, addTemplateOptions, attachComputeService, build, from, from, newJcloudsTemplate, newJcloudsTemplateBuilder

Methods inherited from class brooklyn.location.jclouds.templates.AbstractPortableTemplateBuilder
addOptions, any, biggest, blank, equals, fastest, fromHardware, fromImage, fromTemplate, getHardware, getHardwareId, getHypervisorMatchesRegex, getImage, getImageDescriptionMatchesRegex, getImageId, getImageMatchesCondition, getImageNameMatchesRegex, getImageVersionMatchesRegex, getIs64bit, getLocationId, getMinCores, getMinDisk, getMinRam, getOptions, getOsArchitectureMatchesRegex, getOsDescriptionMatchesRegex, getOsFamily, getOsNameMatchesRegex, getOsVersionMatchesRegex, getTemplate, hardwareId, hashCode, hypervisorMatches, imageChooser, imageChooser, imageDescriptionMatches, imageId, imageMatches, imageNameMatches, imageVersionMatches, isBlank, locationId, minCores, minDisk, minRam, options, os64Bit, osArchMatches, osDescriptionMatches, osFamily, osNameMatches, osVersionMatches, smallest

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:: Constant Field Values

NAME_METADATA_KEY

public static final java.lang.String NAME_METADATA_KEY

See Also:: Constant Field Values

DESCRIPTION_METADATA_KEY

public static final java.lang.String DESCRIPTION_METADATA_KEY

See Also:: Constant Field Values

HASH_METADATA_KEY

public static final java.lang.String HASH_METADATA_KEY

See Also:: Constant Field Values

TEMPLATE_OWNER_METADATA_KEY

public static final java.lang.String TEMPLATE_OWNER_METADATA_KEY

See Also:: Constant Field Values

Constructor Detail

ReusableMachineTemplate
```
public ReusableMachineTemplate()
```

ReusableMachineTemplate

public ReusableMachineTemplate(java.lang.String name)

Method Detail

name

public ReusableMachineTemplate name(java.lang.String name)

see #getName()

description

public ReusableMachineTemplate description(java.lang.String description)

see #getDescription()

strict
```
public ReusableMachineTemplate strict(boolean strict)
```
whether this template only matches machines instances created from this template; defaults true if a name is set, otherwise false. if false, it will ignore name, owner, and hashcode

templateUnowned
```
public ReusableMachineTemplate templateUnowned()
```
no owner, means anyone can pick this up (default)

templateOwnedByMe
```
public ReusableMachineTemplate templateOwnedByMe()
```
adds user.name as owner of this template

templateOwner

public ReusableMachineTemplate templateOwner(java.lang.String owner)

adds an owner tag to this template

getName
```
public java.lang.String getName()
```
human-friendly name for this template. should normally be unique, it is the primary differentiator for strict matching.

getDescription
```
public java.lang.String getDescription()
```
a description for this template; this is set on created machines but _not_ used to filter them (so you can change description freely).

getOwner
```
public java.lang.String getOwner()
```

isStrict
```
public boolean isStrict()
```

getAdditionalOptions
```
public java.util.List<org.jclouds.compute.options.TemplateOptions> getAdditionalOptions()
```
Overrides:

getAdditionalOptions in class AbstractPortableTemplateBuilder<ReusableMachineTemplate>

getAdditionalOptionalOptions
```
public java.util.List<org.jclouds.compute.options.TemplateOptions> getAdditionalOptionalOptions()
```
Overrides:

getAdditionalOptionalOptions in class PortableTemplateBuilder<ReusableMachineTemplate>

getUserMetadata
```
public java.util.Map<java.lang.String,java.lang.String> getUserMetadata(boolean includeOptional)
```
computes the user metadata that this template will set (argument true) or required to match (argument false)

getTags
```
public java.util.Set<java.lang.String> getTags(boolean includeOptional)
```
computes the tags that this template will set (argument true) or require to match (argument false)

tag

public ReusableMachineTemplate tag(java.lang.String tag)

metadata

public ReusableMachineTemplate metadata(java.lang.String key,
                               java.lang.String value)

metadata

public ReusableMachineTemplate metadata(java.util.Map<java.lang.String,java.lang.String> m)

tagOptional

public ReusableMachineTemplate tagOptional(java.lang.String tag)

tagsOptional

public ReusableMachineTemplate tagsOptional(java.lang.String... tags)

metadataOptional

public ReusableMachineTemplate metadataOptional(java.lang.String key,
                                       java.lang.String value)

metadataOptional

public ReusableMachineTemplate metadataOptional(java.util.Map<java.lang.String,java.lang.String> m)

toString
```
public java.lang.String toString()
```
Overrides:

toString in class AbstractPortableTemplateBuilder<ReusableMachineTemplate>

Class ReusableMachineTemplate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class brooklyn.location.jclouds.templates.PortableTemplateBuilder

Methods inherited from class brooklyn.location.jclouds.templates.AbstractPortableTemplateBuilder

Methods inherited from class java.lang.Object

Field Detail

PREFIX

NAME_METADATA_KEY

DESCRIPTION_METADATA_KEY

HASH_METADATA_KEY

TEMPLATE_OWNER_METADATA_KEY

Constructor Detail

ReusableMachineTemplate

ReusableMachineTemplate

Method Detail

name

description

strict

templateUnowned

templateOwnedByMe

templateOwner

getName

getDescription

getOwner

isStrict

getAdditionalOptions

getAdditionalOptionalOptions

getUserMetadata

getTags

tag

tags

metadata

metadata

tagOptional

tagsOptional

metadataOptional

metadataOptional

toString