VisualCustomAction (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.VisualCustomAction

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

A custom action defined on a visual.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VisualCustomAction()

Constructors
Constructor and Description
`VisualCustomAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VisualCustomAction`	`clone()`
`boolean`	`equals(Object obj)`
`List<VisualCustomActionOperation>`	`getActionOperations()` A list of `VisualCustomActionOperations`.
`String`	`getCustomActionId()` The ID of the `VisualCustomAction`.
`String`	`getName()` The name of the `VisualCustomAction`.
`String`	`getStatus()` The status of the `VisualCustomAction`.
`String`	`getTrigger()` The trigger of the `VisualCustomAction`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActionOperations(Collection<VisualCustomActionOperation> actionOperations)` A list of `VisualCustomActionOperations`.
`void`	`setCustomActionId(String customActionId)` The ID of the `VisualCustomAction`.
`void`	`setName(String name)` The name of the `VisualCustomAction`.
`void`	`setStatus(String status)` The status of the `VisualCustomAction`.
`void`	`setTrigger(String trigger)` The trigger of the `VisualCustomAction`.
`String`	`toString()` Returns a string representation of this object.
`VisualCustomAction`	`withActionOperations(Collection<VisualCustomActionOperation> actionOperations)` A list of `VisualCustomActionOperations`.
`VisualCustomAction`	`withActionOperations(VisualCustomActionOperation... actionOperations)` A list of `VisualCustomActionOperations`.
`VisualCustomAction`	`withCustomActionId(String customActionId)` The ID of the `VisualCustomAction`.
`VisualCustomAction`	`withName(String name)` The name of the `VisualCustomAction`.
`VisualCustomAction`	`withStatus(String status)` The status of the `VisualCustomAction`.
`VisualCustomAction`	`withStatus(WidgetStatus status)` The status of the `VisualCustomAction`.
`VisualCustomAction`	`withTrigger(String trigger)` The trigger of the `VisualCustomAction`.
`VisualCustomAction`	`withTrigger(VisualCustomActionTrigger trigger)` The trigger of the `VisualCustomAction`.

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

- Constructor Detail
  - VisualCustomAction
```
public VisualCustomAction()
```
- Method Detail
  - setCustomActionId
```
public void setCustomActionId(String customActionId)
```
    The ID of the VisualCustomAction.
    
    Parameters:
    
    customActionId - The ID of the VisualCustomAction.
  - getCustomActionId
```
public String getCustomActionId()
```
    The ID of the VisualCustomAction.
    
    Returns:
    
    The ID of the VisualCustomAction.
  - withCustomActionId
```
public VisualCustomAction withCustomActionId(String customActionId)
```
    The ID of the VisualCustomAction.
    
    Parameters:
    
    customActionId - The ID of the VisualCustomAction.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the VisualCustomAction.
    
    Parameters:
    
    name - The name of the VisualCustomAction.
  - getName
```
public String getName()
```
    The name of the VisualCustomAction.
    
    Returns:
    
    The name of the VisualCustomAction.
  - withName
```
public VisualCustomAction withName(String name)
```
    The name of the VisualCustomAction.
    
    Parameters:
    
    name - The name of the VisualCustomAction.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the VisualCustomAction.
    
    Parameters:
    
    status - The status of the VisualCustomAction.
    
    See Also:
    
    WidgetStatus
  - getStatus
```
public String getStatus()
```
    The status of the VisualCustomAction.
    
    Returns:
    
    The status of the VisualCustomAction.
    
    See Also:
    
    WidgetStatus
  - withStatus
```
public VisualCustomAction withStatus(String status)
```
    The status of the VisualCustomAction.
    
    Parameters:
    
    status - The status of the VisualCustomAction.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WidgetStatus
  - withStatus
```
public VisualCustomAction withStatus(WidgetStatus status)
```
    The status of the VisualCustomAction.
    
    Parameters:
    
    status - The status of the VisualCustomAction.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WidgetStatus
  - setTrigger
```
public void setTrigger(String trigger)
```
    The trigger of the VisualCustomAction.
    
    Valid values are defined as follows:
    - DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
    - DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
    Parameters:
    trigger - The trigger of the VisualCustomAction.
    
    Valid values are defined as follows:
    
    DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
    
    DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
    See Also:
    
    VisualCustomActionTrigger
  - getTrigger
```
public String getTrigger()
```
    The trigger of the VisualCustomAction.
    
    Valid values are defined as follows:
    - DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
    - DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
    Returns:
    The trigger of the VisualCustomAction.
    
    Valid values are defined as follows:
    
    DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
    
    DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
    See Also:
    
    VisualCustomActionTrigger
  - withTrigger
```
public VisualCustomAction withTrigger(String trigger)
```
    The trigger of the VisualCustomAction.
    
    Valid values are defined as follows:
    - DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
    - DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
    Parameters:
    trigger - The trigger of the VisualCustomAction.
    
    Valid values are defined as follows:
    
    DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
    
    DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VisualCustomActionTrigger
  - withTrigger
```
public VisualCustomAction withTrigger(VisualCustomActionTrigger trigger)
```
    The trigger of the VisualCustomAction.
    
    Valid values are defined as follows:
    - DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
    - DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
    Parameters:
    trigger - The trigger of the VisualCustomAction.
    
    Valid values are defined as follows:
    
    DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
    
    DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VisualCustomActionTrigger
  - getActionOperations
```
public List<VisualCustomActionOperation> getActionOperations()
```
    A list of VisualCustomActionOperations.
    
    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
    
    Returns:
    
    A list of VisualCustomActionOperations.
    
    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
  - setActionOperations
```
public void setActionOperations(Collection<VisualCustomActionOperation> actionOperations)
```
    A list of VisualCustomActionOperations.
    
    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
    
    Parameters:
    
    actionOperations - A list of VisualCustomActionOperations.
    
    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
  - withActionOperations
```
public VisualCustomAction withActionOperations(VisualCustomActionOperation... actionOperations)
```
    A list of VisualCustomActionOperations.
    
    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
    
    NOTE: This method appends the values to the existing list (if any). Use setActionOperations(java.util.Collection) or withActionOperations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    actionOperations - A list of VisualCustomActionOperations.
    
    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withActionOperations
```
public VisualCustomAction withActionOperations(Collection<VisualCustomActionOperation> actionOperations)
```
    A list of VisualCustomActionOperations.
    
    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
    
    Parameters:
    
    actionOperations - A list of VisualCustomActionOperations.
    
    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
    
    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 VisualCustomAction 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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class VisualCustomAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VisualCustomAction

Method Detail

setCustomActionId

getCustomActionId

withCustomActionId

setName

getName

withName

setStatus

getStatus

withStatus

withStatus

setTrigger

getTrigger

withTrigger

withTrigger

getActionOperations

setActionOperations

withActionOperations

withActionOperations

toString

equals

hashCode

clone

marshall