org.gcube.resourcemanagement.model.reference.entities.facets

Interface ActionFacet

All Superinterfaces:

org.gcube.informationsystem.base.reference.Element, org.gcube.informationsystem.model.reference.entities.Entity, org.gcube.informationsystem.base.reference.entities.EntityElement, org.gcube.informationsystem.model.reference.ERElement, org.gcube.informationsystem.model.reference.entities.Facet, org.gcube.informationsystem.base.reference.IdentifiableElement, Named, org.gcube.informationsystem.base.reference.SchemaMixedElement, Serializable

All Known Implementing Classes:

ActionFacetImpl

@TypeMetadata(name="ActionFacet",
              description="This facet is expected to capture information on which action perform while a resource is added or removed from a context.",
              version="1.0.0")
 @Change(version="1.0.0",
        description="First Version")
public interface ActionFacet
extends org.gcube.informationsystem.model.reference.entities.Facet, Named

Author:

Manuele Simi (ISTI - CNR), Luca Frosini (ISTI - CNR) https://wiki.gcube-system.org/gcube/GCube_Model#Action_Facet

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME
static String	TYPE_PROPERTY
static String	WHEN_PROPERTY

Fields inherited from interface org.gcube.informationsystem.base.reference.IdentifiableElement

HEADER_PROPERTY

Fields inherited from interface org.gcube.informationsystem.base.reference.Element

CLASS_PROPERTY, DATETIME_PATTERN, SUPERCLASSES_PROPERTY

Fields inherited from interface org.gcube.resourcemanagement.model.reference.properties.utilities.Named

NAME_PROPERTY

Method Summary

Modifier and Type	Method and Description
String	getCommand() Gets the command to execute.
String	getOptions() The options/params to use when executing the action.
String	getSource() From where to download the action.
EnumStringProperty	getType() Type of action.
void	setCommand(String command) Sets the command to execute.
void	setOptions(String options) The options for the actions.
void	setSource(String source) A remote source used by the command.
void	setType(EnumStringProperty type)

Methods inherited from interface org.gcube.informationsystem.model.reference.entities.Facet

getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty

Methods inherited from interface org.gcube.informationsystem.base.reference.entities.EntityElement

getHeader

Methods inherited from interface org.gcube.informationsystem.base.reference.IdentifiableElement

setHeader

Methods inherited from interface org.gcube.resourcemanagement.model.reference.properties.utilities.Named

getName, setName

Field Detail

NAME

static final String NAME

See Also:

Constant Field Values

TYPE_PROPERTY

static final String TYPE_PROPERTY

See Also:

Constant Field Values

WHEN_PROPERTY

static final String WHEN_PROPERTY

See Also:

Constant Field Values

Method Detail

getType

@ISProperty(name="type",
            description="Type of action",
            mandatory=true,
            nullable=false)
EnumStringProperty getType()

Type of action.

Returns:

an instance of EnumStringProperty

setType

void setType(EnumStringProperty type)

getSource

@ISProperty(description="From where to download the action.",
            mandatory=false,
            nullable=false)
String getSource()

From where to download the action. A remote source used by the command. Could be the endpoint of a service, the location of a remote ansible playbook, etc.

Returns:

URL or Endpoint

setSource

void setSource(String source)

A remote source used by the command. Could be the endpoint of a service, the location of a remote ansible playbook, etc.

Parameters:

source -

getOptions

@ISProperty(description="The options/params to use when executing the action.",
            mandatory=true,
            nullable=false)
String getOptions()

The options/params to use when executing the action.

Returns:

the command to execute to lauch the action

setOptions

void setOptions(String options)

The options for the actions.

Parameters:

options -

getCommand

@ISProperty(description="The command to execute.")
String getCommand()

Gets the command to execute.

Returns:

the command

setCommand

void setCommand(String command)

Sets the command to execute.

Parameters:

command -