com.amazonaws.services.forecast.model

Class Action

java.lang.Object

com.amazonaws.services.forecast.model.Action

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Action
extends Object
implements Serializable, Cloneable, StructuredPojo

Defines the modifications that you are making to an attribute for a what-if forecast. For example, you can use this operation to create a what-if forecast that investigates a 10% off sale on all shoes. To do this, you specify "AttributeName": "shoes", "Operation": "MULTIPLY", and "Value": "0.90". Pair this operation with the TimeSeriesCondition operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define a subset of attribute items that are modified.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Action()

Method Summary

Modifier and Type	Method and Description
Action	clone()
boolean	equals(Object obj)
String	getAttributeName() The related time series that you are modifying.
String	getOperation() The operation that is applied to the provided attribute.
Double	getValue() The value that is applied for the chosen Operation.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAttributeName(String attributeName) The related time series that you are modifying.
void	setOperation(String operation) The operation that is applied to the provided attribute.
void	setValue(Double value) The value that is applied for the chosen Operation.
String	toString() Returns a string representation of this object.
Action	withAttributeName(String attributeName) The related time series that you are modifying.
Action	withOperation(Operation operation) The operation that is applied to the provided attribute.
Action	withOperation(String operation) The operation that is applied to the provided attribute.
Action	withValue(Double value) The value that is applied for the chosen Operation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Action

public Action()

Method Detail

setAttributeName

public void setAttributeName(String attributeName)

The related time series that you are modifying. This value is case insensitive.

Parameters:

attributeName - The related time series that you are modifying. This value is case insensitive.

getAttributeName

public String getAttributeName()

The related time series that you are modifying. This value is case insensitive.

Returns:

The related time series that you are modifying. This value is case insensitive.

withAttributeName

public Action withAttributeName(String attributeName)

The related time series that you are modifying. This value is case insensitive.

Parameters:

attributeName - The related time series that you are modifying. This value is case insensitive.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOperation

public void setOperation(String operation)

The operation that is applied to the provided attribute. Operations include:

• ADD - adds Value to all rows of AttributeName.

• SUBTRACT - subtracts Value from all rows of AttributeName.

• MULTIPLY - multiplies all rows of AttributeName by Value.

• DIVIDE - divides all rows of AttributeName by Value.

Parameters:

operation - The operation that is applied to the provided attribute. Operations include:

• ADD - adds Value to all rows of AttributeName.

• SUBTRACT - subtracts Value from all rows of AttributeName.

• MULTIPLY - multiplies all rows of AttributeName by Value.

• DIVIDE - divides all rows of AttributeName by Value.

See Also:

Operation

getOperation

public String getOperation()

The operation that is applied to the provided attribute. Operations include:

• ADD - adds Value to all rows of AttributeName.

• SUBTRACT - subtracts Value from all rows of AttributeName.

• MULTIPLY - multiplies all rows of AttributeName by Value.

• DIVIDE - divides all rows of AttributeName by Value.

Returns:

The operation that is applied to the provided attribute. Operations include:

• ADD - adds Value to all rows of AttributeName.

• SUBTRACT - subtracts Value from all rows of AttributeName.

• MULTIPLY - multiplies all rows of AttributeName by Value.

• DIVIDE - divides all rows of AttributeName by Value.

See Also:

Operation

withOperation

public Action withOperation(String operation)

The operation that is applied to the provided attribute. Operations include:

• ADD - adds Value to all rows of AttributeName.

• SUBTRACT - subtracts Value from all rows of AttributeName.

• MULTIPLY - multiplies all rows of AttributeName by Value.

• DIVIDE - divides all rows of AttributeName by Value.

Parameters:

operation - The operation that is applied to the provided attribute. Operations include:

• ADD - adds Value to all rows of AttributeName.

• SUBTRACT - subtracts Value from all rows of AttributeName.

• MULTIPLY - multiplies all rows of AttributeName by Value.

• DIVIDE - divides all rows of AttributeName by Value.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Operation

withOperation

public Action withOperation(Operation operation)

The operation that is applied to the provided attribute. Operations include:

• ADD - adds Value to all rows of AttributeName.

• SUBTRACT - subtracts Value from all rows of AttributeName.

• MULTIPLY - multiplies all rows of AttributeName by Value.

• DIVIDE - divides all rows of AttributeName by Value.

Parameters:

operation - The operation that is applied to the provided attribute. Operations include:

• ADD - adds Value to all rows of AttributeName.

• SUBTRACT - subtracts Value from all rows of AttributeName.

• MULTIPLY - multiplies all rows of AttributeName by Value.

• DIVIDE - divides all rows of AttributeName by Value.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Operation

setValue

public void setValue(Double value)

The value that is applied for the chosen Operation.

Parameters:

value - The value that is applied for the chosen Operation.

getValue

public Double getValue()

The value that is applied for the chosen Operation.

Returns:

The value that is applied for the chosen Operation.

withValue

public Action withValue(Double value)

The value that is applied for the chosen Operation.

Parameters:

value - The value that is applied for the chosen Operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Action clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.