VisualCustomAction (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.quicksight.model.VisualCustomAction

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<VisualCustomAction.Builder,VisualCustomAction>

@Generated(value="software.amazon.awssdk:codegen")
public final class VisualCustomAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VisualCustomAction.Builder,VisualCustomAction>

A custom action defined on a visual.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface VisualCustomAction.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`VisualCustomAction.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<VisualCustomActionOperation>`	`actionOperations()` A list of `VisualCustomActionOperations`.
`static VisualCustomAction.Builder`	`builder()`
`String`	`customActionId()` The ID of the `VisualCustomAction`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasActionOperations()` For responses, this returns true if the service returned a value for the ActionOperations property.
`int`	`hashCode()`
`String`	`name()` The name of the `VisualCustomAction`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends VisualCustomAction.Builder>`	`serializableBuilderClass()`
`WidgetStatus`	`status()` The status of the `VisualCustomAction`.
`String`	`statusAsString()` The status of the `VisualCustomAction`.
`VisualCustomAction.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`VisualCustomActionTrigger`	`trigger()` The trigger of the `VisualCustomAction`.
`String`	`triggerAsString()` The trigger of the `VisualCustomAction`.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - customActionId
```
public final String customActionId()
```
    The ID of the VisualCustomAction.
    
    Returns:
    
    The ID of the VisualCustomAction.
  - name
```
public final String name()
```
    The name of the VisualCustomAction.
    
    Returns:
    
    The name of the VisualCustomAction.
  - status
```
public final WidgetStatus status()
```
    The status of the VisualCustomAction.
    
    If the service returns an enum value that is not available in the current SDK version, status will return WidgetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the VisualCustomAction.
    
    See Also:
    
    WidgetStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the VisualCustomAction.
    
    If the service returns an enum value that is not available in the current SDK version, status will return WidgetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the VisualCustomAction.
    
    See Also:
    
    WidgetStatus
  - trigger
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, trigger will return VisualCustomActionTrigger.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerAsString().
    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
  - triggerAsString
```
public final String triggerAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, trigger will return VisualCustomActionTrigger.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerAsString().
    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
  - hasActionOperations
```
public final boolean hasActionOperations()
```
    For responses, this returns true if the service returned a value for the ActionOperations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - actionOperations
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActionOperations() method.
    
    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.
  - toBuilder
```
public VisualCustomAction.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<VisualCustomAction.Builder,VisualCustomAction>
  - builder
```
public static VisualCustomAction.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends VisualCustomAction.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class VisualCustomAction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

customActionId

name

status

statusAsString

trigger

triggerAsString

hasActionOperations

actionOperations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields